Spring 5 中文解析测试篇-WebTestClient

本文涉及的产品
全局流量管理 GTM,标准版 1个月
公共DNS(含HTTPDNS解析),每月1000万次HTTP解析
云解析 DNS,旗舰版 1个月
简介: 本章节主要描述:Spring 5 中文解析测试篇-WebTestClient。
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) //1
class 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.expectBody

client.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 ,在到达解码对象时对其进行断言,然后在达到测试目标时在某个时候取消。我们建议使用反应堆测试模块中的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/liyong1028826685

微信公众号:

技术交流群:

目录
相关文章
|
10天前
|
监控 Java 应用服务中间件
高级java面试---spring.factories文件的解析源码API机制
【11月更文挑战第20天】Spring Boot是一个用于快速构建基于Spring框架的应用程序的开源框架。它通过自动配置、起步依赖和内嵌服务器等特性,极大地简化了Spring应用的开发和部署过程。本文将深入探讨Spring Boot的背景历史、业务场景、功能点以及底层原理,并通过Java代码手写模拟Spring Boot的启动过程,特别是spring.factories文件的解析源码API机制。
38 2
|
1月前
|
Java 测试技术 开发者
必学!Spring Boot 单元测试、Mock 与 TestContainer 的高效使用技巧
【10月更文挑战第18天】 在现代软件开发中,单元测试是保证代码质量的重要手段。Spring Boot提供了强大的测试支持,使得编写和运行测试变得更加简单和高效。本文将深入探讨Spring Boot的单元测试、Mock技术以及TestContainer的高效使用技巧,帮助开发者提升测试效率和代码质量。
169 2
|
29天前
|
搜索推荐 Java Spring
Spring Filter深度解析
【10月更文挑战第21天】Spring Filter 是 Spring 框架中非常重要的一部分,它为请求处理提供了灵活的控制和扩展机制。通过合理配置和使用 Filter,可以实现各种个性化的功能,提升应用的安全性、可靠性和性能。还可以结合具体的代码示例和实际应用案例,进一步深入探讨 Spring Filter 的具体应用和优化技巧,使对它的理解更加全面和深入。
|
14天前
|
域名解析 网络协议 测试技术
IP、掩码、网关、DNS1、DNS2到底是什么东西,ping telnet测试
理解IP地址、子网掩码、默认网关和DNS服务器的概念是有效管理和配置网络的基础。通过使用ping和telnet命令,可以测试网络连通性和服务状态,快速诊断和解决网络问题。这些工具和概念是网络管理员和IT专业人员日常工作中不可或缺的部分。希望本文提供的详细解释和示例能够帮助您更好地理解和应用这些网络配置和测试工具。
42 2
|
1月前
|
测试技术 API 开发者
精通.NET单元测试:MSTest、xUnit、NUnit全面解析
【10月更文挑战第15天】本文介绍了.NET生态系统中最流行的三种单元测试框架:MSTest、xUnit和NUnit。通过示例代码展示了每种框架的基本用法和特点,帮助开发者根据项目需求和个人偏好选择合适的测试工具。
39 3
|
1月前
|
存储 人工智能 Java
将 Spring AI 与 LLM 结合使用以生成 Java 测试
AIDocumentLibraryChat 项目通过 GitHub URL 为指定的 Java 类生成测试代码,支持 granite-code 和 deepseek-coder-v2 模型。项目包括控制器、服务和配置,能处理源代码解析、依赖加载及测试代码生成,旨在评估 LLM 对开发测试的支持能力。
38 1
|
1月前
|
Java Spring
Spring底层架构源码解析(三)
Spring底层架构源码解析(三)
113 5
|
1月前
|
XML Java 数据格式
Spring IOC容器的深度解析及实战应用
【10月更文挑战第14天】在软件工程中,随着系统规模的扩大,对象间的依赖关系变得越来越复杂,这导致了系统的高耦合度,增加了开发和维护的难度。为解决这一问题,Michael Mattson在1996年提出了IOC(Inversion of Control,控制反转)理论,旨在降低对象间的耦合度,提高系统的灵活性和可维护性。Spring框架正是基于这一理论,通过IOC容器实现了对象间的依赖注入和生命周期管理。
71 0
|
JSON 前端开发 JavaScript
Spring 5 中文解析测试篇-Spring MVC测试框架
本章节主要描述:Spring 5 中文解析测试篇-Spring MVC测试框架。
845 0
|
存储 前端开发 Java
Spring 5 中文解析测试篇-Spring测试
本章节主要描述:Spring 5 中文解析测试篇-Spring测试。
254 0
下一篇
无影云桌面