对于最新稳定版本，请使用Spring Framework 7.0.1！spring-doc.cadn.net.cn

WebTestClient

WebTestClient是一个为测试服务器应用设计的 HTTP 客户端。它包裹Spring 的 WebClient 并用它来执行请求但暴露了一个用于验证响应的测试界面。WebTestClient可用于执行端到端的HTTP测试。它也可以用于测试Spring MVC和Spring WebFlux通过模拟服务器请求和响应对象测试没有运行服务器的应用程序。spring-doc.cadn.net.cn

Kotlin用户：请参见本节关于使用该WebTestClient.

设置

建立一个WebTestClient你需要选择一个服务器设置来绑定。这可以是多种模拟服务器设置选项之一，或者连接到一个实时服务器。spring-doc.cadn.net.cn

绑定到控制器

这种设置允许你通过模拟请求和响应对象测试特定控制器，无需运行服务器。spring-doc.cadn.net.cn

对于WebFlux应用，请使用以下格式，加载与WebFlux Java配置相当的基础设施，注册给定的控制器，并创建用于处理请求的WebHandler链：spring-doc.cadn.net.cn

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

对于 Spring MVC，请使用以下程序，将任务委托给独立的 MockMvcBuilder，以加载与 WebMvc Java 配置相当的基础设施，注册给定的控制器，并创建一个 MockMvc 实例来处理请求：spring-doc.cadn.net.cn

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

绑定到应用上下文

这种设置允许你用 Spring MVC 或 Spring WebFlux 加载 Spring 配置 基础设施和控制器声明，并用它来处理模拟请求 以及响应对象，无需运行服务器。spring-doc.cadn.net.cn

对于WebFlux，请使用以下Spring应用上下文传递给WebHttpHandlerBuilder，创建用于处理的WebHandler链 请求：spring-doc.cadn.net.cn

@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

对于春季MVC，请使用以下内容，春季应用上下文传递给 MockMvcBuilders.webAppContextSetup 以创建 MockMvc 实例来处理 请求：spring-doc.cadn.net.cn

@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

绑定到路由器功能

这种设置允许你通过以下方式测试功能端点 模拟请求和响应对象，无需运行服务器。spring-doc.cadn.net.cn

对于WebFlux，请使用以下内容，这些配置委托给RouterFunctions.toWebHandler自 创建一个服务器设置来处理请求：spring-doc.cadn.net.cn

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

对于 Spring MVC，目前没有测试 WebMvc 功能端点的选项。spring-doc.cadn.net.cn

绑定到服务器

该设置连接运行中的服务器，进行完整的端到端HTTP测试：spring-doc.cadn.net.cn

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

客户端配置

除了前面提到的服务器设置选项外，你还可以配置客户端 选项包括基础URL、默认头、客户端筛选器等。这些选项 以下内容可广泛获取bindToServer（）.对于所有其他配置选项， 你需要使用configureClient（）从服务器到客户端配置的转换，作为 遵循：spring-doc.cadn.net.cn

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

写作测试

WebTestClient提供与WebClient相同的API，直到执行请求时，通过以下方式进行exchange（）.请参阅WebClient文档中的示例 准备包含任何内容的请求，包括表单数据、多部分数据等。spring-doc.cadn.net.cn

在被召集之后exchange（）,WebTestClient与Web客户端和 相反，继续进行一个工作流程来验证回答。spring-doc.cadn.net.cn

要断言响应状态和头部，请使用以下方法：spring-doc.cadn.net.cn

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（..）而不是多条链条期待*（..）调用。该特征为 类似于 AssertJ 中的软断言支持，以及assertAll（）支持 朱尼特·朱庇特。spring-doc.cadn.net.cn

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

然后你可以选择通过以下方式之一解码响应体：spring-doc.cadn.net.cn

并对所得的更高层级对象执行断言：spring-doc.cadn.net.cn

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)

如果内置断言不足，你可以直接消耗对象，并且 执行任何其他断言：spring-doc.cadn.net.cn

   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)...
		});
client.get().uri("/persons/1")
		.exchange()
		.expectStatus().isOk()
		.expectBody<Person>()
		.consumeWith {
			// custom assertions (e.g. AssertJ)...
		}

或者你可以退出工作流程，获得一个实体交换结果:spring-doc.cadn.net.cn

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()
当你需要用泛型解码到目标类型时，注意那些过载的方法 接受参数化类型引用而不是Class<T>.

无内容

如果不应要求回复包含内容，你可以这样断言：spring-doc.cadn.net.cn

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

如果你想忽略回复内容，以下内容会发布，无需 任何断言：spring-doc.cadn.net.cn

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

JSON 内容

你可以使用expectBody（）没有目标类型来对原始文件执行断言 内容而非通过更高级别的对象。spring-doc.cadn.net.cn

用 JSONAssert 验证完整的 JSON 内容：spring-doc.cadn.net.cn

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 内容：spring-doc.cadn.net.cn

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

流媒体回应

测试潜在无限的流，例如“文本/事件流”或“application/x-ndjson”，首先验证响应状态和头部，然后 获得一个流交换结果:spring-doc.cadn.net.cn

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>()

现在你准备好接收响应流了步进验证器从反应堆测试:spring-doc.cadn.net.cn

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客户端，因此它只能验证客户端中的内容 响应包括状态、头部和正文。spring-doc.cadn.net.cn

在测试带有MockMvc服务器的Spring MVC应用时，你会多出一个额外的 选择对服务器响应进行进一步断言。要做到这一点，首先要做 获得交换结果主张主体后：spring-doc.cadn.net.cn

// 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.class)
		.returnResult();

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

然后切换到MockMvc服务器响应断言：spring-doc.cadn.net.cn

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