This version is still in development and is not considered stable yet. For the latest stable version, please use Spring Boot 3.5.5!spring-doc.cn

Build Systems

It is strongly recommended that you choose a build system that supports dependency management and that can consume artifacts published to the Maven Central repository. We would recommend that you choose Maven or Gradle. It is possible to get Spring Boot to work with other build systems (Ant, for example), but they are not particularly well supported.spring-doc.cn

Dependency Management

Each release of Spring Boot provides a curated list of dependencies that it supports. In practice, you do not need to provide a version for any of these dependencies in your build configuration, as Spring Boot manages that for you. When you upgrade Spring Boot itself, these dependencies are upgraded as well in a consistent way.spring-doc.cn

You can still specify a version and override Spring Boot’s recommendations if you need to do so.

The curated list contains all the Spring modules that you can use with Spring Boot as well as a refined list of third party libraries. The list is available as a standard Bills of Materials (spring-boot-dependencies) that can be used with both Maven and Gradle.spring-doc.cn

Each release of Spring Boot is associated with a base version of the Spring Framework. We highly recommend that you do not specify its version.

Maven

To learn about using Spring Boot with Maven, see the documentation for Spring Boot’s Maven plugin:spring-doc.cn

Gradle

To learn about using Spring Boot with Gradle, see the documentation for Spring Boot’s Gradle plugin:spring-doc.cn

Ant

It is possible to build a Spring Boot project using Apache Ant+Ivy. The spring-boot-antlib “AntLib” module is also available to help Ant create executable jars.spring-doc.cn

To declare dependencies, a typical ivy.xml file looks something like the following example:spring-doc.cn

<ivy-module version="2.0">
	<info organisation="org.springframework.boot" module="spring-boot-sample-ant" />
	<configurations>
		<conf name="compile" description="everything needed to compile this module" />
		<conf name="runtime" extends="compile" description="everything needed to run this module" />
	</configurations>
	<dependencies>
		<dependency org="org.springframework.boot" name="spring-boot-starter"
			rev="${spring-boot.version}" conf="compile" />
	</dependencies>
</ivy-module>

A typical build.xml looks like the following example:spring-doc.cn

<project
	xmlns:ivy="antlib:org.apache.ivy.ant"
	xmlns:spring-boot="antlib:org.springframework.boot.ant"
	name="myapp" default="build">

	<property name="spring-boot.version" value="4.0.0-M2" />

	<target name="resolve" description="--> retrieve dependencies with ivy">
		<ivy:retrieve pattern="lib/[conf]/[artifact]-[type]-[revision].[ext]" />
	</target>

	<target name="classpaths" depends="resolve">
		<path id="compile.classpath">
			<fileset dir="lib/compile" includes="*.jar" />
		</path>
	</target>

	<target name="init" depends="classpaths">
		<mkdir dir="build/classes" />
	</target>

	<target name="compile" depends="init" description="compile">
		<javac srcdir="src/main/java" destdir="build/classes" classpathref="compile.classpath" />
	</target>

	<target name="build" depends="compile">
		<spring-boot:exejar destfile="build/myapp.jar" classes="build/classes">
			<spring-boot:lib>
				<fileset dir="lib/runtime" />
			</spring-boot:lib>
		</spring-boot:exejar>
	</target>
</project>
If you do not want to use the spring-boot-antlib module, see the Build an Executable Archive From Ant without Using spring-boot-antlib section of “How-to Guides”.

Starters

Starters are a set of convenient dependency descriptors that you can include in your application. You get a one-stop shop for all the Spring and related technologies that you need without having to hunt through sample code and copy-paste loads of dependency descriptors. For example, if you want to get started using Spring and JPA for database access, include the spring-boot-starter-data-jpa dependency in your project.spring-doc.cn

The starters contain a lot of the dependencies that you need to get a project up and running quickly and with a consistent, supported set of managed transitive dependencies.spring-doc.cn

What is in a name

All official starters follow a similar naming pattern; spring-boot-starter-*, where * is a particular type of application. This naming structure is intended to help when you need to find a starter. The Maven integration in many IDEs lets you search dependencies by name. For example, with the appropriate Eclipse or Spring Tools plugin installed, you can press ctrl-space in the POM editor and type “spring-boot-starter” for a complete list.spring-doc.cn

