使用 Spring Boot 构建应用程序 - springboot guide中文文档

本指南简要介绍了Spring Boot如何帮助您加速应用程序开发。当您阅读更多 Spring 入门指南时，您将会看到 Spring Boot 的更多应用场景。本指南旨在让您快速体验 Spring Boot。如果您想创建自己的基于 Spring Boot 的项目，请访问Spring Initializr，填写项目详细信息，选择您的选项，并下载打包好的项目 zip 文件。

您将构建什么

您将使用 Spring Boot 构建一个简单的 Web 应用程序，并为其添加一些有用的服务。

所需条件

大约15分钟
一个喜欢的文本编辑器或集成开发环境
Java 17 或更高版本
Gradle 7.5+ 或 Maven 3.5+
您也可以直接将代码导入到您的 IDE 中：

如何完成本指南

与大多数 Spring 入门指南一样，您可以从头开始，完成每个步骤，或者跳过您已经熟悉的基本设置步骤。无论哪种方式，您最终都会得到可运行的代码。

要从头开始，请继续阅读从 Spring Initializr 开始。

要跳过基础知识，请执行以下操作：

下载并解压本指南的源码仓库，或使用 Git 克隆：git clone https://github.com/spring-guides/gs-spring-boot.git
进入 gs-spring-boot/initial 目录
跳转到创建一个简单的 Web 应用程序。

当您完成后，您可以对照 gs-spring-boot/complete 中的代码检查您的结果。

了解您可以使用 Spring Boot 做什么

Spring Boot 提供了一种快速构建应用程序的方式。它会检查您的类路径和已配置的 bean，对您可能缺少的内容做出合理的假设，并自动添加这些项目。使用 Spring Boot，您可以更专注于业务功能，而减少对基础设施的关注。

以下示例展示了 Spring Boot 能为您做些什么：

类路径上是否有 Spring MVC？几乎总是需要一些特定的 bean，Spring Boot 会自动添加它们。Spring MVC 应用程序还需要一个 servlet 容器，因此 Spring Boot 会自动配置嵌入式 Tomcat。
类路径上是否有 Jetty？如果是这样，您可能不想要 Tomcat，而是想要嵌入式 Jetty。Spring Boot 会为您处理。
类路径上是否有 Thymeleaf？如果是这样，有一些 bean 必须始终添加到您的应用程序上下文中。Spring Boot 会为您添加它们。

这些只是 Spring Boot 提供的自动配置的少数示例。与此同时，Spring Boot 并不会妨碍您的操作。例如，如果 Thymeleaf 在您的路径中，Spring Boot 会自动将 SpringTemplateEngine 添加到您的应用程序上下文中。但如果您使用自己的设置定义了自己的 SpringTemplateEngine，Spring Boot 就不会再添加一个。这使得您能够轻松掌控，几乎不需要额外努力。

Spring Boot 不会生成代码或对您的文件进行编辑。相反，当您启动应用程序时，Spring Boot 会动态地装配 bean 和设置，并将它们应用到您的应用程序上下文中。

从 Spring Initializr 开始

您可以使用这个预初始化项目并点击生成以下载一个 ZIP 文件。该项目已配置为适合本教程中的示例。

要手动初始化项目：

访问 https://start.spring.io。该服务会拉取应用程序所需的所有依赖项，并为您完成大部分的设置工作。
选择 Gradle 或 Maven 以及您想要使用的语言。本指南假设您选择了 Java。
点击 Dependencies 并选择 Spring Web。
点击 Generate。
下载生成的 ZIP 文件，这是一个根据您的选择配置好的 Web 应用程序的存档。

如果您的 IDE 集成了 Spring Initializr，您可以直接在 IDE 中完成此过程。

您还可以从 Github 上 fork 该项目，并在您的 IDE 或其他编辑器中打开它。

对于 Spring 3.0，无论您是否使用 Spring Initializr，都需要 Java 17 或更高版本。

创建一个简单的 Web 应用程序

现在，您可以为一个简单的 Web 应用程序创建一个 Web 控制器，如下面的代码清单所示（来自 src/main/java/com/example/springboot/HelloController.java）：

package com.example.springboot;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @GetMapping("/")
    public String index() {
        return "Greetings from Spring Boot!";
    }

}

该类被标记为 @RestController，这意味着它已经准备好被 Spring MVC 用来处理 web 请求。@GetMapping 将 / 映射到 index() 方法。当从浏览器或命令行使用 curl 调用时，该方法返回纯文本。这是因为 @RestController 结合了 @Controller 和 @ResponseBody，这两个注解使得 web 请求返回数据而不是视图。

创建一个应用程序类

Spring Initializr 为您创建了一个简单的应用程序类。然而，在这种情况下，它过于简单了。您需要修改应用程序类以匹配以下代码清单（来自 src/main/java/com/example/springboot/Application.java）：

package com.example.springboot;

import java.util.Arrays;

