WebTestClient

WebTestClient 是一个用于测试服务器应用程序的 HTTP 客户端。它包装了 Spring 的 WebClient 并使用它来执行请求，但公开了一个测试门面以验证响应。WebTestClient 可以用于执行端到端 HTTP 测试。它还可以通过模拟服务器请求和响应对象，在没有运行服务器的情况下测试 Spring MVC 和 Spring WebFlux 应用程序。

设置

要设置 WebTestClient，你需要选择一个要绑定的服务器设置。这可以是几种模拟服务器设置选项之一，也可以是与实时服务器的连接。

绑定到控制器

此设置允许你通过模拟请求和响应对象测试特定的控制器，而无需运行服务器。

对于 WebFlux 应用程序，请使用以下方式，它会加载与 WebFlux Java 配置等效的基础设施，注册给定的控制器，并创建一个 WebHandler 链来处理请求

Java
Kotlin

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

val client = WebTestClient.bindToController(TestController()).build()

对于 Spring MVC，请使用以下方式，它委托给 StandaloneMockMvcBuilder 来加载与 WebMvc Java 配置等效的基础设施，注册给定的控制器，并创建一个 MockMvc 实例来处理请求

Java
Kotlin

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

val client = MockMvcWebTestClient.bindToController(TestController()).build()

绑定到 `ApplicationContext`

此设置允许你加载包含 Spring MVC 或 Spring WebFlux 基础设施和控制器声明的 Spring 配置，并使用它通过模拟请求和响应对象处理请求，而无需运行服务器。

对于 WebFlux，请使用以下方式，其中 Spring ApplicationContext 传递给 WebHttpHandlerBuilder 以创建 WebHandler 链来处理请求

Java
Kotlin

@SpringJUnitConfig(WebConfig.class) (1)
class MyTests {

	WebTestClient client;

	@BeforeEach
	void setUp(ApplicationContext context) {  (2)
		client = WebTestClient.bindToApplicationContext(context).build(); (3)
	}
}

1	指定要加载的配置
2	注入配置
3	创建 `WebTestClient`

@SpringJUnitConfig(WebConfig::class) (1)
class MyTests {

	lateinit var client: WebTestClient

	@BeforeEach
	fun setUp(context: ApplicationContext) { (2)
		client = WebTestClient.bindToApplicationContext(context).build() (3)
	}
}

1	指定要加载的配置
2	注入配置
3	创建 `WebTestClient`

对于 Spring MVC，请使用以下方式，其中 Spring ApplicationContext 传递给 MockMvcBuilders.webAppContextSetup 以创建 MockMvc 实例来处理请求

Java
Kotlin

@ExtendWith(SpringExtension.class)
@WebAppConfiguration("classpath:META-INF/web-resources") (1)
@ContextHierarchy({
	@ContextConfiguration(classes = RootConfig.class),
	@ContextConfiguration(classes = WebConfig.class)
})
class MyTests {

	@Autowired
	WebApplicationContext wac; (2)

	WebTestClient client;

	@BeforeEach
	void setUp() {
		client = MockMvcWebTestClient.bindToApplicationContext(this.wac).build(); (3)
	}
}

1	指定要加载的配置
2	注入配置
3	创建 `WebTestClient`

@ExtendWith(SpringExtension.class)
@WebAppConfiguration("classpath:META-INF/web-resources") (1)
@ContextHierarchy({
	@ContextConfiguration(classes = RootConfig.class),
	@ContextConfiguration(classes = WebConfig.class)
})
class MyTests {

	@Autowired
	lateinit var wac: WebApplicationContext; (2)

	lateinit var client: WebTestClient

	@BeforeEach
	fun setUp() { (2)
		client = MockMvcWebTestClient.bindToApplicationContext(wac).build() (3)
	}
}

1	指定要加载的配置
2	注入配置
3	创建 `WebTestClient`

绑定到路由函数

此设置允许你通过模拟请求和响应对象测试函数式端点，而无需运行服务器。

对于 WebFlux，请使用以下方式，它委托给 RouterFunctions.toWebHandler 来创建服务器设置以处理请求

Java
Kotlin

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

val route: RouterFunction<*> = ...
val client = WebTestClient.bindToRouterFunction(route).build()