As explained in the Creating Your Own Starter section, third party starters should not start with spring-boot, as it is reserved for official Spring Boot artifacts. Rather, a third-party starter typically starts with the name of the project. For example, a third-party starter project called thirdpartyproject would typically be named thirdpartyproject-spring-boot-starter.spring-doc.cn

The following application starters are provided by Spring Boot under the org.springframework.boot group:spring-doc.cn

Table 1. Spring Boot application starters
Name Description

spring-boot-starterspring-doc.cn

Core starter, including auto-configuration support, logging and YAMLspring-doc.cn

spring-boot-starter-activemqspring-doc.cn

Starter for using Apache ActiveMQ and JMSspring-doc.cn

spring-boot-starter-amqpspring-doc.cn

Starter for using Spring AMQP and Rabbit MQspring-doc.cn

spring-boot-starter-aopspring-doc.cn

Starter for aspect-oriented programming with Spring AOP and AspectJspring-doc.cn

spring-boot-starter-artemisspring-doc.cn

Starter for Apache Artemis and JMSspring-doc.cn

spring-boot-starter-batchspring-doc.cn

Starter for using Spring Batchspring-doc.cn

spring-boot-starter-cachespring-doc.cn

Starter for using Spring’s caching supportspring-doc.cn

spring-boot-starter-cassandraspring-doc.cn

Starter for using Cassandra distributed databasespring-doc.cn

spring-boot-starter-classicspring-doc.cn

Core classic starter, including full auto-configuration support, logging and YAMLspring-doc.cn

spring-boot-starter-cloudfoundryspring-doc.cn

Starter for using Cloud Foundryspring-doc.cn

spring-boot-starter-couchbasespring-doc.cn

Starter for using Couchbase document-oriented databasespring-doc.cn

spring-boot-starter-data-cassandraspring-doc.cn

Starter for using Cassandra distributed database and Spring Data Cassandraspring-doc.cn

spring-boot-starter-data-cassandra-reactivespring-doc.cn

Starter for using Cassandra distributed database and Spring Data Cassandra Reactivespring-doc.cn

spring-boot-starter-data-couchbasespring-doc.cn

Starter for using Couchbase document-oriented database and Spring Data Couchbasespring-doc.cn

spring-boot-starter-data-couchbase-reactivespring-doc.cn

Starter for using Couchbase document-oriented database and Spring Data Couchbase Reactivespring-doc.cn

spring-boot-starter-data-elasticsearchspring-doc.cn

Starter for using Elasticsearch search and analytics engine and Spring Data Elasticsearchspring-doc.cn

spring-boot-starter-data-jdbcspring-doc.cn

Starter for using Spring Data JDBCspring-doc.cn

spring-boot-starter-data-jpaspring-doc.cn

Starter for using Spring Data JPA with Hibernatespring-doc.cn

spring-boot-starter-data-ldapspring-doc.cn

Starter for using Spring Data LDAPspring-doc.cn

spring-boot-starter-data-mongodbspring-doc.cn

Starter for using MongoDB document-oriented database and Spring Data MongoDBspring-doc.cn

spring-boot-starter-data-mongodb-reactivespring-doc.cn

Starter for using MongoDB document-oriented database and Spring Data MongoDB Reactivespring-doc.cn

spring-boot-starter-data-neo4jspring-doc.cn

Starter for using Neo4j graph database and Spring Data Neo4jspring-doc.cn

spring-boot-starter-data-r2dbcspring-doc.cn

Starter for using Spring Data R2DBCspring-doc.cn

spring-boot-starter-data-redisspring-doc.cn

Starter for using Redis key-value data store with Spring Data Redis and the Lettuce clientspring-doc.cn

spring-boot-starter-data-redis-reactivespring-doc.cn

Starter for using Redis key-value data store with Spring Data Redis reactive and the Lettuce clientspring-doc.cn

spring-boot-starter-data-restspring-doc.cn

Starter for exposing Spring Data repositories over REST using Spring Data REST and Spring MVCspring-doc.cn

spring-boot-starter-elasticsearchspring-doc.cn

Starter for using Elasticsearch search and analytics enginespring-doc.cn

spring-boot-starter-flywayspring-doc.cn

