构建系统

强烈建议您选择一个支持依赖管理并可以从 Maven Central 仓库获取构件的构建系统。我们推荐您选择 Maven 或 Gradle。Spring Boot 也可以与其他构建系统(例如 Ant)一起使用,但支持程度不如 Maven 或 Gradle。

依赖管理

Spring Boot 的每个版本都提供了一个它所支持的精选依赖列表。实际上,您无需在构建配置中为这些依赖项指定版本,因为 Spring Boot 会为您管理。当您升级 Spring Boot 本身时,这些依赖项也会以一致的方式进行升级。

如果需要,您仍然可以指定版本并覆盖 Spring Boot 的推荐设置。

该精选列表包含所有可与 Spring Boot 一起使用的 Spring 模块以及经过精炼的第三方库列表。该列表以标准物料清单(spring-boot-dependencies)的形式提供,可用于 MavenGradle

每个 Spring Boot 版本都与 Spring Framework 的一个基础版本相关联。我们**强烈**建议您不要指定其版本。

Maven

要了解如何在 Maven 中使用 Spring Boot,请参阅 Spring Boot 的 Maven 插件文档

Gradle

要了解如何在 Gradle 中使用 Spring Boot,请参阅 Spring Boot 的 Gradle 插件文档

Ant

可以使用 Apache Ant+Ivy 构建 Spring Boot 项目。还提供了 spring-boot-antlib “AntLib”模块,以帮助 Ant 创建可执行 jar。

要声明依赖项,典型的 ivy.xml 文件示例如下

<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>

典型的 build.xml 文件示例如下

<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="3.4.5" />

	<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>
如果您不想使用 spring-boot-antlib 模块,请参阅“操作指南”中的不使用 spring-boot-antlib 从 Ant 构建可执行归档文件部分。

启动器

启动器是一组方便的依赖描述符,您可以将其包含在您的应用程序中。您无需翻遍示例代码并复制粘贴大量的依赖描述符,即可获得所需的所有 Spring 及相关技术的一站式服务。例如,如果您想开始使用 Spring 和 JPA 进行数据库访问,只需在项目中包含 spring-boot-starter-data-jpa 依赖项即可。

启动器包含您快速启动和运行项目所需的大量依赖项,并提供一套一致、受支持的托管传递依赖项。

命名的含义

所有**官方**启动器都遵循相似的命名模式:spring-boot-starter-*,其中 * 代表特定类型的应用程序。这种命名结构旨在帮助您查找启动器。许多 IDE 中的 Maven 集成允许您按名称搜索依赖项。例如,安装相应的 Eclipse 或 Spring Tools 插件后,您可以在 POM 编辑器中按下 ctrl-space 并输入“spring-boot-starter”以获取完整列表。

正如创建自己的启动器部分所解释的,第三方启动器不应以 spring-boot 开头,因为这是为官方 Spring Boot 构件保留的。相反,第三方启动器通常以项目名称开头。例如,一个名为 thirdpartyproject 的第三方启动器项目通常会被命名为 thirdpartyproject-spring-boot-starter

以下应用程序启动器由 Spring Boot 在 org.springframework.boot 组下提供

表 1. Spring Boot 应用程序启动器
名称 描述

spring-boot-starter

核心启动器,包括自动配置支持、日志记录和 YAML

spring-boot-starter-activemq

使用 Apache ActiveMQ 进行 JMS 消息传递的启动器

spring-boot-starter-amqp

使用 Spring AMQP 和 Rabbit MQ 的启动器

spring-boot-starter-aop

使用 Spring AOP 和 AspectJ 进行面向切面编程的启动器

spring-boot-starter-artemis

使用 Apache Artemis 进行 JMS 消息传递的启动器

spring-boot-starter-batch

使用 Spring Batch 的启动器

spring-boot-starter-cache

使用 Spring Framework 缓存支持的启动器

spring-boot-starter-data-cassandra

使用 Cassandra 分布式数据库和 Spring Data Cassandra 的启动器

spring-boot-starter-data-cassandra-reactive

使用 Cassandra 分布式数据库和 Spring Data Cassandra Reactive 的启动器

spring-boot-starter-data-couchbase

使用 Couchbase 面向文档数据库和 Spring Data Couchbase 的启动器

spring-boot-starter-data-couchbase-reactive

使用 Couchbase 面向文档数据库和 Spring Data Couchbase Reactive 的启动器

spring-boot-starter-data-elasticsearch

使用 Elasticsearch 搜索和分析引擎以及 Spring Data Elasticsearch 的启动器

spring-boot-starter-data-jdbc

使用 Spring Data JDBC 的启动器

spring-boot-starter-data-jpa

使用 Spring Data JPA 和 Hibernate 的启动器

spring-boot-starter-data-ldap

使用 Spring Data LDAP 的启动器

spring-boot-starter-data-mongodb

使用 MongoDB 面向文档数据库和 Spring Data MongoDB 的启动器

spring-boot-starter-data-mongodb-reactive

使用 MongoDB 面向文档数据库和 Spring Data MongoDB Reactive 的启动器

