构建系统

强烈建议您选择一个支持依赖管理并且可以访问发布到 Maven Central 存储库中的构件的构建系统。我们建议您选择 Maven 或 Gradle。Spring Boot 可以与其他构建系统(例如 Ant)一起使用,但这并不被很好地支持。

依赖管理

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

如果您需要,您仍然可以指定版本并覆盖 Spring Boot 的建议。

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

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

Maven

要了解如何将 Spring Boot 与 Maven 一起使用,请参阅 Spring Boot 的 Maven 插件文档。

Gradle

要了解如何将 Spring Boot 与 Gradle 一起使用,请参阅 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.3.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 模块,请参阅“操作指南”中的从 Ant 构建可执行归档文件而不使用 spring-boot-antlib 部分。

启动器

启动器是一组方便的依赖项描述符,您可以将其包含在您的应用程序中。您可以一站式获得所有需要的 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

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

spring-boot-starter-data-redis-reactive

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

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

用于使用 JDBC 和 HikariCP 连接池的启动器

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 的 Reactive 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 文件