springboot測試web應用 · springboot官方文檔中文版

# 測試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/>  </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層并加載了特殊的應用程序上下文。