所有指南

使用 Spring Boot 构建应用程序

本指南展示了 Spring Boot 如何帮助您加速应用程序开发。随着您阅读更多 Spring 入门指南，您将看到更多 Spring Boot 的用例。本指南旨在让您快速体验 Spring Boot。如果您想创建自己的基于 Spring Boot 的项目，请访问 Spring Initializr，填写您的项目详细信息，选择您的选项，然后下载一个打包好的项目作为 zip 文件。

您将构建什么

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

你需要什么

如何完成本指南

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

要从头开始，请转到从 Spring Initializr 开始。

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

完成后，您可以将您的结果与 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 文件。此项目已配置为符合本教程中的示例。

手动初始化项目

  1. 导航到 https://start.spring.io。此服务会为您拉取应用程序所需的所有依赖项，并为您完成大部分设置。

  2. 选择 Gradle 或 Maven 以及您想要使用的语言。

  3. 点击 Dependencies 并选择 Spring Web。

  4. 单击生成。

  5. 下载生成的 ZIP 文件，这是一个已根据您的选择配置好的 Web 应用程序存档。

如果您的 IDE 集成了 Spring Initializr，您可以从 IDE 中完成此过程。
您还可以从 GitHub fork 项目，并在您的 IDE 或其他编辑器中打开它。

创建简单的 Web 应用程序

现在您可以为简单的 Web 应用程序创建一个 Web 控制器，如以下清单所示

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!";
	}

}
Kotlin
package com.example.springboot

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

@RestController
class HelloController {
    @GetMapping("/")
    fun index(): String = "Greetings from Spring Boot!"
}

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

创建应用程序类

Spring Initializr 为您创建了一个简单的应用程序类。但是，在这种情况下，它过于简单。您需要修改应用程序类以匹配以下清单

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);
			}

		};
	}

}
Kotlin
package com.example.springboot

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

@SpringBootApplication
class Application {

    @Bean
    fun commandLineRunner(ctx: ApplicationContext) = CommandLineRunner {
        println("Let's inspect the beans provided by Spring Boot:")
        val beanNames = ctx.beanDefinitionNames
        beanNames.sorted().forEach { println(it) }
    }
}

fun main(args: Array<String>) {
    runApplication<Application>(*args)
}

@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。它对它们进行排序并打印出来。

运行应用程序

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

./gradlew bootRun

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

./mvnw spring-boot:run

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

Let's inspect the beans provided by Spring Boot:
application
applicationAvailability
applicationTaskExecutor
applicationTaskExecutorAsyncConfigurer
basicErrorController
beanNameHandlerMapping
beanNameViewResolver
...

您可以看到 org.springframework.boot.autoconfigure bean。还有一个 tomcatServletWebServerFactory。

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

$ curl https://:8080
Greetings from Spring Boot!

添加单元测试

您将希望为您添加的端点添加测试，Spring Test 为此提供了一些机制。

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

Groovy
testImplementation('org.springframework.boot:spring-boot-starter-test')
Kotlin
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 请求和响应，如以下清单所示

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!")));
	}
}
Kotlin
package com.example.springboot

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.get

@SpringBootTest
@AutoConfigureMockMvc
class HelloControllerTest {

    @Autowired
    private lateinit var mvc: MockMvc

    @Test
    fun getHello() {
        mvc.get("/") {
            accept(MediaType.APPLICATION_JSON)
        }.andExpect {
            status { isOk() }
            content { string("Greetings from Spring Boot!") }
        }
    }
}

MockMvc 来自 Spring Test，它允许您通过一组方便的构建器类将 HTTP 请求发送到 DispatcherServlet 并对结果进行断言。请注意使用 @AutoConfigureMockMvc 和 @SpringBootTest 注入 MockMvc 实例。使用 @SpringBootTest 后，我们要求创建整个应用程序上下文。另一种方法是使用 @WebMvcTest 让 Spring Boot 只创建上下文的 Web 层。在这两种情况下，Spring Boot 都会自动尝试定位应用程序的主要应用程序类，但如果您想构建不同的东西，可以覆盖它或缩小范围。

除了模拟 HTTP 请求周期之外，您还可以使用 Spring Boot 编写一个简单的全栈集成测试。例如，除了（或同时）前面显示的模拟测试之外，我们可以创建以下测试

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!");
    }
}
Kotlin
package com.example.springboot

import org.assertj.core.api.Assertions.assertThat
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.boot.test.web.client.getForEntity

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

    @Autowired
    private lateinit var template: TestRestTemplate

    @Test
    fun getHello() {
        val response = template.getForEntity<String>("/")
        assertThat(response.body).isEqualTo("Greetings from Spring Boot!")
    }
}

嵌入式服务器在随机端口上启动，因为 webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT，并且实际端口在 TestRestTemplate 的基本 URL 中自动配置。

添加生产级服务

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

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

Groovy
implementation 'org.springframework.boot:spring-boot-starter-actuator'
Kotlin
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，请在终端窗口中运行以下命令

./gradlew bootRun

如果您使用 Maven，请在终端窗口中运行以下命令

./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/shutdown 端点，但默认情况下，它只能通过 JMX 可见。要将其作为 HTTP 端点启用，请将 management.endpoint.shutdown.enabled=true 添加到您的 application.properties 文件中，并通过 management.endpoints.web.exposure.include=health,info,shutdown 暴露它。但是，您可能不应为公开可用的应用程序启用 shutdown 端点。

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

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

您还可以尝试通过 curl 调用 shutdown，以查看当您未将必要的行（如前面的注释所示）添加到 application.properties 时会发生什么

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

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

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

查看 Spring Boot 的启动器

您已经看到了一些 Spring Boot 的“启动器”。您可以在此处查看所有启动器。

JAR 支持

最后一个示例展示了 Spring Boot 如何让您连接您可能不知道需要的 bean。它还展示了如何开启方便的管理服务。

但是，Spring Boot 不仅仅如此。得益于 Spring Boot 的 loader 模块，它不仅支持传统的 WAR 文件部署，还允许您组合可执行 JAR。各种指南通过 spring-boot-gradle-plugin 和 spring-boot-maven-plugin 展示了这种双重支持。

总结

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

另请参阅

以下指南也可能有所帮助

想写新指南或为现有指南做贡献吗？请查看我们的贡献指南。

所有指南的代码均采用 ASLv2 许可，文字内容采用署名-禁止演绎知识共享许可。

获取代码

前往仓库

免费

在云端工作

在 Spring Academy 的云端完成本指南。

前往 Spring Academy