3.7 WebTestClient

WebTestClient是围绕WebClient的薄壳，可用于执行申请并公开专用的流畅API来验证响应。 WebTestClient通过应用模仿申请和响应绑定到WebFlux应用程序，或者它能够通过HTTP连贯测试任何Web服务器。

Kotlin用户：请参阅本节与WebTestClient的应用无关。
3.7.1 装置

要创立WebTestClient，必须抉择多个服务器设置选项之一。实际上，你是在配置WebFlux应用程序以绑定到该URL，还是应用URL连贯到正在运行的服务器。

绑定到控制器

以下示例显示如何创立服务器设置以一次测试一个@Controller：

client = WebTestClient.bindToController(new TestController()).build();

后面的示例加载WebFlux Java配置并注册给定的控制器。应用模仿申请和响应对象，能够在没有HTTP服务器的状况下测试生成的WebFlux应用程序。构建器上有更多办法能够定制默认WebFlux Java配置。

绑定到路由器性能

以下示例显示了如何通过RouterFunction设置服务器：

RouterFunction<?> route = ...client = WebTestClient.bindToRouterFunction(route).build();

在外部，配置被传递到RouterFunctions.toWebHandler。应用模仿申请和响应对象，能够在没有HTTP服务器的状况下测试生成的WebFlux应用程序。

绑定到ApplicationContext

以下示例显示了如何通过应用程序或其局部子集的Spring配置来设置服务器：

@SpringJUnitConfig(WebConfig.class) //1class MyTests {    WebTestClient client;    @BeforeEach    void setUp(ApplicationContext context) {  //2        client = WebTestClient.bindToApplicationContext(context).build(); //3    }}
  1. 指定要加载的配置
  2. 注入配置
  3. 创立WebTestClient

在外部，配置被传递到WebHttpHandlerBuilder以建设申请解决链。无关更多详细信息，请参见WebHandler API。应用模仿申请和响应对象，能够在没有HTTP服务器的状况下测试生成的WebFlux应用程序。

绑定到服务器

以下服务器设置选项使你能够连贯到正在运行的服务器：

client = WebTestClient.bindToServer().baseUrl("http://localhost:8080").build();

客户端构建者

除了后面介绍的服务器设置选项之外，你还能够配置客户端选项、包含根本URL、默认标头，客户端过滤器等。这些选项在bindToServer之后很容易取得。对于所有其余服务器，你须要应用configureClient()从服务器配置过渡到客户端配置，如下所示：

client = WebTestClient.bindToController(new TestController())        .configureClient()        .baseUrl("/test")        .build();
3.7.2 写测试

WebTestClient提供了与WebClient雷同的API，直到应用exchange()执行申请为止。 exchange()之后是链接的API工作流，用于验证响应。

通常，首先申明响应状态和标头，如下所示：

client.get().uri("/persons/1")            .accept(MediaType.APPLICATION_JSON)            .exchange()            .expectStatus().isOk()            .expectHeader().contentType(MediaType.APPLICATION_JSON)

而后，你指定如何解码和应用响应主体：

  • ExpectBody(Class <T>)：解码为单个对象。
  • ExpectBodyList(Class <T>)：解码并将对象收集到List <T>。
  • ExpectBody()：解码为byte []以获取JSON内容或一个空的注释。

而后，你能够为主体应用内置的断言。以下示例显示了一种办法：

client.get().uri("/persons")        .exchange()        .expectStatus().isOk()        .expectBodyList(Person.class).hasSize(3).contains(person);

你还能够超过内置的断言并创立本人的断言，如以下示例所示：

import org.springframework.test.web.reactive.server.expectBodyclient.get().uri("/persons/1")        .exchange()        .expectStatus().isOk()        .expectBody(Person.class)        .consumeWith(result -> {            // custom assertions (e.g. AssertJ)...        });

你还能够退出工作流程并取得后果，如下所示：

EntityExchangeResult<Person> result = client.get().uri("/persons/1")        .exchange()        .expectStatus().isOk()        .expectBody(Person.class)        .returnResult();
当你须要应用泛型解码为指标类型时，请寻找承受ParameterizedTypeReference而不是Class <T>的重载办法。

无内容

如果响应没有内容（或者你不在乎），请应用Void.class，以确保开释资源。以下示例显示了如何执行此操作：

client.get().uri("/persons/123")        .exchange()        .expectStatus().isNotFound()        .expectBody(Void.class);

或者，如果要断言没有响应内容，则能够应用相似于以下内容的代码：

client.post().uri("/persons")        .body(personMono, Person.class)        .exchange()        .expectStatus().isCreated()        .expectBody().isEmpty();

JSON内容

当你应用ExpectBody()时，响应以byte[]的模式应用。这对于原始内容申明很有用。例如，你能够应用JSONAssert来验证JSON内容，如下所示：

client.get().uri("/persons/1")        .exchange()        .expectStatus().isOk()        .expectBody()        .json("{\"name\":\"Jane\"}")

你还能够应用JSONPath表达式，如下所示：

client.get().uri("/persons")        .exchange()        .expectStatus().isOk()        .expectBody()        .jsonPath("$[0].name").isEqualTo("Jane")        .jsonPath("$[1].name").isEqualTo("Jason");

流式响应

要测试有限流（例如，“ text/event-stream”或“ application/stream + json”），你须要在响应状态和响应头断言之后立刻退出链接的API（通过应用returnResult），如下所示示例显示：

FluxExchangeResult<MyEvent> result = client.get().uri("/events")        .accept(TEXT_EVENT_STREAM)        .exchange()        .expectStatus().isOk()        .returnResult(MyEvent.class);

当初，你能够应用Flux <T>，在达到解码对象时对其进行断言，而后在达到测试指标时在某个时候勾销。咱们倡议应用反应堆测试模块中的StepVerifier进行此操作，如以下示例所示：

Flux<Event> eventFlux = result.getResponseBody();StepVerifier.create(eventFlux)        .expectNext(person)        .expectNextCount(4)        .consumeNextWith(p -> ...)        .thenCancel()        .verify();

申请体

当波及到构建申请时，WebTestClient提供了与WebClient雷同的API，实现次要是简略的传递。请参阅WebClient文档，以获取无关如何应用注释筹备申请的示例，包含提交表单数据，多局部申请等。

作者

集体从事金融行业，就任过易极付、思建科技、某网约车平台等重庆一流技术团队，目前就任于某银行负责对立领取零碎建设。本身对金融行业有强烈的喜好。同时也实际大数据、数据存储、自动化集成和部署、散布式微服务、响应式编程、人工智能等畛域。同时也热衷于技术分享创建公众号和博客站点对常识体系进行分享。关注公众号：青年IT男 获取最新技术文章推送！

博客地址： http://youngitman.tech

CSDN： https://blog.csdn.net/liyong1...

微信公众号：

技术交换群：