前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Spring认证指南:了解如何以最少的配置构建应用程序

Spring认证指南:了解如何以最少的配置构建应用程序

原创
作者头像
IT胶囊
发布2022-04-06 15:21:25
9420
发布2022-04-06 15:21:25
举报
文章被收录于专栏:IT技能应用

原标题:Spring认证指南|使用 Spring Boot 构建应用程序

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

你将建造什么

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

你需要什么

  • 约15分钟
  • 最喜欢的文本编辑器或 IDE
  • JDK 1.8或更高版本
  • Gradle 4+或Maven 3.2+
  • 您还可以将代码直接导入 IDE:
    • 弹簧工具套件 (STS)
    • IntelliJ IDEA

如何完成本指南

像大多数 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 会自动将 a 添加SpringTemplateEngine到您的应用程序上下文中。但是如果你SpringTemplateEngine用自己的设置定义自己的,Spring Boot 不会加一个。这使您无需付出任何努力即可控制。

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

从 Spring Initializr 开始

您可以使用这个预先初始化的项目并单击 Generate 下载 ZIP 文件。此项目配置为适合本教程中的示例。

手动初始化项目:

  1. 导航到https://start.spring.io。该服务提取应用程序所需的所有依赖项,并为您完成大部分设置。
  2. 选择 Gradle 或 Maven 以及您要使用的语言。本指南假定您选择了 Java。
  3. 单击Dependencies并选择Spring Web
  4. 单击生成
  5. 下载生成的 ZIP 文件,该文件是根据您的选择配置的 Web 应用程序的存档。

如果您的 IDE 具有 Spring Initializr 集成,您可以从您的 IDE 完成此过程。 你也可以从 Github 上 fork 项目并在你的 IDE 或其他编辑器中打开它。

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

现在您可以为简单的 Web 应用程序创建一个 Web 控制器,如以下清单(来自 src/main/java/com/example/springboot/HelloController.java)所示:

代码语言:javascript
复制
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):

代码语言:javascript
复制
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标记为 a 的方法@Bean,它在启动时运行。它检索由您的应用程序创建或由 Spring Boot 自动添加的所有 bean。它对它们进行分类并打印出来。

运行应用程序

要运行应用程序,请在终端窗口(位于complete)目录中运行以下命令:

代码语言:javascript
复制
./gradlew bootRun

complete如果您使用 Maven,请在终端窗口(位于)目录中运行以下命令:

代码语言:javascript
复制
./mvnw 弹簧启动:运行

您应该会看到类似于以下内容的输出:

代码语言:javascript
复制
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豆子。还有一个 tomcatEmbeddedServletContainerFactory。

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

代码语言:javascript
复制
$ curl localhost:8080
Greetings from Spring Boot!

添加单元测试

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

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

代码语言:javascript
复制
testImplementation('org.springframework.boot:spring-boot-starter-test')

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

代码语言:javascript
复制
<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)所示:

代码语言:javascript
复制
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并就结果进行断言。注意使用@AutoConfigureMockMvcand@SpringBootTest来注入一个MockMvc实例。使用后@SpringBootTest,我们要求创建整个应用程序上下文。另一种方法是要求 Spring Boot 使用@WebMvcTest. 在任何一种情况下,Spring Boot 都会自动尝试定位应用程序的主应用程序类,但如果您想构建不同的东西,您可以覆盖它或缩小范围。

除了模拟 HTTP 请求周期外,还可以使用 Spring Boot 编写一个简单的全栈集成测试。例如,我们可以创建以下测试(来自 ),而不是(或以及)前面显示的模拟测试 src/test/java/com/example/springboot/HelloControllerIT.java:

代码语言:javascript
复制
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 HelloControllerIT {

	@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,并且实际端口在基本 URL 中自动配置为TestRestTemplate.

添加生产级服务

如果您正在为您的企业构建网站,您可能需要添加一些管理服务。Spring Boot 通过其执行器模块提供了多种此类服务(例如健康、审计、bean 等)。

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

代码语言:javascript
复制
implementation 'org.springframework.boot:spring-boot-starter-actuator'

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

代码语言:javascript
复制
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

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

代码语言:javascript
复制
./gradlew bootRun

如果您使用 Maven,请在终端窗口(在complete目录中)中运行以下命令:

代码语言:javascript
复制
./mvnw 弹簧启动:运行

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

代码语言:javascript
复制
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. 但是,您可能不应该为公开可用的应用程序启用关闭端点。

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

代码语言:javascript
复制
$ curl localhost:8080/actuator/health
{"status":"UP"}

您也可以尝试通过 curl 调用关闭,以查看当您没有添加必要的行(如前面的注释所示)时会发生什么application.properties:

代码语言:javascript
复制
$ curl -X POST 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 的“启动器”。您可以在源代码中看到它们。

JAR 支持和 Groovy 支持

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

然而,Spring Boot 做的远不止这些。它不仅支持传统的 WAR 文件部署,还允许您将可执行的 JAR 放在一起,这要归功于 Spring Boot 的加载器模块。spring-boot-gradle-plugin各种指南通过和展示了这种双重支持spring-boot-maven-plugin。

最重要的是,Spring Boot 还支持 Groovy,让您只需一个文件即可构建 Spring MVC Web 应用程序。

创建一个名为的新文件app.groovy并将以下代码放入其中:

代码语言:javascript
复制
@RestController
class ThisWillActuallyRun {

    @GetMapping("/")
    String home() {
        return "Hello, World!"
    }

}

文件在哪里并不重要。您甚至可以在一条推文中放入这么小的应用程序!

接下来,安装 Spring Boot 的 CLI。

通过运行以下命令来运行 Groovy 应用程序:

$ spring run app.groovy复制

关闭之前的应用程序,以避免端口冲突。

从不同的终端窗口,运行以下 curl 命令(显示其输出):

代码语言:javascript
复制
$ curl localhost:8080
Hello, World!

Spring Boot 通过向代码动态添加关键注释并使用Groovy Grape拉下使应用程序运行所需的库来实现这一点。

概括

恭喜!您使用 Spring Boot 构建了一个简单的 Web 应用程序,并了解了它如何加快您的开发速度。您还打开了一些方便的制作服务。这只是 Spring Boot 可以做的一小部分。有关更多信息,请参阅Spring Boot 的在线文档。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 你将建造什么
  • 你需要什么
  • 如何完成本指南
  • 了解使用 Spring Boot 可以做什么
  • 从 Spring Initializr 开始
  • 创建一个简单的 Web 应用程序
  • 创建一个应用程序类
  • 运行应用程序
  • 添加单元测试
  • 添加生产级服务
  • 查看 Spring Boot 的 Starters
  • JAR 支持和 Groovy 支持
  • 概括
相关产品与服务
云服务器
云服务器(Cloud Virtual Machine,CVM)提供安全可靠的弹性计算服务。 您可以实时扩展或缩减计算资源,适应变化的业务需求,并只需按实际使用的资源计费。使用 CVM 可以极大降低您的软硬件采购成本,简化 IT 运维工作。
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档