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!";
}
}
使用 Spring Boot 构建应用程序
本指南提供了一些示例,说明 Spring Boot 如何帮助您加速应用程序开发。在阅读更多 Spring 入门指南时,您将看到 Spring Boot 的更多用例。本指南旨在让您快速了解 Spring Boot。如果您想创建自己的基于 Spring Boot 的项目,请访问 Spring Initializr,填写您的项目详细信息,选择您的选项,然后将捆绑的项目下载为 zip 文件。
您将构建什么
您将使用 Spring Boot 构建一个简单的 Web 应用程序,并向其中添加一些有用的服务。
您需要什么
-
大约 15 分钟
-
您喜欢的文本编辑器或 IDE
-
Java 17 或更高版本
-
您也可以将代码直接导入您的 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。
-
单击依赖项并选择Spring Web。
-
单击生成。
-
下载生成的 ZIP 文件,该文件是使用您的选择配置的 Web 应用程序的存档。
如果您的 IDE 集成了 Spring Initializr,则可以在 IDE 中完成此过程。 |
您也可以从 Github 分叉项目并在您的 IDE 或其他编辑器中打开它。 |
对于 Spring 3.0,无论您是否使用 Spring Initializr,您都需要 Java 17 或更高版本。 |
创建简单的 Web 应用程序
现在,您可以为简单的 Web 应用程序创建一个 Web 控制器,如下面的列表(来自 src/main/java/com/example/springboot/HelloController.java
)所示
该类被标记为 @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,您无需处理配置任何管道或基础设施。
还有一个 CommandLineRunner
方法标记为 @Bean
,它在启动时运行。它检索应用程序创建或 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 https://127.0.0.1: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,允许您通过一组方便的构建器类将 HTTP 请求发送到 DispatcherServlet
并对结果进行断言。请注意 @AutoConfigureMockMvc
和 @SpringBootTest
的使用,以注入 MockMvc
实例。使用 @SpringBootTest
后,我们要求创建整个应用程序上下文。另一种方法是要求 Spring Boot 仅创建上下文的 Web 层,方法是使用 @WebMvcTest
。无论哪种情况,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 通过其 执行器模块 提供了几种此类服务(如健康、审计、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/shutdown 端点,但默认情况下,它只能通过 JMX 访问。要将其启用为 HTTP 端点,请将management.endpoint.shutdown.enabled=true 添加到您的application.properties 文件中,并使用management.endpoints.web.exposure.include=health,info,shutdown 公开它。但是,您可能不应该为公开可用的应用程序启用关闭端点。 |
您可以通过运行以下命令来检查应用程序的健康状况
$ curl https://127.0.0.1:8080/actuator/health
{"status":"UP"}
您还可以尝试通过 curl 调用关闭操作,以查看在未将必要的行(如前面注释中所示)添加到application.properties
时会发生什么。
$ curl -X POST https://127.0.0.1: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 的在线文档以获取更多信息。