spring-boot-starter-data-neo4j

使用 Neo4j 图数据库和 Spring Data Neo4j 的启动器

spring-boot-starter-data-r2dbc

使用 Spring Data R2DBC 的启动器

spring-boot-starter-data-redis

使用 Spring Data Redis 和 Lettuce 客户端访问 Redis 键值数据存储的启动器

spring-boot-starter-data-redis-reactive

使用 Spring Data Redis Reactive 和 Lettuce 客户端访问 Redis 键值数据存储的启动器

spring-boot-starter-data-rest

使用 Spring Data REST 和 Spring MVC 通过 REST 暴露 Spring Data 仓库的启动器

spring-boot-starter-freemarker

使用 FreeMarker 视图构建 MVC Web 应用程序的启动器

spring-boot-starter-graphql

使用 Spring GraphQL 构建 GraphQL 应用程序的启动器

spring-boot-starter-groovy-templates

使用 Groovy 模板视图构建 MVC Web 应用程序的启动器

spring-boot-starter-hateoas

使用 Spring MVC 和 Spring HATEOAS 构建基于超媒体的 RESTful Web 应用程序的启动器

spring-boot-starter-integration

使用 Spring Integration 的启动器

spring-boot-starter-jdbc

使用 HikariCP 连接池访问 JDBC 的启动器

spring-boot-starter-jersey

使用 JAX-RS 和 Jersey 构建 RESTful Web 应用程序的启动器。是 spring-boot-starter-web 的替代品

spring-boot-starter-jooq

使用 jOOQ 通过 JDBC 访问 SQL 数据库的启动器。是 spring-boot-starter-data-jpaspring-boot-starter-jdbc 的替代品

spring-boot-starter-json

用于读写 JSON 的启动器

spring-boot-starter-mail

使用 Java Mail 和 Spring Framework 邮件发送支持的启动器

spring-boot-starter-mustache

使用 Mustache 视图构建 Web 应用程序的启动器

spring-boot-starter-oauth2-authorization-server

使用 Spring Authorization Server 特性的启动器

spring-boot-starter-oauth2-client

使用 Spring Security OAuth2/OpenID Connect 客户端特性的启动器

spring-boot-starter-oauth2-resource-server

使用 Spring Security OAuth2 资源服务器特性的启动器

spring-boot-starter-pulsar

使用 Spring for Apache Pulsar 的启动器

spring-boot-starter-pulsar-reactive

使用 Spring for Apache Pulsar Reactive 的启动器

spring-boot-starter-quartz

使用 Quartz 调度器的启动器

spring-boot-starter-rsocket

构建 RSocket 客户端和服务器的启动器

spring-boot-starter-security

使用 Spring Security 的启动器

spring-boot-starter-test

用于使用 JUnit Jupiter、Hamcrest 和 Mockito 等库测试 Spring Boot 应用程序的启动器

spring-boot-starter-thymeleaf

使用 Thymeleaf 视图构建 MVC Web 应用程序的启动器

spring-boot-starter-validation

使用 Java Bean Validation 和 Hibernate Validator 的启动器

spring-boot-starter-web

使用 Spring MVC 构建 Web(包括 RESTful)应用程序的启动器。使用 Tomcat 作为默认的嵌入式容器

spring-boot-starter-web-services

使用 Spring Web Services 的启动器

spring-boot-starter-webflux

使用 Spring Framework 响应式 Web 支持构建 WebFlux 应用程序的启动器

spring-boot-starter-websocket

使用 Spring Framework MVC WebSocket 支持构建 WebSocket 应用程序的启动器

除了应用程序启动器外,还可以使用以下启动器来添加生产就绪特性

表 2. Spring Boot 生产启动器
名称 描述

spring-boot-starter-actuator

用于使用 Spring Boot Actuator 的启动器,它提供生产就绪特性来帮助您监控和管理应用程序

最后,如果您想排除或替换特定的技术方面,Spring Boot 还包括以下启动器

表 3. Spring Boot 技术启动器
名称 描述

spring-boot-starter-jetty

使用 Jetty 作为嵌入式 Servlet 容器的启动器。是 spring-boot-starter-tomcat 的替代品

spring-boot-starter-log4j2

使用 Log4j2 进行日志记录的启动器。是 spring-boot-starter-logging 的替代品

spring-boot-starter-logging

使用 Logback 进行日志记录的启动器。默认的日志启动器

spring-boot-starter-reactor-netty

使用 Reactor Netty 作为嵌入式响应式 HTTP 服务器的启动器。

spring-boot-starter-tomcat

使用 Tomcat 作为嵌入式 Servlet 容器的启动器。由 spring-boot-starter-web 使用的默认 Servlet 容器启动器

spring-boot-starter-undertow

使用 Undertow 作为嵌入式 Servlet 容器的启动器。是 spring-boot-starter-tomcat 的替代品

要了解如何替换技术方面,请参阅有关替换 Web 服务器日志系统的操作指南文档。

有关社区贡献的其他启动器列表,请参阅 GitHub 上 spring-boot-starters 模块中的 README 文件