详解springboot WebTestClient的使用

以下是“详解SpringBoot WebTestClient的使用”的完整攻略。

1.概述

SpringBoot WebTestClient是Spring Framework 5.0引入的新的测试客户端，用于测试Spring WebFlux的应用程序。它提供了一种简单和方便的方式来测试基于异步事件驱动模型的RESTful服务及Web应用程序。

WebTestClient提供了与Spring MVC Test框架类似的API，同时还提供了更多针对异步处理的特定功能。它可通过框架自带的测试工具或与JUnit等单元测试框架集成来使用。

2.开始使用

以下是在Spring Boot中使用WebTestClient的步骤：

步骤1：添加WebTestClient依赖

在Gradle中，可添加WebTestClient依赖如下所示：

dependencies {
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
    testImplementation 'io.projectreactor:reactor-test'
}

在Maven中，可添加WebTestClient依赖如下所示：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependencyr>
<dependency>
    <groupId>io.projectreactor</groupId>
    <artifactId>reactor-test</artifactId>
    <scope>test</scope>
</dependency>

步骤2：创建WebTestClient

在测试类中创建WebTestClient，如下所示：

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.test.web.reactive.server.WebTestClient;

@WebFluxTest
public class MyTests {

    @Autowired
    private WebTestClient webTestClient;

    @Test
    public void testHandler() throws Exception {
        webTestClient.get().uri("/test").exchange()
            .expectStatus().isOk()
            .expectBody(String.class).isEqualTo("test");
    }
}

步骤3：使用WebTestClient进行测试

使用WebTestClient来测试Spring WebFlux应用程序，如下所示：

• 发送GET请求：

webTestClient.get().uri("/test").exchange()
    .expectStatus().isOk()
    .expectBody(String.class).isEqualTo("test");

• 发送POST请求：

webTestClient.post().uri("/test")
    .contentType(MediaType.APPLICATION_JSON)
    .bodyValue("{\"name\":\"test\"}")
    .exchange()
    .expectStatus().isOk()
    .expectBody(String.class).isEqualTo("test");

3. 示例说明

以下是两个WebTestClient的示例说明：

示例1：测试“HelloWorld”Web应用程序

假设有一个简单的Spring WebFlux应用程序，代码如下所示：

@Configuration
public class AppConfig {
    @Bean
    public RouterFunction<ServerResponse> route() {
        return RouterFunctions
            .route(RequestPredicates.GET("/hello"), 
                    request -> ServerResponse.ok().body(Mono.just("Hello World"), String.class));
    }
}

现在我们编写一个WebTestClient测试来测试该应用程序，代码如下所示：

@WebFluxTest
public class HelloControllerTest {

    @Autowired
    private WebTestClient webTestClient;

    @Test
    void testHelloController() {

        webTestClient.get().uri("/hello")
                     .accept(MediaType.APPLICATION_JSON)
                     .exchange()
                     .expectStatus().isOk()
                     .expectBody(String.class).value(s -> assertThat(s).isEqualTo("Hello World"));
    }
}

在上面的代码中，我们向"/hello"URI发起一个GET请求，并且正确地处理了请求的结果。

示例2：测试“Reactive Programming”Web应用程序

假设有一个使用WebFlux环境下的响应式编程的web应用程序，代码如下所示：

@RestController
@RequestMapping("/api")
public class ReactiveController {

    @Autowired
    private ReactiveService reactiveService;

    @GetMapping("/message")
    public Mono<String> getMessage() {
        return reactiveService.getMessage();
    }

    @PostMapping("/body")
    public Mono<ReactiveMessage> handleBody(@RequestBody ReactiveMessage message) {
        return reactiveService.handleBody(message);
    }
}

现在我们编写一个WebTestClient测试来测试该应用程序。首先，我们模拟一些基于WebFlux的响应式服务，代码如下所示：

public interface ReactiveService {

    Mono<String> getMessage();

    Mono<ReactiveMessage> handleBody(ReactiveMessage message);
}

然后，我们可以编写测试代码来测试响应式应用程序。例如，以下代码测试getMessage()和handleBody()方法，代码如下所示：

@WebFluxTest(ReactiveController.class)
public class ReactiveControllerTest {

    @Autowired
    private WebTestClient webTestClient;

    @MockBean
    private ReactiveService reactiveService;

    @Test
    public void testGetMessageEndpoint() {
        when(reactiveService.getMessage()).thenReturn(Mono.just("Hello World"));

        webTestClient.get().uri("/api/message")
                .exchange()
                .expectStatus().isOk()
                .expectBody(String.class).isEqualTo("Hello World");
    }

    @Test
    public void testPostBodyEndpoint() {
        final ReactiveMessage message = new ReactiveMessage();
        message.setMessage("Hello World");

        when(reactiveService.handleBody(eq(message))).thenReturn(Mono.just(message));

        webTestClient.post().uri("/api/body")
                .body(Mono.just(message), ReactiveMessage.class)
                .exchange()
                .expectStatus().isOk()
                .expectBody(ReactiveMessage.class).isEqualTo(message);
    }
}

在上面的代码中，我们首先模拟了ReactiveService接口，并在testGetMessageEndpoint()和testPostBodyEndpoint()测试用例中进行了测试。这些测试用例演示了如何使用WebTestClient来测试基于响应式编程的WebFlux应用程序的端点。