# 3. 文档概述

本节提供 Spring Boot 参考文档的简要概述。它充当文档其余部分的地图。

本文档的最新副本可在[docs.spring.io/spring-boot/docs/current/reference/](https://docs.spring.io/spring-boot/docs/current/reference/)获取。

#### 3.1. 第一步

如果您正在开始使用 Spring Boot 或“Spring”，请从[以下主题](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#getting-started)开始：

* **从头开始：** [概述](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#getting-started.introducing-spring-boot)| [要求](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#getting-started.system-requirements)| [安装](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#getting-started.installing)
* **教程：** [第 1 部分](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#getting-started.first-application)| [第2部分](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#getting-started.first-application.code)
* **运行您的示例：** [第 1 部分](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#getting-started.first-application.run)| [第2部分](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#getting-started.first-application.executable-jar)

#### 3.2. 从早期版本升级

您应该始终确保正在运行[受支持](https://github.com/spring-projects/spring-boot/wiki/Supported-Versions)的 Spring Boot 版本。

根据您要升级到的版本，您可以在此处找到一些其他提示：

* **从 1.x：** [从 1.x 升级](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#upgrading.from-1x)
* **到新功能版本：** [升级到新功能版本](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#upgrading.to-feature)
* **Spring Boot CLI：** [升级 Spring Boot CLI](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#upgrading.cli)

#### 3.3. 使用 Spring Boot 进行开发

准备好真正开始使用 Spring Boot 了吗？[我们为您服务](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using)：

* **构建系统：** [Maven](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using.build-systems.maven) | [Gradle](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using.build-systems.gradle)| [Ant](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using.build-systems.ant)| [Starters](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using.build-systems.starters)
* **最佳实践：** [代码结构](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using.structuring-your-code)| [@配置](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using.configuration-classes)| [@EnableAutoConfiguration](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using.auto-configuration) | [Bean 和依赖注入](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using.spring-beans-and-dependency-injection)
* **运行您的代码：** [IDE](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using.running-your-application.from-an-ide) | [包装](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using.running-your-application.as-a-packaged-application)| [Maven](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using.running-your-application.with-the-maven-plugin) | [gradle](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using.running-your-application.with-the-gradle-plugin)
* **打包您的应用程序：** [生产 jar](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using.packaging-for-production)
* **Spring Boot CLI：** [使用 CLI](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#cli)

#### 3.4. 了解 Spring Boot 功能

需要有关 Spring Boot 核心功能的更多详细信息？ [以下内容适合您](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#features)：

* **弹簧应用程序：** [SpringApplication](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#features.spring-application)
* **外部配置：** [外部配置](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#features.external-config)
* **Profiles：** [Profiles](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#features.profiles)
* **日志记录：** [日志记录](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#features.logging)

#### 3.5. 网络

如果您开发Spring Boot Web应用程序，请看一下以下内容：

* **Servlet Web 应用程序：** [Spring MVC、Jersey、嵌入式 Servlet 容器](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#web.servlet)
* **反应式 Web 应用程序：** [Spring Webflux、嵌入式 Servlet 容器](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#web.reactive)
* **优雅关机：** [优雅关机](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#web.graceful-shutdown)
* **Spring Security：** [默认安全配置、OAuth2、SAML 自动配置](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#web.security)
* **Spring Session：** [Spring Session的自动配置](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#web.spring-session)
* **Spring HATEOAS：** [Spring HATEOAS 自动配置](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#web.spring-hateoas)

#### 3.6. 数据

如果您的应用程序处理数据存储，您可以在此处查看如何配置它：

* **SQL：** [配置 SQL 数据存储、嵌入式数据库支持、连接池等。](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#data.sql)
* **NOSQL：** [自动配置 NOSQL 存储，例如 Redis、MongoDB、Neo4j 等。](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#data.nosql)

#### 3.7. 消息传递

如果您的应用程序使用任何消息传递协议，请参阅以下一个或多个部分：

* **JMS：** [ActiveMQ和Artemis的自动配置，通过JMS发送和接收消息](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#messaging.jms)
* **AMQP：** [RabbitMQ 自动配置](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#messaging.amqp)
* **Kafka：** [Spring Kafka 自动配置](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#messaging.kafka)
* **Pulsar：** [Spring for Apache Pulsar 的自动配置](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#messaging.pulsar)
* **RSocket：** [Spring 框架 RSocket 支持的自动配置](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#messaging.rsocket)
* **Spring Integration：** [Spring Integration 的自动配置](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#messaging.spring-integration)

#### 3.8. IO

如果您的应用程序需要 IO 功能，请参阅以下一个或多个部分：

* **缓存：** [EhCache、Hazelcast、Infinispan 等的缓存支持](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#io.caching)
* **Quartz：** [Quartz调度](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#io.quartz)
* **邮件：** [发送电子邮件](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#io.email)
* **验证：** [JSR-303 验证](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#io.validation)
* **REST 客户端：** [使用 RestTemplate 和 WebClient 调用 REST 服务](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#io.rest-client)
* **Webservices：** [Spring Web 服务的自动配置](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#io.webservices)
* **JTA：** [使用 JTA 进行分布式事务](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#io.jta)

#### 3.9. 容器镜像

Spring Boot 为构建高效的容器镜像提供一流的支持。你可以在这里读更多关于它的内容：

* **高效容器镜像：** [优化 Docker 镜像等容器镜像的技巧](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#container-images.efficient-images)
* **Dockerfiles：** [使用 dockerfiles 构建容器镜像](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#container-images.dockerfiles)
* **云原生构建包：** [使用 Maven 和 Gradle 支持云原生构建包](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#container-images.buildpacks)

#### 3.10. 转向生产

当您准备好将 Spring Boot 应用程序推向生产环境时，我们有[一些](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#actuator)您可能会喜欢的技巧：

* **管理端点：** [概述](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#actuator.endpoints)
* **连接选项：** [HTTP](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#actuator.monitoring) | [JMX](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#actuator.jmx)
* **监控：** [指标](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#actuator.metrics)| [审计](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#actuator.auditing)| [HTTP 交换](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#actuator.http-exchanges)| [过程](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#actuator.process-monitoring)

#### 3.11. GraalVM 本机镜像

Spring Boot 应用程序可以使用 GraalVM 转换为本机可执行文件。您可以在此处阅读有关我们的本机图像支持的更多信息：

* **GraalVM 本机映像：** [简介](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#native-image.introducing-graalvm-native-images)| [与 JVM 的主要区别](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#native-image.introducing-graalvm-native-images.key-differences-with-jvm-deployments)| [提前处理](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#native-image.introducing-graalvm-native-images.understanding-aot-processing)
* **入门：** [构建包](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#native-image.developing-your-first-application.buildpacks)| [本机构建工具](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#native-image.developing-your-first-application.native-build-tools)
* **测试：** [JVM](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#native-image.testing.with-the-jvm) | [本机构建工具](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#native-image.testing.with-native-build-tools)
* **高级主题：** [嵌套配置属性](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#native-image.advanced.nested-configuration-properties)| [转换 JAR](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#native-image.advanced.converting-executable-jars) | [已知限制](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#native-image.advanced.known-limitations)

#### 3.12. 高级主题

最后，我们为更高级的用户提供了一些主题：

* **Spring Boot 应用程序部署：** [云部署](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#deployment.cloud)| [操作系统服务](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#deployment.installing)
* **构建工具插件：** [Maven](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#build-tool-plugins.maven) | [Gradle](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#build-tool-plugins.gradle)
* **附录：** [应用程序属性](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#appendix.application-properties)| [配置元数据](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#appendix.configuration-metadata)| [自动配置类](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#appendix.auto-configuration-classes)| [测试自动配置注释](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#appendix.test-auto-configuration)| [可执行jar包](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#appendix.executable-jar)| [依赖版本](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#appendix.dependency-versions)
