Spring Boot Test 系列2 - 测试Web层

爱被打了一巴掌 2022-10-19 13:00 53阅读 0赞

### 文章目录 ###

*  Spring Boot Test 系列2 - 测试Web层
 *   *  前言
     *  测试Web层
     *   *  启动server来测试
         *  加载mock的Application Context来测试
         *  加载Web层来测试
     *  Mock Service层测试Web层
     *  小结
     *  参考文档

# Spring Boot Test 系列2 - 测试Web层 #

## 前言 ##

本文为Spring Boot Test系列的第二篇的测试Web层。

前置文章：

*  [Sprint Boot Test 系列1 - 入门][Sprint Boot Test _1 -]

## 测试Web层 ##

### 启动server来测试 ###

测试Web层的一种方式是启动server，来对Web endpoint作黑盒测试。

这种测试的优点是不需要关心Controller层的实现，缺点是需要启动server和加载Application Context，测试用时较长。

以`HttpRequestTest` 测试类为例：

说明：

*  `@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)` 声明以随机端口启动server，并加载Application Context。
 *  `@LocalServerPort` 用来获取server的侦听端口。
 *  用`TestRestTemplate` 来调用REST API。

从日志中打印`Tomcat started on port(s)` 可以佐证这种测试方式启动了server。

### 加载mock的Application Context来测试 ###

测试Web层的另一种方式是不启动server，只加载mock的Application Context。

比“启动server来测试”的方式，这种方式也需要加载Application Context，但是不需要启动server，测试用时较短。另外这种测试调用API时，不需要关心端口（因为没有启动server）。

以`MockHttpRequestTest` 为例：

import org.junit.jupiter.api.DisplayName;
    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;
    
    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;
    
    @SpringBootTest
    @AutoConfigureMockMvc
    class MockHttpRequestTest { 
    
        @Autowired
        private MockMvc mockMvc;
    
        @Test
        @DisplayName("should return default message")
        void shouldReturnDefaultMessage() throws Exception { 
            this.mockMvc.perform(get("/"))
                    .andDo(print())
                    .andExpect(status().isOk())
                    .andExpect(content().string(containsString("Hello, World")));
        }
    }

说明：

*  使用`@AutoConfigureMockMvc` 来加载mock的Application Context。
 *  使用`MockMvc` 在mock的Application Context中调用API，即`this.mockMvc.perform()`。

从日志中没有输出`Tomcat started on port(s)` 可以佐证这种测试方式没有启动server。

### 加载Web层来测试 ###

测试Web层的另一种方式是不加载整个Application Context，而是只加载Web层（sliced application context for web)。

比“启动server来测试”和“加载mock的Application Context”的方式，这种方式测试用时更短。

以`WebLayerTest`测试类为例：

import org.junit.jupiter.api.DisplayName;
    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.test.web.servlet.MockMvc;
    
    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;
    
    @WebMvcTest(HomeController.class)
    public class WebLayerTest { 
    
        @Autowired
        private MockMvc mockMvc;
    
        @Test
        @DisplayName("should return default message")
        void shouldReturnDefaultMessage() throws Exception { 
            this.mockMvc.perform(get("/"))
                    .andDo(print())
                    .andExpect(status().isOk())
                    .andExpect(content().string(containsString("Hello, World")));
        }
    }

说明：

*  使用`@WebMvcTest` 加载Web层。
 *  使用`MockMvc` 在mock的Application Context中调用API，即`this.mockMvc.perform()`。
 *  `@WebMvcTest` 可指定Controller类名，比如`@WebMvcTest(HomeController.class)`，来进一步缩小加载Web层的范围，使得测试用时更短。

## Mock Service层测试Web层 ##

以Controller层调用Service层为例，可以mock应用的Service层来测试Web层（即Controller）。

以`WebMockTest` 测试类为例：

import org.junit.jupiter.api.DisplayName;
    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;
    
    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;
    
    @WebMvcTest(GreetingController.class)
    class WebMockTest { 
    
        @Autowired
        private MockMvc mockMvc;
    
        @MockBean
        private GreetingService service;
    
        @Test
        @DisplayName("greeting should return message from service")
        void greetingShouldReturnMessageFromService() throws Exception { 
            // mock here
            when(service.greet()).thenReturn("Hello, Mock");
    
            this.mockMvc.perform(get("/greeting"))
                    .andDo(print())
                    .andExpect(status().isOk())
                    .andExpect(content().string(containsString("Hello, Mock"))); // assert mocked result
        }
    }

说明：

*  `@WebMvcTest(GreetingControler.class)` 和 `MockMvc` 表示只加载Web层的`GreetingController` 类。
 *  用`@MockBean` 来mock注入的`GreetingService` 类。
 *  用`when(service.greet()).thenReturn("Hello, Mock")` 来mock `GreetingService.greet()` 方法。

## 小结 ##

推荐使用"加载Web层来测试 + Mock Service层测试Web层"的测试方式来测试Spring Boot应用的Web层。

这种方式加载应用运行时最少，测试时依赖最少，测试用时最短。

本文示例代码参见：

*  [springboot-test-demo][]

## 参考文档 ##

*  [Testing the Web Layer][]
 *  [Guide to Testing Spring Boot Applications With MockMvc][]

[Sprint Boot Test _1 -]: https://cookcode.blog.csdn.net/article/details/118642485
[springboot-test-demo]: https://github.com/cookcodeblog/springboot-test-demo
[Testing the Web Layer]: https://spring.io/guides/gs/testing-web/
[Guide to Testing Spring Boot Applications With MockMvc]: https://rieckpil.de/guide-to-testing-spring-boot-applications-with-mockmvc/