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

绑定到 Router Function

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

对于 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("http://localhost:8080").build();
client = WebTestClient.bindToServer().baseUrl("http://localhost:8080").build()

客户端配置

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

  • Java

  • Kotlin

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

编写测试

WebTestClient 提供了与 WebClient 相同的 API，直到使用 exchange() 执行请求。有关如何准备包含表单数据、多部分数据等的请求的示例，请参阅 WebClient 文档。

调用 exchange() 后，WebTestClient 与 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()

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"));