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

定义期望

断言的使用方式与任何 AssertJ 断言相同。该支持为 MvcTestResult 的各个部分提供了专用的断言对象,如下例所示:spring-doc.cadn.net.cn

assertThat(mockMvc.get().uri("/hotels/{id}", 42))
		.hasStatusOk()
		.hasContentTypeCompatibleWith(MediaType.APPLICATION_JSON)
		.bodyJson().isLenientlyEqualTo("sample/hotel-42.json");
assertThat(mockMvc.get().uri("/hotels/{id}", 42))
	.hasStatusOk()
	.hasContentTypeCompatibleWith(MediaType.APPLICATION_JSON)
	.bodyJson().isLenientlyEqualTo("sample/hotel-42.json")

如果请求失败,exchange 不会抛出异常。相反,你可以断言 exchange 的结果已失败:spring-doc.cadn.net.cn

assertThat(mockMvc.get().uri("/hotels/{id}", -1))
		.hasFailed()
		.hasStatus(HttpStatus.BAD_REQUEST)
		.failure().hasMessageContaining("Identifier should be positive");
assertThat(mockMvc.get().uri("/hotels/{id}", -1))
	.hasFailed()
	.hasStatus(HttpStatus.BAD_REQUEST)
	.failure().hasMessageContaining("Identifier should be positive")

请求也可能意外失败,也就是说,处理器抛出的异常未被处理,而是直接抛出。你仍然可以使用 .hasFailed().failure(),但任何尝试访问结果部分内容的操作都会抛出异常,因为交换尚未完成。spring-doc.cadn.net.cn

JSON 支持

通过 MvcTestResult 方法,AssertJ 对 bodyJson() 的支持提供了 JSON 功能。spring-doc.cadn.net.cn

如果 JSONPath 可用,您可以对 JSON 文档应用表达式。返回的值提供了便捷的方法,用于为各种受支持的 JSON 数据类型返回专用的断言对象:spring-doc.cadn.net.cn

assertThat(mockMvc.get().uri("/family")).bodyJson()
		.extractingPath("$.members[0]")
		.asMap()
		.contains(entry("name", "Homer"));
assertThat(mockMvc.get().uri("/family")).bodyJson()
	.extractingPath("$.members[0]")
	.asMap()
	.contains(entry("name", "Homer"))

只要消息转换器配置正确,你也可以将原始内容转换为任意你所需的数据类型:spring-doc.cadn.net.cn

assertThat(mockMvc.get().uri("/family")).bodyJson()
		.extractingPath("$.members[0]")
		.convertTo(Member.class)
		.satisfies(member -> assertThat(member.name).isEqualTo("Homer"));
assertThat(mockMvc.get().uri("/family")).bodyJson()
	.extractingPath("$.members[0]")
	.convertTo(Member::class.java)
	.satisfies(ThrowingConsumer { member: Member ->
		assertThat(member.name).isEqualTo("Homer")
	})

转换为目标 Class 会提供一个通用的断言对象。对于更复杂的类型, 如果可能的话,你可能希望改用 AssertFactory,它会返回一个专用的断言类型:spring-doc.cadn.net.cn

assertThat(mockMvc.get().uri("/family")).bodyJson()
		.extractingPath("$.members")
		.convertTo(InstanceOfAssertFactories.list(Member.class))
		.hasSize(5)
		.element(0).satisfies(member -> assertThat(member.name).isEqualTo("Homer"));
assertThat(mockMvc.get().uri("/family")).bodyJson()
	.extractingPath("$.members")
	.convertTo(InstanceOfAssertFactories.list(Member::class.java))
	.hasSize(5)
	.element(0).satisfies(ThrowingConsumer { member: Member ->
		assertThat(member.name).isEqualTo("Homer")
	})

还支持 JSONAssert。响应体可以与一个 Resource 或内容进行匹配。如果内容以 `.json` 结尾,我们会在类路径中查找与该名称匹配的文件:spring-doc.cadn.net.cn

assertThat(mockMvc.get().uri("/family")).bodyJson()
		.isStrictlyEqualTo("sample/simpsons.json");
assertThat(mockMvc.get().uri("/family")).bodyJson()
	.isStrictlyEqualTo("sample/simpsons.json")

如果您更喜欢使用其他库,您可以提供 JsonComparator 的实现。spring-doc.cadn.net.cn