import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

    @Bean
    public CommandLineRunner commandLineRunner(ApplicationContext ctx) {
        return args -> {

            System.out.println("Let's inspect the beans provided by Spring Boot:");

            String[] beanNames = ctx.getBeanDefinitionNames();
            Arrays.sort(beanNames);
            for (String beanName : beanNames) {
                System.out.println(beanName);
            }

        };
    }

}

@SpringBootApplication 是一个便捷的注解，它包含了以下所有内容：

@Configuration: 将该类标记为应用上下文的bean定义来源。
@EnableAutoConfiguration: 告诉Spring Boot根据类路径设置、其他bean和各种属性设置开始添加bean。例如，如果spring-webmvc在类路径上，此注解会将应用程序标记为Web应用程序，并激活关键行为，例如设置DispatcherServlet。
@ComponentScan: 告诉Spring在com/example包中查找其他组件、配置和服务，使其能够找到控制器。

main() 方法使用 Spring Boot 的 SpringApplication.run() 方法来启动应用程序。您是否注意到没有一行 XML 代码？也没有 web.xml 文件。这个 Web 应用程序是 100% 纯 Java 的，您无需处理任何配置管道或基础设施。

还有一个标记为 @Bean 的 CommandLineRunner 方法，它会在启动时运行。它检索由您的应用程序创建或由 Spring Boot 自动添加的所有 bean，对它们进行排序并打印出来。

运行应用程序

要运行应用程序，请在终端窗口中（在 complete 目录下）运行以下命令：

./gradlew bootRun

如果您使用 Maven，请在终端窗口中（在 complete 目录下）运行以下命令：

./mvnw spring-boot:run

您应该会看到类似以下的输出：

Let's inspect the beans provided by Spring Boot:
application
beanNameHandlerMapping
defaultServletHandlerMapping
dispatcherServlet
embeddedServletContainerCustomizerBeanPostProcessor
handlerExceptionResolver
helloController
httpRequestHandlerAdapter
messageSource
mvcContentNegotiationManager
mvcConversionService
mvcValidator
org.springframework.boot.autoconfigure.MessageSourceAutoConfiguration
org.springframework.boot.autoconfigure.PropertyPlaceholderAutoConfiguration
org.springframework.boot.autoconfigure.web.EmbeddedServletContainerAutoConfiguration
org.springframework.boot.autoconfigure.web.EmbeddedServletContainerAutoConfiguration$DispatcherServletConfiguration
org.springframework.boot.autoconfigure.web.EmbeddedServletContainerAutoConfiguration$EmbeddedTomcat
org.springframework.boot.autoconfigure.web.ServerPropertiesAutoConfiguration
org.springframework.boot.context.embedded.properties.ServerProperties
org.springframework.context.annotation.ConfigurationClassPostProcessor.enhancedConfigurationProcessor
org.springframework.context.annotation.ConfigurationClassPostProcessor.importAwareProcessor
org.springframework.context.annotation.internalAutowiredAnnotationProcessor
org.springframework.context.annotation.internalCommonAnnotationProcessor
org.springframework.context.annotation.internalConfigurationAnnotationProcessor
org.springframework.context.annotation.internalRequiredAnnotationProcessor
org.springframework.web.servlet.config.annotation.DelegatingWebMvcConfiguration
propertySourcesBinder
propertySourcesPlaceholderConfigurer
requestMappingHandlerAdapter
requestMappingHandlerMapping
resourceHandlerMapping
simpleControllerHandlerAdapter
tomcatEmbeddedServletContainerFactory
viewControllerHandlerMapping

您可以清楚地看到 org.springframework.boot.autoconfigure 的 bean。此外还有一个 tomcatEmbeddedServletContainerFactory。

现在通过运行以下命令（显示其输出）来使用 curl 启动服务（在一个单独的终端窗口中）：

$ curl http://localhost:8080
Greetings from Spring Boot!

添加单元测试

您可能希望为您添加的端点添加一个测试，而 Spring Test 为此提供了一些工具。

如果您使用 Gradle，请将以下依赖项添加到您的 build.gradle 文件中：

testImplementation('org.springframework.boot:spring-boot-starter-test')

如果您使用的是 Maven，请将以下内容添加到您的 pom.xml 文件中：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>

现在编写一个简单的单元测试，通过您的端点模拟 servlet 请求和响应，如以下清单（来自 src/test/java/com/example/springboot/HelloControllerTest.java）所示：

package com.example.springboot;

import static org.hamcrest.Matchers.equalTo;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.MediaType;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;

@SpringBootTest
@AutoConfigureMockMvc
public class HelloControllerTest {

    @Autowired
    private MockMvc mvc;

    @Test
    public void getHello() throws Exception {
        mvc.perform(MockMvcRequestBuilders.get("/").accept(MediaType.APPLICATION_JSON))
                .andExpect(status().isOk())
                .andExpect(content().string(equalTo("Greetings from Spring Boot!")));
    }
}

MockMvc 源自 Spring Test，它允许你通过一系列方便的构建器类向 DispatcherServlet 发送 HTTP 请求，并对结果进行断言。请注意使用了 @AutoConfigureMockMvc 和 @SpringBootTest 来注入 MockMvc 实例。通过使用 @SpringBootTest，我们要求创建整个应用程序上下文。另一种选择是使用 @WebMvcTest，让 Spring Boot 仅创建上下文的 Web 层。无论是哪种情况，Spring Boot 都会自动尝试定位应用程序的主应用类，但如果你想构建不同的内容，你可以覆盖它或缩小范围。

