= Spring Boot image:https://github.com/spring-projects/spring-boot/actions/workflows/build-and-deploy-snapshot.yml/badge.svg?branch=main["构建状态", link="https://github.com/spring-projects/spring-boot/actions/workflows/build-and-deploy-snapshot.yml?query=branch%3Amain"] image:https://badges.gitter.im/Join Chat.svg["聊天",link="https://gitter.im/spring-projects/spring-boot?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"] image:https://img.shields.io/badge/Revved%20up%20by-Develocity-06A0CE?logo=Gradle&labelColor=02303A["由Develocity提供支持", link="https://ge.spring.io/scans?&search.rootProjectNames=Spring%20Boot%20Build&search.rootProjectNames=spring-boot-build"]
:docs: https://docs.spring.io/spring-boot :github: https://github.com/spring-projects/spring-boot
Spring Boot帮助您以最小的麻烦创建基于Spring的生产级应用程序和服务。它对Spring平台采取了固有的观点,使新用户和现有用户能够快速获得所需的部分。
您可以使用Spring Boot创建可以通过java -jar
启动的独立Java应用程序,或更传统的WAR部署。我们还提供了一个运行Spring脚本的命令行工具。
我们的主要目标是:
- 为所有Spring开发提供一个极快且广泛可访问的入门体验。
- 有自己的观点,但当需求开始偏离默认值时,迅速让路。
- 提供大类项目常见的一系列非功能特性(例如,嵌入式服务器、安全、指标、健康检查、外部化配置)。
- 绝对不生成代码,也不需要XML配置。
== 安装和入门
{docs}[参考文档]包含详细的{docs}/installing.html[安装说明]以及全面的{docs}/tutorial/first-application/index.html[入门
]指南。
以下是一个完整的Spring Boot应用程序在Java中的快速示例:
[source,java]
import org.springframework.boot.; import org.springframework.boot.autoconfigure.; import org.springframework.web.bind.annotation.*;
@RestController @SpringBootApplication public class Example {
@RequestMapping("/")
String home() {
return "Hello World!";
}
public static void main(String[] args) {
SpringApplication.run(Example.class, args);
}
}
== 获取帮助
您在使用Spring Boot时遇到问题了吗?我们想帮助您!
- 查看{docs}/[参考文档],特别是{docs}/how-to/index.html[操作指南] -- 它们为最常见的问题提供解决方案。
- 学习Spring基础知识 -- Spring Boot建立在许多其他Spring项目之上;查看https://spring.io[spring.io]网站获取大量参考文档。如果您是Spring新手,请尝试一下https://spring.io/guides[指南]。
- 如果您正在升级,请阅读{github}/wiki[发布说明]以获取升级说明和"新功能和值得注意的"特性。
- 提问 -- 我们监控https://stackoverflow.com[stackoverflow.com]上标记为https://stackoverflow.com/tags/spring-boot[`spring-boot`]的问题。您也可以在https://gitter.im/spring-projects/spring-boot[Gitter]上与社区交流。
- 在{github}/issues[github.com/spring-projects/spring-boot/issues]上报告Spring Boot的错误。
== 报告问题
Spring Boot使用GitHub的集成问题追踪系统来记录错误和功能请求。如果您想提出问题,请遵循以下建议:
- 在记录错误之前,请搜索{github}/issues[问题追踪器],看看是否有人已经报告了该问题。
- 如果该问题尚不存在,{github}/issues/new[创建一个新问题]。
- 请在问题报告中提供尽可能多的信息。我们想知道您使用的Spring Boot版本、操作系统和JVM版本。
- 如果您需要粘贴代码或包含堆栈跟踪,请使用Markdown。在文本前后使用+++```+++。
- 如果可能,请尝试创建一个重现问题的测试用例或项目,并将其附加到问题中。
== 从源代码构建
您不需要从源代码构建来使用Spring Boot(二进制文件在https://repo.spring.io[repo.spring.io]),但如果您想尝试最新和最棒的功能,可以使用https://docs.gradle.org/current/userguide/gradle_wrapper.html[Gradle wrapper]将Spring Boot构建并发布到本地Maven缓存中。您还需要JDK 17。
[source,shell]
$ ./gradlew publishToMavenLocal
这将构建所有jar包和文档,并将它们发布到您的本地Maven缓存中。它不会运行任何测试。如果您想构建所有内容,请使用build
任务:
[source,shell]
$ ./gradlew build
== 模块
Spring Boot有几个模块。以下是一个快速概览:
=== spring-boot
提供支持Spring Boot其他部分的功能的主要库。这些功能包括:
SpringApplication
类,提供静态便利方法,可用于编写独立的Spring应用程序。它的唯一工作是创建和刷新适当的SpringApplicationContext
。- 嵌入式Web应用程序,可选择容器(Tomcat、Jetty或Undertow)。
- 一流的外部化配置支持。
- 便捷的
ApplicationContext
初始化器,包括对合理的日志默认值的支持。
=== spring-boot-autoconfigure
Spring Boot可以根据类路径的内容配置大部分典型应用程序。单个@EnableAutoConfiguration
注解触发Spring上下文的自动配置。
自动配置尝试推断用户可能需要的bean。例如,如果类路径上有HSQLDB
,并且用户没有配置任何数据库连接,那么他们可能想要定义一个内存数据库。当用户开始定义自己的bean时,自动配置总是会退让。
=== spring-boot-starters
Starters是一组方便的依赖描述符,您可以将其包含在应用程序中。您可以一站式获得所有需要的Spring和相关技术,而无需通过示例代码搜索和复制粘贴大量依赖描述符。例如,如果您想开始使用Spring和JPA进行数据库访问,只需在项目中包含spring-boot-starter-data-jpa
依赖项,您就可以开始了。
=== spring-boot-actuator
Actuator端点让您监控和与应用程序交互。Spring Boot Actuator提供了actuator端点所需的基础设施。它包含对actuator端点的注解支持。该模块提供了许多端点,包括HealthEndpoint
、EnvironmentEndpoint
、BeansEndpoint
等。
=== spring-boot-actuator-autoconfigure
这为actuator端点提供了基于类路径内容和一组属性的自动配置。例如,如果类路径上有Micrometer,它将自动配置MetricsEndpoint
。它包含通过HTTP或JMX公开端点的配置。就像Spring Boot AutoConfigure一样,当用户开始定义自己的bean时,这也会退让。
=== spring-boot-test
此模块包含在测试应用程序时可能有用的核心项目和注解。
=== spring-boot-test-autoconfigure
像其他Spring Boot自动配置模块一样,spring-boot-test-autoconfigure基于类路径为测试提供自动配置。它包含许多可以自动配置需要测试的应用程序部分的注解。
=== spring-boot-loader
Spring Boot Loader提供了秘诀,允许您构建一个可以使用java -jar
启动的单个jar文件。通常,您不需要直接使用spring-boot-loader
,而是使用link:spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin[Gradle]或link:spring-boot-project/spring-boot-tools/spring-boot-maven-plugin[Maven]插件。
=== spring-boot-devtools
spring-boot-devtools模块提供了额外的开发时功能,如自动重启,以获得更流畅的应用程序开发体验。在运行完全打包的应用程序时,开发者工具会自动禁用。
== 指南
https://spring.io/[spring.io]网站包含几个指南,逐步展示如何使用Spring Boot:
- https://spring.io/guides/gs/spring-boot/[使用Spring Boot构建应用程序]是一个入门指南,向您展示如何创建应用程序、运行它并添加一些管理服务。
- https://spring.io/guides/gs/actuator-service/[使用Spring Boot Actuator构建RESTful Web服务]是一个创建REST Web服务的指南,还展示了如何配置服务器。
- https://spring.io/guides/gs/convert-jar-to-war/[将Spring Boot JAR应用程序转换为WAR]向您展示如何在Web服务器中将应用程序作为WAR文件运行。
== 许可证
Spring Boot是根据https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0许可证]发布的开源软件。