{"id":102625,"date":"2021-05-28T11:00:00","date_gmt":"2021-05-28T08:00:00","guid":{"rendered":"https:\/\/examples.javacodegeeks.com\/?p=102625"},"modified":"2021-05-25T16:52:50","modified_gmt":"2021-05-25T13:52:50","slug":"spring-boot-starter-tutorial","status":"publish","type":"post","link":"https:\/\/examples.javacodegeeks.com\/spring-boot-starter-tutorial\/","title":{"rendered":"Spring Boot Starter Tutorial"},"content":{"rendered":"

This is a tutorial about Spring Boot Starter.<\/p>\n

1. Introduction<\/h2>\n

Spring Boot is a Spring Framework module that provides Rapid Application Development or RAD for spring projects. In this article, we look at one of Spring Boot’s features called Spring Boot Starters<\/code>.<\/p>\n

2. What is a Spring Boot Starter?<\/h2>\n

Without Spring Boot starters<\/code>, we need to add all the necessary dependencies and versions in the pom. With Spring Boot Starter<\/code>, we need to add just the starter name in the pom. Then all the related dependencies get added automatically to the project. Hence, Spring Boot starters<\/code> are called dependency descriptors.<\/p>\n

Spring Boot provides many starters under the group org.springframework.boot. Their names all start with spring-boot-starter*<\/code>. The way we add a starter to our application is by using the pom.xml<\/code> <\/p>\n

The most commonly used starters are application starters<\/code>. They help to develop a specific type of application. For example, we can quickly build Spring applications with web services if we use the spring-boot-starter-web starter<\/code>. The way we add an application starter to our pom.xml<\/code> is as follows:<\/p>\n

 \n  <dependency>\n     <groupid > org.springframework.boot<\/groupid>\n     <artifactid>spring-boot-starter-web<\/artifactid>\n  <\/dependency>\n<\/pre>\n
There are 3 main types of Spring Boot starters. we take a look at each below.<\/p>\n
3. Spring Boot Application Starters<\/h2>\n
When we include any starter in our pom.xml, Spring will download all the dependencies required for that functionality without having to explicitly add them to our pom.xml. For example, in the above example, Spring would download all the web application dependencies. There are a large number of application starters<\/code> that Spring supports. Given below is their list:<\/p>\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Starter Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
spring-boot-starter-thymeleaf<\/code><\/td>\nMVC web applications with Thymeleaf for views.<\/td>\n<\/tr>\n
spring-boot-starter-data-couchbase<\/code><\/td>\nCouchbase document-oriented database and Spring Data Couchbase.<\/td>\n<\/tr>\n
spring-boot-starter-artemis<\/code><\/td>\nTo use Apache Artemis as the JMS messaging protocol.<\/td>\n<\/tr>\n
spring-boot-starter-web-services<\/code><\/td>\nSpring Web Services application.<\/td>\n<\/tr>\n
spring-boot-starter-mail<\/code><\/td>\nEmail sending applications. It also supports Javax mail API.<\/td>\n<\/tr>\n
spring-boot-starter-data-redis<\/code><\/td>\nRedis key-value data store, Spring Data Redis, and the Jedis client.<\/td>\n<\/tr>\n
spring-boot-starter-web<\/code><\/td>\nBuild web and RESTful Spring applications.<\/td>\n<\/tr>\n
spring-boot-starter-data-gemfire<\/code><\/td>\nGemFire distributed data store with the Spring Data GemFire.<\/td>\n<\/tr>\n
spring-boot-starter-activemq<\/code><\/td>\nApache ActiveMQ JMS messaging system.<\/td>\n<\/tr>\n
spring-boot-starter-data-elasticsearch<\/code><\/td>\nTo enable Elasticsearch search and analytics engine with Spring Data Elasticsearch.<\/td>\n<\/tr>\n
spring-boot-starter-integration<\/code><\/td>\nSpring Integration.<\/td>\n<\/tr>\n
spring-boot-starter-test<\/code><\/td>\nSpring includes test libraries like JUnit, Hamcrest, and Mockito.<\/td>\n<\/tr>\n
spring-boot-starter-jdbc<\/code><\/td>\nTomcat JDBC connection pool for JDBC applications.<\/td>\n<\/tr>\n
spring-boot-starter-mobile<\/code><\/td>\nSpring Mobile web applications.<\/td>\n<\/tr>\n
spring-boot-starter-validation<\/code><\/td>\nHibernate Validator with Java Bean validator.<\/td>\n<\/tr>\n
spring-boot-starter-hateoas<\/code><\/td>\nSpring HATEOAS and MVC hypermedia-based RESTful web applications<\/td>\n<\/tr>\n
spring-boot-starter-jersey<\/code><\/td>\nThis starter is an alternative starter to spring-boot-starter-web<\/code>, which uses Tomcat by default. We can build RESTful applications using Jersey and JAX RS with this starter.<\/td>\n<\/tr>\n
spring-boot-starter-data-neo4j<\/code><\/td>\nIntegrate the Neo4j graph database with Spring Data Neo4j.<\/td>\n<\/tr>\n
spring-boot-starter-data-ldap<\/code><\/td>\nuse Spring Data LDAP.<\/td>\n<\/tr>\n
spring-boot-starter-websocket<\/code><\/td>\nSpring Framework’s WebSocket support-based WebSocket applications.<\/td>\n<\/tr>\n
spring-boot-starter-aop<\/code><\/td>\nUse Spring AOP and AspectJ for aspect-oriented programming.<\/td>\n<\/tr>\n
spring-boot-starter-amqp<\/code><\/td>\nuse Spring AMQP and Rabbit MQ.<\/td>\n<\/tr>\n
spring-boot-starter-data-cassandra<\/code><\/td>\nUse Cassandra distributed database with Spring Data Cassandra.<\/td>\n<\/tr>\n
spring-boot-starter-social-facebook<\/code><\/td>\nSpring Social Facebook.<\/td>\n<\/tr>\n
spring-boot-starter-jta-atomikos<\/code><\/td>\nJTA transactions using Atomikos.<\/td>\n<\/tr>\n
spring-boot-starter-security<\/code><\/td>\nSpring Security.<\/td>\n<\/tr>\n
spring-boot-starter-mustache<\/code><\/td>\nMVC web applications with Views using Mustache.<\/td>\n<\/tr>\n
spring-boot-starter-data-jpa<\/code><\/td>\nHibernate with Spring Data JPA.<\/td>\n<\/tr>\n
spring-boot-starter<\/code><\/td>\nThe starter is the primary starter that contains the basic configuration details.<\/td>\n<\/tr>\n
spring-boot-starter-groovy-templates<\/code><\/td>\nMVC web applications with Views using Groovy.<\/td>\n<\/tr>\n
spring-boot-starter-freemarker<\/code><\/td>\nMVC web applications with Views using Freemarker.<\/td>\n<\/tr>\n
spring-boot-starter-batch<\/code><\/td>\nTo enable batch jobs in spring.<\/td>\n<\/tr>\n
spring-boot-starter-social-linkedin<\/code><\/td>\nSpring Social LinkedIn.<\/td>\n<\/tr>\n
spring-boot-starter-cache<\/code><\/td>\nSpring Framework’s caching mechanism.<\/td>\n<\/tr>\n
spring-boot-starter-data-solr<\/code><\/td>\nTo support apache Solr.<\/td>\n<\/tr>\n
spring-boot-starter- data-mongodb<\/code><\/td>\nTo use MongoDB document-oriented database with Spring Data MongoDB.<\/td>\n<\/tr>\n
spring-boot-starter-jooq<\/code><\/td>\nTo enable the use of jooq instead of jdbc for accessing SQL databases, we use this starter.<\/td>\n<\/tr>\n
spring-boot-starter-jta-narayana<\/code><\/td>\nTo use the Spring Boot JTA Starter Narayana<\/td>\n<\/tr>\n
spring-boot-starter-cloud-connectors<\/code><\/td>\nTo use Spring Cloud Connectors for cloud platforms like Cloud Foundry and Heroku.<\/td>\n<\/tr>\n
spring-boot-starter-jta-bitronix<\/code><\/td>\nTo enable Bitronix JTA transactions<\/td>\n<\/tr>\n
spring-boot-starter-social-twitter<\/code><\/td>\nSpring Social Twitter.<\/td>\n<\/tr>\n
spring-boot-starter-data-rest<\/code><\/td>\nuse Spring Data with Spring Data REST.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>
Application starters<\/figcaption><\/figure>\n
4. Third-Party Starters<\/h2>\n
Along with Spring Boot starters<\/code>, we can also make custom starters<\/code> as well. These starters are known as Third-party starters and their names generally do not start with spring-boot-starter*<\/code>.
 
<\/div> <\/div><\/p>\n
5. Spring Boot Production Starters and Technical Starters<\/h2>\n
Production Starters<\/code> provide additional features to help you monitor and manage your application in production. Production starters<\/code> are used for adding health metrics and monitoring to your application. The available ones are:<\/p>\n
\n\n\n\n\n\n
Starter name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
spring-boot-starter-actuator<\/code><\/td>\nGet production-ready features for monitoring and managing applications.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>
Production Starters<\/figcaption><\/figure>\n
Technical Starters are starters that provide functionality related to Web servers like Tomcat, Jetty, and logging.<\/p>\n
\n\n\n\n\n\n\n\n\n
           Starter name<\/strong><\/td>\n                                                      Description<\/strong><\/td>\n<\/tr>\n
spring-boot-starter-undertow<\/code><\/td>\nTo use Undertow as the embedded servlet container instead of the default Tomcat.<\/td>\n<\/tr>\n
spring-boot-starter-jetty<\/code><\/td>\nTo use Jetty as the embedded servlet container instead of the default Tomcat.<\/td>\n<\/tr>\n
spring-boot-starter-logging<\/code><\/td>\nTo enable Logging capability.<\/td>\n<\/tr>\n
spring-boot-starter-tomcat<\/code><\/td>\nTo use Tomcat as the embedded servlet container. Tomcat is the default container used by the web starter.<\/td>\n<\/tr>\n
spring-boot-starter-log4j2<\/code><\/td>\nEnable Log4j2 logging.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>
Technical Starters<\/figcaption><\/figure>\n
6. Spring Boot Parent<\/h2>\n
Every application has a set of default properties that all starters<\/code> and dependencies use. The spring boot parent needs to be added for every Spring boot application. The way we add a spring boot parent starter<\/code> in our project is as follows:<\/p>\n
 \n<parent>\n    <groupId>org.springframework.boot<\/groupId>\n    <artifactId>spring-boot-starter-parent<\/artifactId>\n    <version>2.4.5<\/version>\n    <relativePath\/>\n <\/parent>\n<\/pre>\n
The Spring boot starter parent does the job of dependency and plugin management. It provides the default Java version, Spring Boot versions, and Maven plugins.  <\/p>\n
7. Spring Boot Dependencies<\/h2>\n
Spring boot parent uses the spring dependencies. The spring-boot-dependencies contains a list of all dependencies it supports. The list of dependencies is available here<\/a>.<\/p>\n
Sometimes, in rare cases, we can skip adding the spring-boot-parent dependencies and do dependency management using the spring-boot-dependencies. The way we do this is by adding the following information in our pom.<\/p>\n
<dependencyManagement>  \n<dependencies>  \n<dependency>    \n<groupId>org.springframework.boot<\/groupId>  \n<artifactId>spring-boot-dependencies<\/artifactId>  \n<version>2.1.1.RELEASE<\/version>  \n<type>pom<\/type>  \n<scope>import<\/scope>  \n<\/dependency>  \n<\/dependencies>  \n<\/dependencyManagement> \n<\/pre>\n
8. Spring-Boot Starters Example<\/h2>\n
To understand how starters work, we have created a simple web-based “Hello World” Spring Boot project. The project has a Controller which displays a famous quote by Shakespeare. We have used Eclipse with Spring Tool Suite to create this project. The steps required to create this project are available here<\/a>. In the pom.xml file, we have included the following starters<\/code>:<\/p>\n