Starter for using Flyway database migrationsspring-doc.cn

spring-boot-starter-freemarkerspring-doc.cn

Starter for using FreeMarkerspring-doc.cn

spring-boot-starter-graphqlspring-doc.cn

Starter using Spring GraphQLspring-doc.cn

spring-boot-starter-groovy-templatesspring-doc.cn

Starter for using Groovy Templatesspring-doc.cn

spring-boot-starter-gsonspring-doc.cn

Starter for using GSONspring-doc.cn

spring-boot-starter-hateoasspring-doc.cn

Starter for using Spring HATEOS to build hypermedia-based RESTful Spring MVC web applicationsspring-doc.cn

spring-boot-starter-hazelcastspring-doc.cn

Starter for using Hazelcastspring-doc.cn

spring-boot-starter-integrationspring-doc.cn

Starter for using Spring Integrationspring-doc.cn

spring-boot-starter-jacksonspring-doc.cn

Starter for using Jacksonspring-doc.cn

spring-boot-starter-jdbcspring-doc.cn

Starter for using JDBC with the HikariCP connection poolspring-doc.cn

spring-boot-starter-jerseyspring-doc.cn

Starter for using JAX-RS and Jerseyspring-doc.cn

spring-boot-starter-jettyspring-doc.cn

Starter for using Jetty as the embedded servlet containerspring-doc.cn

spring-boot-starter-jmsspring-doc.cn

Starter for using JMSspring-doc.cn

spring-boot-starter-jooqspring-doc.cn

Starter for using jOOQ to access SQL databases with JDBCspring-doc.cn

spring-boot-starter-jsonspring-doc.cn

Starter for reading and writing JSONspring-doc.cn

spring-boot-starter-jsonbspring-doc.cn

Starter for JSON-Bspring-doc.cn

spring-boot-starter-kafkaspring-doc.cn

Starter for Kafkaspring-doc.cn

spring-boot-starter-ldapspring-doc.cn

Starter for LDAPspring-doc.cn

spring-boot-starter-liquibasespring-doc.cn

Starter for using Liquibase database migrationsspring-doc.cn

spring-boot-starter-mailspring-doc.cn

Starter for using Java Mail and Spring Framework’s email sending supportspring-doc.cn

spring-boot-starter-mongodbspring-doc.cn

Starter for using MongoDB document-oriented databasespring-doc.cn

spring-boot-starter-mustachespring-doc.cn

Starter for using Mustachespring-doc.cn

spring-boot-starter-neo4jspring-doc.cn

Starter for using Neo4j graph databasespring-doc.cn

spring-boot-starter-oauth2-authorization-serverspring-doc.cn

Starter for using Spring Authorization Server features (deprecated in favor of spring-boot-starter-security-oauth2-authorization-server)spring-doc.cn

spring-boot-starter-oauth2-clientspring-doc.cn

Starter for using Spring Security’s OAuth2/OpenID Connect client features (deprecated in favor of spring-boot-starter-security-oauth2-client)spring-doc.cn

spring-boot-starter-oauth2-resource-serverspring-doc.cn

Starter for using Spring Security’s OAuth2 resource server features (deprecated in favor of spring-boot-starter-security-oauth2-resource-server)spring-doc.cn

spring-boot-starter-opentelemetryspring-doc.cn

Starter for using OpenTelemetryspring-doc.cn

spring-boot-starter-pulsarspring-doc.cn

Starter for using Spring for Apache Pulsarspring-doc.cn

spring-boot-starter-pulsar-reactivespring-doc.cn

Starter for using Spring for Apache Pulsar Reactivespring-doc.cn

spring-boot-starter-quartzspring-doc.cn

Starter for using the Quartz schedulerspring-doc.cn

spring-boot-starter-r2dbcspring-doc.cn

Starter for using R2DBCspring-doc.cn

spring-boot-starter-reactorspring-doc.cn

Starter for using Reactorspring-doc.cn

spring-boot-starter-reactor-nettyspring-doc.cn

Starter for Reactor Nettyspring-doc.cn

spring-boot-starter-restclientspring-doc.cn

Starter using Spring’s blocking HTTP clients (RestClient, RestTemplate and HTTP Service Clients)spring-doc.cn