除了模拟 HTTP 请求周期外，您还可以使用 Spring Boot 编写一个简单的全栈集成测试。例如，我们可以创建以下测试（来自 src/test/java/com/example/springboot/HelloControllerITest.java），而不是（或同时使用）前面展示的模拟测试：

package com.example.springboot;

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.web.client.TestRestTemplate;
import org.springframework.http.ResponseEntity;

import static org.assertj.core.api.Assertions.assertThat;

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class HelloControllerITest {

    @Autowired
    private TestRestTemplate template;

    @Test
    public void getHello() throws Exception {
        ResponseEntity<String> response = template.getForEntity("/", String.class);
        assertThat(response.getBody()).isEqualTo("Greetings from Spring Boot!");
    }
}

由于 webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT，嵌入式服务器会在一个随机端口上启动，并且实际端口会自动配置在 TestRestTemplate 的基础 URL 中。

添加生产级服务

如果您正在为您的企业构建一个网站，您可能需要添加一些管理服务。Spring Boot 通过其 actuator 模块提供了多种此类服务（如健康检查、审计、bean 信息等）。

如果您使用 Gradle，请在您的 build.gradle 文件中添加以下依赖项：

implementation 'org.springframework.boot:spring-boot-starter-actuator'

如果您使用 Maven，请将以下依赖项添加到您的 pom.xml 文件中：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

然后重新启动应用程序。如果您使用 Gradle，请在终端窗口中运行以下命令（在 complete 目录下）：

./gradlew bootRun

如果您使用 Maven，请在终端窗口中运行以下命令（在 complete 目录下）：

./mvnw spring-boot:run

您应该会看到一组新的 RESTful 端点已添加到应用程序中。这些是由 Spring Boot 提供的管理服务。以下列表展示了典型的输出：

management.endpoint.configprops-org.springframework.boot.actuate.autoconfigure.context.properties.ConfigurationPropertiesReportEndpointProperties
management.endpoint.env-org.springframework.boot.actuate.autoconfigure.env.EnvironmentEndpointProperties
management.endpoint.health-org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties
management.endpoint.logfile-org.springframework.boot.actuate.autoconfigure.logging.LogFileWebEndpointProperties
management.endpoints.jmx-org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties
management.endpoints.web-org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties
management.endpoints.web.cors-org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties
management.health.diskspace-org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties
management.info-org.springframework.boot.actuate.autoconfigure.info.InfoContributorProperties
management.metrics-org.springframework.boot.actuate.autoconfigure.metrics.MetricsProperties
management.metrics.export.simple-org.springframework.boot.actuate.autoconfigure.metrics.export.simple.SimpleProperties
management.server-org.springframework.boot.actuate.autoconfigure.web.server.ManagementServerProperties

Actuator 暴露了以下内容：

此外，还有一个 /actuator/shutdown 端点，但默认情况下，它仅通过 JMX 可见。要将其启用为 HTTP 端点，请在 application.properties 文件中添加 management.endpoint.shutdown.enabled=true，并通过 management.endpoints.web.exposure.include=health,info,shutdown 将其暴露出来。然而，您可能不应该为公开可用的应用程序启用关闭端点。

您可以通过运行以下命令来检查应用程序的健康状况：

$ curl http://localhost:8080/actuator/health
{"status":"UP"}

您也可以尝试通过 curl 调用 shutdown，看看当您没有在 application.properties 中添加必要行（如前文所示）时会发生什么：

$ curl -X POST http://localhost:8080/actuator/shutdown
{"timestamp":1401820343710,"error":"Not Found","status":404,"message":"","path":"/actuator/shutdown"}

因为我们没有启用它，所以请求的端点不可用（因为该端点不存在）。

有关这些 REST 端点的更多详细信息以及如何使用 application.properties 文件（位于 src/main/resources 中）调整它们的设置，请参阅关于端点的文档。

查看 Spring Boot 的 Starters

您已经了解了部分 Spring Boot 的“starters”。您可以在源代码中查看它们。

JAR 支持

上一个示例展示了 Spring Boot 如何让您装配可能尚未意识到需要的 bean。它还展示了如何启用便捷的管理服务。

然而，Spring Boot 的功能远不止这些。它不仅支持传统的 WAR 文件部署，还允许您打包可执行的 JAR 文件，这得益于 Spring Boot 的加载器模块。各种指南通过 spring-boot-gradle-plugin 和 spring-boot-maven-plugin 展示了这种双重支持。

总结

恭喜！您已经使用 Spring Boot 构建了一个简单的 Web 应用程序，并了解了它如何加快您的开发速度。您还启用了一些便捷的生产环境服务。这只是 Spring Boot 功能的一小部分。更多信息请参见 Spring Boot 的在线文档。

另请参阅

以下指南也可能有所帮助：