构建系统
强烈建议你选择一个支持 依赖管理 并且能够使用发布到 Maven Central 仓库的构件的构建系统。我们推荐你选择 Maven 或 Gradle。虽然也可以让 Spring Boot 与其他构建系统(例如 Ant)一起工作,但它们并没有得到特别好的支持。
依赖管理
Spring Boot 的每个版本都会提供一份它所支持的依赖项的精选列表。在实际使用中,你无需在构建配置中为这些依赖项指定版本,因为 Spring Boot 会为你统一管理。当你升级 Spring Boot 本身时,这些依赖项也会以一致的方式随之升级。
如果你需要,仍然可以指定一个版本并覆盖 Spring Boot 的推荐配置。
每个 Spring Boot 版本都关联一个基础版本的 Spring Framework。我们强烈建议您不要指定其版本。
Maven
要了解如何将 Spring Boot 与 Maven 一起使用,请参阅 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="4.0.2" />
<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 模块,请参阅 “How-to Guides” 中的 不使用 spring-boot-antlib 从 Ant 构建可执行归档文件 部分。
Starters
Starter 是一组便捷的依赖描述符,你可以将其包含在应用程序中。这样,你无需在示例代码中四处查找并复制粘贴大量依赖描述符,即可一站式获取所需的所有 Spring 及相关技术。例如,如果你想使用 Spring 和 JPA 进行数据库访问,只需在项目中引入 spring-boot-starter-data-jpa 依赖即可。
Starter 包含了大量依赖项,可帮助你快速启动并运行项目,并提供一组一致且受支持的托管传递依赖。
以下应用启动器由 Spring Boot 在 org.springframework.boot 组下提供:
表 1. Spring Boot 应用启动器
| 名称 | 描述 |
|---|---|
spring-boot-starter | 核心启动器,包括自动配置支持、日志记录和 YAML |
spring-boot-starter-activemq | 使用 Apache ActiveMQ 和 JMS 的入门指南 |
spring-boot-starter-activemq-test | 使用 Apache ActiveMQ 和 JMS 进行测试的 Starter |
spring-boot-starter-actuator-test | 用于测试 Spring Boot Actuator 的 Starter,Actuator 提供了生产就绪的功能,帮助你监控和管理应用程序。 |
spring-boot-starter-amqp | 使用 Spring AMQP 和 RabbitMQ 的入门指南 |
spring-boot-starter-amqp-test | 用于测试 Spring AMQP 和 RabbitMQ 的 Starter |
spring-boot-starter-artemis | 使用 Apache Artemis 和 JMS 的入门指南 |
spring-boot-starter-artemis-test | 用于测试 Apache Artemis 和 JMS 的 Starter |
spring-boot-starter-aspectj | 使用 AspectJ 进行面向切面编程的入门指南 |
spring-boot-starter-aspectj-test | 用于使用 AspectJ 测试面向切面编程的入门项目 |
spring-boot-starter-batch | Spring Batch 入门示例 |
spring-boot-starter-batch-jdbc | 使用 Spring Batch 与 JDBC 的入门示例 |
spring-boot-starter-batch-jdbc-test | 使用 Spring Batch 和 JDBC 进行测试的 Starter |
spring-boot-starter-batch-test | 用于使用 Spring Batch 进行测试的 Starter |
spring-boot-starter-cache | 用于使用 Spring 缓存支持的入门工具 |
spring-boot-starter-cache-test | 用于测试 Spring 缓存支持的 Starter |
spring-boot-starter-cassandra | Cassandra 分布式数据库入门 |
spring-boot-starter-cassandra-test | 用于测试 Cassandra 分布式数据库的 Starter |
spring-boot-starter-classic | 核心经典 starter,包括完整的自动配置支持、日志记录和 YAML |
spring-boot-starter-cloudfoundry | Cloud Foundry 入门指南 |
spring-boot-starter-cloudfoundry-test | 用于测试 Cloud Foundry 的 Starter |
spring-boot-starter-couchbase | 用于使用 Couchbase 文档型数据库的入门工具 |
spring-boot-starter-couchbase-test | 用于测试 Couchbase 文档型数据库的 Starter |
spring-boot-starter-data-cassandra | 使用 Cassandra 分布式数据库和 Spring Data Cassandra 的入门指南 |
spring-boot-starter-data-cassandra-reactive | 用于 Cassandra 分布式数据库和 Spring Data Cassandra Reactive 的入门示例 |
spring-boot-starter-data-cassandra-reactive-test | 用于测试 Cassandra 分布式数据库和 Spring Data Cassandra Reactive 的 Starter |
spring-boot-starter-data-cassandra-test | 用于测试 Cassandra 分布式数据库和 Spring Data Cassandra 的 Starter |
spring-boot-starter-data-couchbase | 使用 Couchbase 文档型数据库和 Spring Data Couchbase 的入门示例 |
spring-boot-starter-data-couchbase-reactive | 用于 Couchbase 面向文档数据库和 Spring Data Couchbase Reactive 的入门示例 |
spring-boot-starter-data-couchbase-reactive-test | 用于测试 Couchbase 面向文档数据库和 Spring Data Couchbase Reactive 的 Starter |
spring-boot-starter-data-couchbase-test | 用于测试 Couchbase 文档型数据库和 Spring Data Couchbase 的 Starter |
spring-boot-starter-data-elasticsearch | 用于 Elasticsearch 搜索和分析引擎以及 Spring Data Elasticsearch 的入门工具 |
spring-boot-starter-data-elasticsearch-test | 用于测试 Elasticsearch 搜索与分析引擎以及 Spring Data Elasticsearch 的 Starter |
spring-boot-starter-data-jpa | Spring Data JDBC 入门 |
spring-boot-starter-data-jdbc-test | 用于测试 Spring Data JDBC 的 Starter |
spring-boot-starter-data-jpa | 使用 Spring Data JPA 与 Hibernate 的入门示例 |
spring-boot-starter-data-jpa-test | 用于测试 Spring Data JPA 与 Hibernate 的 Starter |
spring-boot-starter-data-ldap | Spring Data LDAP 入门示例 |
spring-boot-starter-data-ldap-test | 用于测试 Spring Data LDAP 的 Starter |
spring-boot-starter-data-mongodb | 使用 MongoDB 面向文档数据库和 Spring Data MongoDB 的入门指南 |
spring-boot-starter-data-mongodb-reactive | 用于 MongoDB 面向文档数据库和 Spring Data MongoDB Reactive 的 Starter |
spring-boot-starter-data-mongodb-reactive-test | 用于 MongoDB 面向文档数据库和 Spring Data MongoDB Reactive 的 Starter |
spring-boot-starter-data-mongodb-test | 用于测试 MongoDB 文档型数据库和 Spring Data MongoDB 的入门示例 |
spring-boot-starter-data-neo4j | 使用 Neo4j 图数据库和 Spring Data Neo4j 的入门示例 |
spring-boot-starter-data-neo4j-test | 用于测试 Neo4j 图数据库和 Spring Data Neo4j 的入门项目 |
spring-boot-starter-data-r2dbc | Spring Data R2DBC 入门 |
spring-boot-starter-data-r2dbc-test | 用于测试 Spring Data R2DBC 的 Starter |
spring-boot-starter-data-redis | 使用 Spring Data Redis 和 Lettuce 客户端操作 Redis 键值数据存储的入门示例 |
spring-boot-starter-data-redis-reactive | 使用 Spring Data Redis 响应式编程和 Lettuce 客户端操作 Redis 键值数据存储的入门示例 |
spring-boot-starter-data-redis-reactive-test | 用于通过 Spring Data Redis 响应式编程和 Lettuce 客户端测试 Redis 键值数据存储的 Starter |
spring-boot-starter-data-redis-test | 用于测试 Redis 键值数据存储的 Starter,基于 Spring Data Redis 和 Lettuce 客户端 |
spring-boot-starter-data-rest | 使用 Spring Data REST 和 Spring MVC 通过 REST 暴露 Spring Data 仓库的入门示例 |
spring-boot-starter-data-rest-test | 用于测试通过 Spring Data REST 和 Spring MVC 暴露的 Spring Data 仓库的 Starter |
spring-boot-starter-elasticsearch | Elasticsearch 搜索与分析引擎的入门工具 |
spring-boot-starter-elasticsearch-test | 用于测试 Elasticsearch 搜索和分析引擎的 Starter |
spring-boot-starter-flyway | 用于 Flyway 数据库迁移的入门示例 |
spring-boot-starter-flyway-test | 用于测试 Flyway 数据库迁移的 Starter |
spring-boot-starter-freemarker | FreeMarker 使用入门 |
spring-boot-starter-freemarker-test | 用于测试 FreeMarker 的启动器 |
spring-boot-starter-graphql | 使用 Spring GraphQL 的 Starter |
spring-boot-starter-graphql-test | 用于测试 Spring GraphQL 的 Starter |
spring-boot-starter-groovy-templates | Groovy 模板使用入门 |
spring-boot-starter-groovy-templates-test | 用于测试 Groovy 模板的 Starter |
spring-boot-starter-gson | GSON 使用入门 |
spring-boot-starter-gson-test | 用于测试 GSON 的启动器 |
spring-boot-starter-hateoas | 用于使用 Spring HATEOAS 构建基于超媒体的 RESTful Spring MVC Web 应用程序的入门工具 |
spring-boot-starter-hateoas-test | 用于测试 Spring HATEOAS 的 Starter,以构建基于超媒体的 RESTful Spring MVC Web 应用程序 |
spring-boot-starter-hazelcast | Hazelcast 入门示例 |
spring-boot-starter-hazelcast-test | 用于测试 Hazelcast 的启动器 |
spring-boot-starter-integration | Spring Integration 入门示例 |
spring-boot-starter-integration-test | 用于测试 Spring Integration 的 Starter |
spring-boot-starter-jackson | Jackson 使用入门 |
spring-boot-starter-jackson-test | 用于测试 Jackson 的启动器 |
spring-boot-starter-jdbc | 使用 HikariCP 连接池的 JDBC 入门示例 |
spring-boot-starter-jdbc-test | 用于使用 HikariCP 连接池测试 JDBC 的 Starter |
spring-boot-starter-jersey | 使用 JAX-RS 和 Jersey 的入门指南 |
spring-boot-starter-jersey-test | 用于测试 JAX-RS 和 Jersey 的 Starter |
spring-boot-starter-jetty | 用于将 Jetty 作为嵌入式 Servlet 容器的入门示例 |
spring-boot-starter-jms | JMS 使用入门 |
spring-boot-starter-j莫斯-test | 用于测试 JMS 的 Starter |
spring-boot-starter-jooq | 使用 jOOQ 通过 JDBC 访问 SQL 数据库的入门示例 |
spring-boot-starter-jooq-test | 用于测试 jOOQ 通过 JDBC 访问 SQL 数据库的 Starter |
spring-boot-starter-json | 用于读写 JSON 的入门工具 |
spring-boot-starter-jsonb | JSON-B 使用入门 |
spring-boot-starter-jsonb-test | 用于测试 JSON-B 的 Starter |
spring-boot-starter-kafka | Apache Kafka 入门指南 |
spring-boot-starter-kafka-test | 用于测试 Apache Kafka 的 Starter |
spring-boot-starter-kotlinx-serialization-json | Kotlinx Serialization JSON 入门 |
spring-boot-starter-kotlinx-serialization-json-test | 用于测试 Kotlinx Serialization JSON 的 Starter |
spring-boot-starter-ldap | LDAP 使用入门 |
spring-boot-starter-ldap-test | 用于测试 LDAP 的启动器 |
spring-boot-starter-liquibase | Liquibase 数据库迁移入门 |
spring-boot-starter-liquibase-test | 用于测试 Liquibase 数据库迁移的 Starter |
spring-boot-starter-mail | 用于 Java Mail 和 Spring Framework 邮件发送支持的 Starter |
spring-boot-starter-mail-test | 用于测试 Java Mail 和 Spring Framework 邮件发送支持的 Starter |
spring-boot-starter-micrometer-metrics | Micrometer Metrics 使用入门 |
spring-boot-starter-micrometer-metrics-test | 用于测试 Micrometer Metrics 的 Starter |
spring-boot-starter-mongodb | MongoDB 面向文档数据库的入门指南 |
spring-boot-starter-mongodb-test | 用于测试 MongoDB 文档型数据库的 Starter |
spring-boot-starter-mustache | Mustache 入门 |
spring-boot-starter-mustache-test | 用于测试 Mustache 的 Starter |
spring-boot-starter-neo4j | Neo4j 图数据库入门工具 |
spring-boot-starter-neo4j-test | 用于测试 Neo4j 图数据库的 Starter |
spring-boot-starter-oauth2-authorization-server | 用于使用 Spring Authorization Server 功能的 Starter(已弃用,推荐使用 spring-boot-starter-security-oauth2-authorization-server) |
spring-boot-starter-oauth2-client | 用于使用 Spring Security 的 OAuth2/OpenID Connect 客户端功能的 Starter(已弃用,推荐使用 spring-boot-starter-security-oauth2-client) |
spring-boot-starter-oauth2-resource-server | 用于使用 Spring Security 的 OAuth2 资源服务器功能的 Starter(已弃用,推荐使用 spring-boot-starter-security-oauth2-resource-server) |
spring-boot-starter-opentelemetry | OpenTelemetry 入门 |
spring-boot-starter-opentelemetry-test | 用于测试 OpenTelemetry 的 Starter |
spring-boot-starter-pulsar | 用于 Apache Pulsar 的 Spring Starter |
spring-boot-starter-pulsar-test | 用于测试 Spring for Apache Pulsar 的 Starter |
spring-boot-starter-quartz | Quartz 调度器的入门示例 |
spring-boot-starter-quartz-test | 用于测试 Quartz 调度器的启动器 |
spring-boot-starter-r2dbc | R2DBC 使用入门 |
spring-boot-starter-r2dbc-test | 用于测试 R2DBC 的 Starter |
spring-boot-starter-reactor-netty | Reactor Netty 的 Starter |
spring-boot-starter-restclient | 使用 Spring 的阻塞式 HTTP 客户端(RestClient、RestTemplate 和 HTTP Service Clients)的 Starter |
spring-boot-starter-restclient-test | 用于测试 Spring 阻塞式 HTTP 客户端(RestClient、RestTemplate 和 HTTP Service Clients)的 Starter |
spring-boot-starter-rsocket | RSocket 入门示例 |
spring-boot-starter-rsocket-test | 用于测试 RSocket 的 Starter |
spring-boot-starter-security | Spring Security 入门 |
spring-boot-starter-security-oauth2-authorization-server | 用于使用 Spring Authorization Server 功能的 Starter |
spring-boot-starter-security-oauth2-authorization-server-test | 用于测试 Spring Authorization Server 功能的 Starter |
spring-boot-starter-security-oauth2-client | 用于使用 Spring Security 的 OAuth2/OpenID Connect 客户端功能的入门示例 |
spring-boot-starter-security-oauth2-client-test | 用于测试 Spring Security 的 OAuth2/OpenID Connect 客户端功能的 Starter |
spring-boot-starter-security-oauth2-resource-server | 用于使用 Spring Security 的 OAuth2 资源服务器功能的入门示例 |
spring-boot-starter-security-oauth2-resource-server-test | 用于测试 Spring Security OAuth2 资源服务器功能的 Starter |
spring-boot-starter-security-saml2 | 使用 Spring Security 与 SAML2 的入门示例 |
spring-boot-starter-security-saml2-test | 用于测试 Spring Security 与 SAML2 的 Starter |
spring-boot-starter-security-test | 用于测试 Spring Security 的 Starter |
spring-boot-starter-sendgrid | 使用 Spring Session 与 SendGrid 的入门指南 |
spring-boot-starter-sendgrid-test | 用于测试 Spring Session 与 SendGrid 的启动器 |
spring-boot-starter-session-data-redis | 使用 Spring Session 与 Spring Data Redis 的入门示例 |
spring-boot-starter-session-data-redis-test | 用于测试 Spring Session 与 Spring Data Redis 的 Starter |
spring-boot-starter-session-jdbc | 使用 Spring Session 与 JDBC 的入门示例 |
spring-boot-starter-session-jdbc-test | 用于测试 Spring Session 与 JDBC 的 Starter |
spring-boot-starter-test | 用于测试 Spring Boot 应用程序的 Starter,包含 JUnit Jupiter、Hamcrest 和 Mockito 等库 |
spring-boot-starter-test-classic | 用于测试 Spring Boot 应用程序的经典 starter,包含 JUnit Jupiter、Hamcrest 和 Mockito 等库 |
spring-boot-starter-thymeleaf | Thymeleaf 入门 |
spring-boot-starter-thymeleaf-test | 用于测试 Thymeleaf 的 Starter |
spring-boot-starter-tomcat | 使用 Tomcat 作为嵌入式 Servlet 容器的 Starter |
spring-boot-starter-validation | 使用 Hibernate Validator 进行 Java Bean Validation 的入门示例 |
spring-boot-starter-validation-test | 用于使用 Hibernate Validator 测试 Java Bean Validation 的 Starter |
spring-boot-starter-web | 用于构建 Web 应用(包括 RESTful 应用)的 Starter,基于 Spring MVC。默认使用 Tomcat 作为内嵌容器(已弃用,推荐使用 spring-boot-starter-webmvc) |
spring-boot-starter-web-services | 用于使用 Spring Web Services 的 Starter(已弃用,推荐使用 spring-boot-starter-webservices) |
spring-boot-starter-webclient | 使用 Spring 的响应式 HTTP 客户端(WebClient 和 HTTP Service Clients)的 Starter |
spring-boot-starter-webclient-test | 用于测试 Spring 响应式 HTTP 客户端(WebClient 和 HTTP Service Clients)的 Starter |
spring-boot-starter-webflux | WebFlux 和 Reactor Netty 入门示例 |
spring-boot-starter-webflux-test | 用于测试 WebFlux 和 Reactor Netty 的 Starter |
spring-boot-starter-webmvc | Spring MVC 和 Tomcat 的入门示例 |
spring-boot-starter-webmvc-test | 用于测试 Spring MVC 和 Tomcat 的 Starter |
spring-boot-starter-webservices | Spring Web Services 入门 |
spring-boot-starter-webservices-test | 用于测试 Spring Web Services 的 Starter |
spring-boot-starter-websocket | Spring MVC WebSocket 支持的入门示例 |
spring-boot-starter-websocket-test | 用于测试 Spring MVC WebSocket 支持的 Starter |
spring-boot-starter-zipkin | Zipkin 使用入门 |
spring-boot-starter-zipkin-test | 用于测试 Zipkin 的 Starter |
除了应用程序 starters 之外,还可以使用以下 starters 来添加 生产就绪 功能:
表 2. Spring Boot 生产级 starters
最后,Spring Boot 还包含以下 starter,如果你想要排除或替换特定的技术组件,可以使用它们:
表 3. Spring Boot 技术 Starter
要了解如何更换技术组件,请参阅 更换 Web 服务器 和 日志系统 的操作指南文档。
有关更多社区贡献的 starter 列表,请参阅 GitHub 上 spring-boot-starters 模块中的 README 文件。