对于 Spring MVC，目前没有测试 WebMvc 函数式端点的选项。

绑定到服务器

此设置连接到正在运行的服务器以执行完整的端到端 HTTP 测试

Java
Kotlin

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

client = WebTestClient.bindToServer().baseUrl("https://:8080").build()

客户端配置

除了前面描述的服务器设置选项外，你还可以配置客户端选项，包括基本 URL、默认头、客户端过滤器等。这些选项在 bindToServer() 之后立即可用。对于所有其他配置选项，你需要使用 configureClient() 从服务器配置切换到客户端配置，如下所示

Java
Kotlin

client = WebTestClient.bindToController(new TestController())
		.configureClient()
		.baseUrl("/test")
		.apiVersionInserter(ApiVersionInserter.fromHeader("API-Version").build())
		.build();

client = WebTestClient.bindToController(TestController())
		.configureClient()
		.baseUrl("/test")
		.apiVersionInserter(ApiVersionInserter.fromHeader("API-Version").build())
		.build()

编写测试

WebClient 和 WebTestClient 在调用 exchange() 之前具有相同的 API。之后，WebTestClient 提供了两种替代方法来验证响应

内置断言通过一系列期望扩展请求工作流
AssertJ 集成通过 assertThat() 语句验证响应

有关如何准备包含表单数据、多部分数据等任何内容的请求的示例，请参阅 WebClient 文档。

内置断言

要断言响应状态和头，请使用以下方式

Java
Kotlin

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

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

如果你希望即使其中一个期望失败也断言所有期望，你可以使用 expectAll(..) 而不是多个链式 expect*(..) 调用。此功能类似于 AssertJ 中的软断言支持和 JUnit Jupiter 中的 assertAll() 支持。

Java
Kotlin

client.get().uri("/persons/1")
	.accept(MediaType.APPLICATION_JSON)
	.exchange()
	.expectAll(
		spec -> spec.expectStatus().isOk(),
		spec -> spec.expectHeader().contentType(MediaType.APPLICATION_JSON)
	);

client.get().uri("/persons/1")
	.accept(MediaType.APPLICATION_JSON)
	.exchange()
	.expectAll(
		{ spec -> spec.expectStatus().isOk() },
		{ spec -> spec.expectHeader().contentType(MediaType.APPLICATION_JSON) }
	)

然后你可以选择通过以下方式之一解码响应体

expectBody(Class<T>)：解码为单个对象。
expectBodyList(Class<T>)：解码并将对象收集到 List<T> 中。
expectBody()：解码为 JSON 内容的 byte[] 或空主体。

并对生成的高级对象执行断言

Java
Kotlin

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

import org.springframework.test.web.reactive.server.expectBodyList

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

如果内置断言不足，你可以消费对象并执行任何其他断言

Java
Kotlin

import org.springframework.test.web.reactive.server.expectBody

client.get().uri("/persons/1")
		.exchange()
		.expectStatus().isOk()
		.expectBody(Person.class)
		.consumeWith(result -> {
			// custom assertions (for example, AssertJ)...
		});

client.get().uri("/persons/1")
		.exchange()
		.expectStatus().isOk()
		.expectBody<Person>()
		.consumeWith {
			// custom assertions (for example, AssertJ)...
		}

或者你可以退出工作流并获取 EntityExchangeResult

Java
Kotlin

EntityExchangeResult<Person> result = client.get().uri("/persons/1")
		.exchange()
		.expectStatus().isOk()
		.expectBody(Person.class)
		.returnResult();

import org.springframework.test.web.reactive.server.expectBody

val result = client.get().uri("/persons/1")
		.exchange()
		.expectStatus().isOk
		.expectBody<Person>()
		.returnResult()

当你需要解码为带有泛型的目标类型时，请查找接受 ParameterizedTypeReference 而不是 Class<T> 的重载方法。

无内容

如果响应预期没有内容，你可以如下断言

Java
Kotlin

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

client.post().uri("/persons")
		.bodyValue(person)
		.exchange()
		.expectStatus().isCreated()
		.expectBody().isEmpty()

如果你想忽略响应内容，以下会释放内容而没有任何断言

Java
Kotlin

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

client.get().uri("/persons/123")
		.exchange()
		.expectStatus().isNotFound
		.expectBody<Unit>()