spring-boot-starter-rsocketspring-doc.cn

Starter for building RSocket clients and serversspring-doc.cn

spring-boot-starter-securityspring-doc.cn

Starter for using Spring Securityspring-doc.cn

spring-boot-starter-security-oauth2-authorization-serverspring-doc.cn

Starter for using Spring Authorization Server featuresspring-doc.cn

spring-boot-starter-security-oauth2-clientspring-doc.cn

Starter for using Spring Security’s OAuth2/OpenID Connect client featuresspring-doc.cn

spring-boot-starter-security-oauth2-resource-serverspring-doc.cn

Starter for using Spring Security’s OAuth2 resource server featuresspring-doc.cn

spring-boot-starter-security-saml2spring-doc.cn

Starter for using Spring Security with SAML2spring-doc.cn

spring-boot-starter-sendgridspring-doc.cn

Starter for using Spring Session with Sendgridspring-doc.cn

spring-boot-starter-session-data-mongodbspring-doc.cn

Starter for using Spring Session with Spring Data MongoDBspring-doc.cn

spring-boot-starter-session-data-redisspring-doc.cn

Starter for using Spring Session with Spring Data Redisspring-doc.cn

spring-boot-starter-session-hazelcastspring-doc.cn

Starter for using Spring Session with Hazelcastspring-doc.cn

spring-boot-starter-session-jdbcspring-doc.cn

Starter for using Spring Session with JDBCspring-doc.cn

spring-boot-starter-sqlspring-doc.cn

Starter for SQL supportspring-doc.cn

spring-boot-starter-testspring-doc.cn

Starter for testing Spring Boot applications with libraries including JUnit Jupiter, Hamcrest and Mockitospring-doc.cn

spring-boot-starter-thymeleafspring-doc.cn

Starter for using Thymeleafspring-doc.cn

spring-boot-starter-tomcatspring-doc.cn

Starter for using Tomcatspring-doc.cn

spring-boot-starter-validationspring-doc.cn

Starter for using Java Bean Validation with Hibernate Validatorspring-doc.cn

spring-boot-starter-webspring-doc.cn

Starter for building web, including RESTful, applications using Spring MVC. Uses Tomcat as the default embedded container (deprecated in favor of spring-boot-starter-webmvc)spring-doc.cn

spring-boot-starter-web-servicesspring-doc.cn

Starter for using Spring Web Services (deprecated in favor of spring-boot-starter-webservices)spring-doc.cn

spring-boot-starter-webclientspring-doc.cn

Starter using Spring’s reactive HTTP clients (WebClient and HTTP Service Clients)spring-doc.cn

spring-boot-starter-webfluxspring-doc.cn

Starter for building WebFlux applications using Spring Framework’s Reactive Web support and Reactor Nettyspring-doc.cn

spring-boot-starter-webmvcspring-doc.cn

Starter for building web, including RESTful, applications using Spring MVC and Tomcatspring-doc.cn

spring-boot-starter-webservicesspring-doc.cn

Starter for using Spring Web Servicesspring-doc.cn

spring-boot-starter-websocketspring-doc.cn

Starter for building WebSocket applications using Spring Framework’s MVC WebSocket supportspring-doc.cn

spring-boot-starter-zipkinspring-doc.cn

Starter for using Zipkinspring-doc.cn

In addition to the application starters, the following starters can be used to add production ready features:spring-doc.cn

Table 2. Spring Boot production starters
Name Description

spring-boot-starter-actuatorspring-doc.cn

Starter for using Spring Boot’s Actuator which provides production ready features to help you monitor and manage your applicationspring-doc.cn

Finally, Spring Boot also includes the following starters that can be used if you want to exclude or swap specific technical facets:spring-doc.cn

Table 3. Spring Boot technical starters
Name Description

spring-boot-starter-log4j2spring-doc.cn

Starter for using Log4j2spring-doc.cn

spring-boot-starter-logbackspring-doc.cn

Starter for logging using Logbackspring-doc.cn

spring-boot-starter-loggingspring-doc.cn

Starter for logging default loggingspring-doc.cn

To learn how to swap technical facets, please see the how-to documentation for swapping web server and logging system.spring-doc.cn

For a list of additional community contributed starters, see the README file in the spring-boot-starters module on GitHub.