# 测试Web层
本指南将引导您完成创建Spring应用程序，然后使用JUnit对其进行测试的过程。
## 你会建立什么
您将构建一个简单的Spring应用程序，并使用JUnit对其进行测试。 您可能已经知道如何编写和运行应用程序中各个类的单元测试，因此，对于本指南，我们将专注于使用Spring Test和Spring Boot功能来测试Spring和您的代码之间的交互。 您将从一个简单的测试开始，该测试将应用程序上下文成功加载，然后继续使用Spring的测试仅测试Web层。 `MockMvc`.
## 你需要什么
* 约15分钟
* 最喜欢的文本编辑器或IDE
* [JDK 1.8](http://www.oracle.com/technetwork/java/javase/downloads/index.html) 或更高版本
* [Gradle 4+](http://www.gradle.org/downloads) 或 [Maven 3.2+](https://maven.apache.org/download.cgi)
* 您还可以将代码直接导入到IDE中：
* [弹簧工具套件（STS）](https://spring.io/guides/gs/sts)
* [IntelliJ IDEA](https://spring.io/guides/gs/intellij-idea/)
## 如何完成本指南
像大多数Spring 一样 [入门指南](https://spring.io/guides) ，您可以从头开始并完成每个步骤，也可以绕过您已经熟悉的基本设置步骤。 无论哪种方式，您最终都可以使用代码。
要 **从头开始** ，请继续进行“ [从Spring Initializr开始”](https://spring.io/guides/gs/testing-web/#scratch) 。
要 **跳过基础知识** ，请执行以下操作：
* [下载](https://github.com/spring-guides/gs-testing-web/archive/master.zip) 并解压缩本指南的源存储库，或使用 对其进行克隆 [Git](https://spring.io/understanding/Git) ： `git clone [https://github.com/spring-guides/gs-testing-web.git](https://github.com/spring-guides/gs-testing-web.git)`
* 光盘进入 `gs-testing-web/initial`
* 继续 [创建一个简单的应用程序](https://spring.io/guides/gs/testing-web/#initial) 。
**完成后** ，您可以根据中的代码检查结果 `gs-testing-web/complete`.
## 从Spring Initializr开始
如果您使用Maven，请访问 [Spring Initializr](https://start.spring.io/#!type=maven-project&language=java&platformVersion=2.4.4.RELEASE&packaging=jar&jvmVersion=1.8&groupId=com.example&artifactId=testing-web&name=testing-web&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.testing-web&dependencies=web) 以生成具有所需依赖项的新项目（Spring Web）。
以下清单显示了 `pom.xml` 选择Maven时创建的文件：
~~~
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.4.4</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.example</groupId>
<artifactId>testing-web</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>testing-web</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
~~~
如果使用Gradle，请访问 [Spring Initializr](https://start.spring.io/#!type=gradle-project&language=java&platformVersion=2.4.4.RELEASE&packaging=jar&jvmVersion=1.8&groupId=com.example&artifactId=testing-web&name=testing-web&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.testing-web&dependencies=web) 以生成具有所需依赖项的新项目（Spring Web）。
以下清单显示了 `build.gradle` 选择Gradle时创建的文件：
~~~
plugins {
id 'org.springframework.boot' version '2.4.4'
id 'io.spring.dependency-management' version '1.0.11.RELEASE'
id 'java'
}
group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '1.8'
repositories {
mavenCentral()
}
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-web'
testImplementation('org.springframework.boot:spring-boot-starter-test')
}
test {
useJUnitPlatform()
}
~~~
### 手动初始化（可选）
如果要手动初始化项目而不是使用前面显示的链接，请按照以下步骤操作：
1. 导航到 [https://start.spring.io](https://start.spring.io) 。 该服务提取应用程序所需的所有依赖关系，并为您完成大部分设置。
2. 选择Gradle或Maven以及您要使用的语言。 本指南假定您选择了Java。
3. 单击 **Dependencies，** 然后选择 **Spring Web** 。
4. 点击 **生成** 。
5. 下载生成的ZIP文件，该文件是使用您的选择配置的Web应用程序的存档。
如果您的IDE集成了Spring Initializr，则可以从IDE中完成此过程。
## 创建一个简单的应用程序
为您的Spring应用程序创建一个新的控制器。 以下清单（来自 `src/main/java/com/example/testingweb/HomeController.java`）显示了如何执行此操作：
~~~
package com.example.testingweb;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
public class HomeController {
@RequestMapping("/")
public @ResponseBody String greeting() {
return "Hello, World";
}
}
~~~
前面的示例未指定 GET 相对 PUT, POST等等。 默认 @RequestMapping映射所有HTTP操作。 您可以使用 @GetMapping 或者 @RequestMapping(method=GET) 缩小此映射范围。
## 运行应用程序
Spring Initializr创建一个应用程序类（带有 `main()`方法）。 对于本指南，您无需修改此类。 以下清单（来自 `src/main/java/com/example/testingweb/TestingWebApplication.java`）显示了Spring Initializr创建的应用程序类：
~~~
package com.example.testingweb;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class TestingWebApplication {
public static void main(String[] args) {
SpringApplication.run(TestingWebApplication.class, args);
}
}
~~~
`@SpringBootApplication` 是一个方便注释，它添加了以下所有内容：
* `@Configuration`：将类标记为应用程序上下文的Bean定义的源。
* `@EnableAutoConfiguration`：告诉Spring Boot根据类路径设置，其他bean和各种属性设置开始添加bean。
* `@EnableWebMvc`：将应用程序标记为Web应用程序并激活关键行为，例如设置 `DispatcherServlet`。 Spring Boot看到后会自动添加它 `spring-webmvc` 在类路径上。
* `@ComponentScan`：告诉Spring在的目录中寻找其他组件，配置和服务 `com.example.testingweb` 包，让它找到 `HelloController` 班级。
这 `main()` 方法使用Spring Boot的 `SpringApplication.run()`启动应用程序的方法。 您是否注意到没有一行XML？ 没有 `web.xml`文件。 该Web应用程序是100％纯Java，因此您无需处理任何管道或基础结构。 Spring Boot会为您处理所有这一切。
显示日志记录输出。 该服务应在几秒钟内启动并运行。
## 测试应用
现在该应用程序正在运行，您可以对其进行测试。 您可以在以下位置加载主页 `[http://localhost:8080](http://localhost:8080)`。 但是，为了使自己更有信心在进行更改时该应用程序可以正常工作，您希望自动化测试。
Spring Boot假定您计划测试您的应用程序，因此它将必要的依赖项添加到您的构建文件中（ build.gradle 或者 pom.xml).
您可以做的第一件事是编写一个简单的完整性检查测试，如果无法启动应用程序上下文，该测试将失败。 以下清单（来自 `src/test/java/com/example/testingweb/TestingWebApplicationTest.java`）显示了如何执行此操作：
~~~
package com.example.testingweb;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
public class TestingWebApplicationTests {
@Test
public void contextLoads() {
}
}
~~~
这 `@SpringBootTest` 注释告诉Spring Boot寻找一个主要的配置类（一个带有 `@SpringBootApplication`（例如），然后使用它来启动Spring应用程序上下文。 您可以在IDE或命令行中运行此测试（通过运行 `./mvnw test` 或者 `./gradlew test`），它应该会通过。 为了使自己确信上下文正在创建您的控制器，可以添加一个断言，如以下示例所示（来自 `src/test/java/com/example/testingweb/SmokeTest.java`）显示：
~~~
package com.example.testingweb;
import static 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;
@SpringBootTest
public class SmokeTest {
@Autowired
private HomeController controller;
@Test
public void contextLoads() throws Exception {
assertThat(controller).isNotNull();
}
}
~~~
春天诠释了 `@Autowired`注释，并在运行测试方法之前注入控制器。 我们使用 [AssertJ](https://joel-costigliola.github.io/assertj/) （ `assertThat()` 和其他方法）来表达测试断言。
Spring Test支持的一个不错的功能是在测试之间缓存了应用程序上下文。 这样，如果您在一个测试用例中有多个方法，或者在一个具有相同配置的多个测试用例中，则它们仅产生一次启动应用程序的成本。 您可以使用 @DirtiesContext 注解。
进行完整性检查很高兴，但是您还应该编写一些测试来断言应用程序的行为。 为此，您可以启动应用程序并侦听连接（就像在生产环境中那样），然后发送HTTP请求并声明响应。 以下清单（来自 `src/test/java/com/example/testingweb/HttpRequestTest.java`）显示了如何执行此操作：
~~~
package com.example.testingweb;
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.context.SpringBootTest.WebEnvironment;
import org.springframework.boot.test.web.client.TestRestTemplate;
import org.springframework.boot.web.server.LocalServerPort;
import static org.assertj.core.api.Assertions.assertThat;
@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
public class HttpRequestTest {
@LocalServerPort
private int port;
@Autowired
private TestRestTemplate restTemplate;
@Test
public void greetingShouldReturnDefaultMessage() throws Exception {
assertThat(this.restTemplate.getForObject("http://localhost:" + port + "/",
String.class)).contains("Hello, World");
}
}
~~~
注意使用 `webEnvironment=RANDOM_PORT` 使用随机端口启动服务器（用于避免测试环境中的冲突），并使用 `@LocalServerPort`。 另外，请注意，Spring Boot自动提供了一个 `TestRestTemplate`为你。 您要做的就是添加 `@Autowired` 做到这一点。
另一种有用的方法是根本不启动服务器，而仅测试下一层，Spring在该层处理传入的HTTP请求并将其交给您的控制器。 这样，几乎使用了全部堆栈，并且将以与处理真实HTTP请求完全相同的方式调用您的代码，而无需花费启动服务器的费用。 为此，请使用Spring的 `MockMvc` 并要求您使用 `@AutoConfigureMockMvc`测试用例上的注释。 以下清单（来自 `src/test/java/com/example/testingweb/TestingWebApplicationTest.java`）显示了如何执行此操作：
~~~
package com.example.testingweb;
import static org.hamcrest.Matchers.containsString;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print;
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.test.web.servlet.MockMvc;
@SpringBootTest
@AutoConfigureMockMvc
public class TestingWebApplicationTest {
@Autowired
private MockMvc mockMvc;
@Test
public void shouldReturnDefaultMessage() throws Exception {
this.mockMvc.perform(get("/")).andDo(print()).andExpect(status().isOk())
.andExpect(content().string(containsString("Hello, World")));
}
}
~~~
在此测试中，将启动完整的Spring应用程序上下文，但没有服务器。 我们可以使用来将测试范围缩小到仅Web层 `@WebMvcTest`，如以下清单（来自 `src/test/java/com/example/testingweb/WebLayerTest.java`）显示：
~~~
@WebMvcTest
public class WebLayerTest {
@Autowired
private MockMvc mockMvc;
@Test
public void shouldReturnDefaultMessage() throws Exception {
this.mockMvc.perform(get("/")).andDo(print()).andExpect(status().isOk())
.andExpect(content().string(containsString("Hello, World")));
}
}
~~~
测试断言与前面的情况相同。 但是，在此测试中，Spring Boot仅实例化了Web层，而不是整个上下文。 在具有多个控制器的应用程序中，您甚至可以只要求使用以下一种方法来实例化一个： `@WebMvcTest(HomeController.class)`.
到目前为止，我们的 `HomeController`很简单，没有依赖性。 我们可以通过引入一个额外的组件来存储问候语（也许在新的控制器中）来使其更加现实。 以下示例（摘自 `src/main/java/com/example/testingweb/GreetingController.java`）显示了如何执行此操作：
~~~
package com.example.testingweb;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
public class GreetingController {
private final GreetingService service;
public GreetingController(GreetingService service) {
this.service = service;
}
@RequestMapping("/greeting")
public @ResponseBody String greeting() {
return service.greet();
}
}
~~~
然后创建一个问候服务，如下清单（从 `src/main/java/com/example/testingweb/GreetingService.java`）显示：
~~~
package com.example.testingweb;
import org.springframework.stereotype.Service;
@Service
public class GreetingService {
public String greet() {
return "Hello, World";
}
}
~~~
Spring自动将服务依赖项注入到控制器中（由于构造函数签名）。 以下清单（来自 `src/test/java/com/example/testingweb/WebMockTest.java`）显示了如何使用 `@WebMvcTest`:
~~~
package com.example.testingweb;
import static org.hamcrest.Matchers.containsString;
import static org.mockito.Mockito.when;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print;
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.WebMvcTest;
import org.springframework.boot.test.mock.mockito.MockBean;
import org.springframework.test.web.servlet.MockMvc;
@WebMvcTest(GreetingController.class)
public class WebMockTest {
@Autowired
private MockMvc mockMvc;
@MockBean
private GreetingService service;
@Test
public void greetingShouldReturnMessageFromService() throws Exception {
when(service.greet()).thenReturn("Hello, Mock");
this.mockMvc.perform(get("/greeting")).andDo(print()).andExpect(status().isOk())
.andExpect(content().string(containsString("Hello, Mock")));
}
}
~~~
我们用 `@MockBean` 创建并注入模拟 `GreetingService` （如果您不这样做，则应用程序上下文无法启动），我们使用以下命令设置其期望值： `Mockito`.
## 概括
恭喜你！ 您已经开发了一个Spring应用程序，并已通过JUnit和Spring对其进行了测试。 `MockMvc` 并使用Spring Boot隔离了Web层并加载了特殊的应用程序上下文。
- springboot概述
- springboot构建restful服务
- spring构建一个RESTful Web服务
- spring定时任务
- 消费RESTful Web服务
- gradle构建项目
- maven构建项目
- springboot使用jdbc
- springboot应用上传文件
- 使用LDNA验证用户
- 使用 spring data redis
- 使用 spring RabbitTemplate消息队列
- 用no4j访问nosql数据库
- springboot验证web表单
- Spring Boot Actuator构j建服务
- 使用jms传递消息
- springboot创建批处理服务
- spring security保护web 安全
- 在Pivotal GemFire中访问数据
- 使用Spring Integration
- 使用springboot jpa进行数据库操作
- 数据库事务操作
- 操作mongodb
- springmvc+tymleaf创建web应用
- 将Spring Boot JAR应用程序转换为WAR
- 创建异步服务
- spring提交表单
- 使用WebSocket构建交互式Web应用程序
- 使用REST访问Neo4j数据
- jquery消费restful
- springboot跨域请求
- 消费SOAP Web服务
- springboot使用缓存
- 使用Vaadin创建CRUD UI
- 使用REST访问JPA数据
- 使用REST访问Pivotal GemFire中的数据
- 构建soap服务
- 使用rest访问mongodb数据
- 构建springboot应用docker镜像
- 从STS部署到Cloud Foundry
- springboot测试web应用
- springboot访问mysql
- springboot编写自定义模块并使用
- 使用Google Cloud Pub / Sub进行消息传递
- 构建反应式RESTful Web服务
- 使用Redis主动访问数据
- Spring Boot 部署到Kubernetes
- 使用反应式协议R2DBC访问数据
- Spring Security架构
- spring构建Docker镜像详解
- Spring Boot和OAuth2
- springboot应用部署到k8s
- spring构建rest服务详解