JSON 内容

你可以使用不带目标类型的 expectBody() 对原始内容而不是通过高级对象执行断言。

使用 JSONAssert 验证完整的 JSON 内容

Java
Kotlin

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

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

使用 JSONPath 验证 JSON 内容

Java
Kotlin

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

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

流式响应

要测试可能无限的流，例如 "text/event-stream" 或 "application/x-ndjson"，请首先验证响应状态和头，然后获取 FluxExchangeResult

Java
Kotlin

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

import org.springframework.test.web.reactive.server.returnResult

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

现在你可以使用 reactor-test 中的 StepVerifier 消费响应流

Java
Kotlin

Flux<Event> eventFlux = result.getResponseBody();

StepVerifier.create(eventFlux)
		.expectNext(person)
		.expectNextCount(4)
		.consumeNextWith(p -> ...)
		.thenCancel()
		.verify();

val eventFlux = result.getResponseBody()

StepVerifier.create(eventFlux)
		.expectNext(person)
		.expectNextCount(4)
		.consumeNextWith { p -> ... }
		.thenCancel()
		.verify()

AssertJ 集成

WebTestClientResponse 是 AssertJ 集成的主要入口点。它是一个 AssertProvider，它包装了交换的 ResponseSpec，以便启用 assertThat() 语句的使用。例如

Java
Kotlin

ResponseSpec spec = client.get().uri("/persons").exchange();

WebTestClientResponse response = WebTestClientResponse.from(spec);
assertThat(response).hasStatusOk();
assertThat(response).hasContentTypeCompatibleWith(MediaType.TEXT_PLAIN);
// ...

val spec = client.get().uri("/persons").exchange()

val response = WebTestClientResponse.from(spec)
assertThat(response).hasStatusOk()
assertThat(response).hasContentTypeCompatibleWith(MediaType.TEXT_PLAIN)
// ...

你也可以先使用内置工作流，然后获取 ExchangeResult 进行包装并继续使用 AssertJ。例如

Java
Kotlin

ExchangeResult result = client.get().uri("/persons").exchange()
		. // ...
		.returnResult();

WebTestClientResponse response = WebTestClientResponse.from(result);
assertThat(response).hasStatusOk();
assertThat(response).hasContentTypeCompatibleWith(MediaType.TEXT_PLAIN);
// ...

val result = client.get().uri("/persons").exchange()
		. // ...
		.returnResult()

val response = WebTestClientResponse.from(spec)
assertThat(response).hasStatusOk()
assertThat(response).hasContentTypeCompatibleWith(MediaType.TEXT_PLAIN)
// ...

MockMvc 断言

WebTestClient 是一个 HTTP 客户端，因此它只能验证客户端响应中的内容，包括状态、头和主体。

当使用 MockMvc 服务器设置测试 Spring MVC 应用程序时，你可以选择对服务器响应执行进一步的断言。为此，在断言主体后首先获取 ExchangeResult

Java
Kotlin

// For a response with a body
EntityExchangeResult<Person> result = client.get().uri("/persons/1")
		.exchange()
		.expectStatus().isOk()
		.expectBody(Person.class)
		.returnResult();

// For a response without a body
EntityExchangeResult<Void> result = client.get().uri("/path")
		.exchange()
		.expectBody().isEmpty();

// For a response with a body
val result = client.get().uri("/persons/1")
		.exchange()
		.expectStatus().isOk()
		.expectBody<Person>()
		.returnResult()

// For a response without a body
val result = client.get().uri("/path")
		.exchange()
		.expectBody().isEmpty()

然后切换到 MockMvc 服务器响应断言

Java
Kotlin

MockMvcWebTestClient.resultActionsFor(result)
		.andExpect(model().attribute("integer", 3))
		.andExpect(model().attribute("string", "a string value"));

MockMvcWebTestClient.resultActionsFor(result)
		.andExpect(model().attribute("integer", 3))
		.andExpect(model().attribute("string", "a string value"));

WebTestClient

设置

绑定到控制器

绑定到 ApplicationContext

绑定到路由函数

绑定到服务器

客户端配置

编写测试

内置断言

无内容

JSON 内容

流式响应

AssertJ 集成

MockMvc 断言

绑定到 `ApplicationContext`