Spring Boot Test 系列3 - 使用WebTestClient测试Web层

女爷i 2022-10-04 15:54 171阅读 0赞

### 文章目录 ###

*  Spring Boot Test 系列3 - 使用WebTestClient测试Web层
 *   *  前言
     *  使用WebTestClient测试Web层
     *   *  引入spring-boot-starter-webflux依赖
         *  使用WebTestClient代替TestRestTemplate
         *  使用WebTestClient代替MockMvc
     *  小结
     *  参考文档

# Spring Boot Test 系列3 - 使用WebTestClient测试Web层 #

## 前言 ##

本文为Spring Boot Test系列的第三篇的使用WebTestClient测试Web层。

前置文章：

*  [Spring Boot Test 系列2 - 测试Web层][Spring Boot Test _2 - _Web]

## 使用WebTestClient测试Web层 ##

在[Spring Boot Test 系列2 - 测试Web层][Spring Boot Test _2 - _Web] 中说明了如何通过`TestRestTemplate` 和`MockMvc` 来调用API。本文描述另外一种调用API方法，即通过`WebTestClient` 来调用API来测试Web层。

### 引入spring-boot-starter-webflux依赖 ###

<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-webflux</artifactId>
      <scope>test</scope>
    </dependency>

本文中只在测试类中使用了`WebTestClient`，因此将scope设置为`test`即可。

如果不引入`spring-boot-starter-webflux` 会出现webTestClient bean无法注入的问题。

### 使用WebTestClient代替TestRestTemplate ###

`WebTestClient` 和`TestRestTemplate` 分别是`WebClient`和`RestTempalte`的测试工具类。

`WebClient`和`RestTempalte`的比较：

*  `RestTemplate` \- 同步，阻塞式，Spring Web框架的一部分，支持经典的request/response架构
 *  `WebClien`t - 异步，非阻塞式，Spring Reactive框架的一部分，支持Event Driven架构

类路径和包名如下：

org.springframework.boot.test.web.client.TestRestTemplate # spring-boot-test
    org.springframework.web.client.RestTemplate # spring-web
    
    org.springframework.test.web.reactive.server.WebTestClient # spring-test
    org.springframework.web.reactive.function.client.WebClient # spring-webflux

示例代码：

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.reactive.AutoConfigureWebTestClient;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.boot.web.server.LocalServerPort;
    import org.springframework.test.web.reactive.server.WebTestClient;
    
    @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
    @AutoConfigureWebTestClient
    class WebFluxHttpRequestTest { 
    
        @LocalServerPort
        private int port;
    
        @Autowired
        private WebTestClient webTestClient;
    
        @Test
        @DisplayName("greeting should return default message")
        void greetingShouldReturnDefaultMessage() { 
            String url = "http://localhost:" + port + "/";
    
            this.webTestClient
                    .get()
                    .uri(url)
                    .exchange()
                    .expectStatus()
                    .isOk()
                    .expectBody(String.class)
                    .isEqualTo("Hello, World");
        }
    }

说明：

*  使用`@AutoConfigureWebTestClient` 来自动配置WebTestClient。如果不使用该注解，在IDE中会报错，但是程序仍然可以执行。
 *  使用`WebTestClient` 代替 `TestRestTempalte`

相比`TestRestTemplate`，`WebTestClient` 除了可以调用API，还支持流式断言，更加直观和方便输入。

### 使用WebTestClient代替MockMvc ###

示例代码：

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.reactive.WebFluxTest;
    import org.springframework.boot.test.mock.mockito.MockBean;
    import org.springframework.test.web.reactive.server.WebTestClient;
    
    import static org.mockito.Mockito.when;
    
    @WebFluxTest(GreetingController.class)
    public class WebFluxWebMockTest { 
        @Autowired
        private WebTestClient webTestClient;
    
        @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.webTestClient
                    .get()
                    .uri("/greeting")
                    .exchange()
                    .expectStatus()
                    .isOk()
                    .expectBody(String.class)
                    .isEqualTo("Hello, Mock");
        }
    }

说明：

*  用`@WebFluxTest` 代替 `@WebMvcTest` 注解
 *  用`WebTestClient` 代替`MockMvc`

相比`MockMvc`，`WebTestClient` 支持流式断言，更加直观和方便输入。

## 小结 ##

`WebTestClient`的异步、非阻塞式和支持流式断言的特点，可以提升测试API的效率。

可以使用`WebTestClient` 来代替`TestRestTemplate` 和`MockMvc` 测试API。

本文示例代码参见：

*  [springboot-test-demo][]

后面将会用单独的文章介绍另一种测试API的方式，即使用REST-assured来测试Spring Boot应用的API。

## 参考文档 ##

*  [WebTestClient][]
 *  [Spring WebClient vs. RestTemplate][]
 *  [Spring WebTestClient for Efficient REST API Testing][]

[Spring Boot Test _2 - _Web]: https://cookcode.blog.csdn.net/article/details/118652086
[springboot-test-demo]: https://github.com/cookcodeblog/springboot-test-demo
[WebTestClient]: https://docs.spring.io/spring-framework/docs/5.1.8.RELEASE/spring-framework-reference/testing.html#webtestclient
[Spring WebClient vs. RestTemplate]: https://www.baeldung.com/spring-webclient-resttemplate
[Spring WebTestClient for Efficient REST API Testing]: https://rieckpil.de/spring-webtestclient-for-efficient-testing-of-your-rest-api/