定义期望

您可以通过在执行请求后追加一个或多个 andExpect(..) 调用来定义期望,如以下示例所示。一旦一个期望失败,将不会断言其他期望。

  • Java

  • Kotlin

// static import of MockMvcRequestBuilders.* and MockMvcResultMatchers.*

mockMvc.perform(get("/accounts/1")).andExpect(status().isOk());
import org.springframework.test.web.servlet.get

mockMvc.get("/accounts/1").andExpect {
	status { isOk() }
}

您可以通过在执行请求后追加 andExpectAll(..) 来定义多个期望,如以下示例所示。与 andExpect(..) 不同,andExpectAll(..) 保证所有提供的期望都将被断言,并且所有失败都将被跟踪和报告。

  • Java

  • Kotlin

// static import of MockMvcRequestBuilders.* and MockMvcResultMatchers.*

mockMvc.perform(get("/accounts/1")).andExpectAll(
	status().isOk(),
	content().contentType("application/json;charset=UTF-8"));
import org.springframework.test.web.servlet.get

mockMvc.get("/accounts/1").andExpectAll {
	status { isOk() }
	content { contentType(APPLICATION_JSON) }
}

MockMvcResultMatchers.* 提供了许多期望,其中一些期望进一步嵌套了更详细的期望。

期望分为两大类。第一类断言验证响应的属性(例如,响应状态、头和内容)。这些是最重要的断言结果。

第二类断言超出了响应。这些断言允许您检查 Spring MVC 的特定方面,例如哪个控制器方法处理了请求、是否引发并处理了异常、模型的内容是什么、选择了哪个视图、添加了哪些闪存属性等等。它们还允许您检查 Servlet 的特定方面,例如请求和会话属性。

以下测试断言绑定或验证失败:

  • Java

  • Kotlin

mockMvc.perform(post("/persons"))
	.andExpect(status().isOk())
	.andExpect(model().attributeHasErrors("person"));
import org.springframework.test.web.servlet.post

mockMvc.post("/persons").andExpect {
	status { isOk() }
	model {
		attributeHasErrors("person")
	}
}

很多时候,在编写测试时,转储执行请求的结果很有用。您可以按如下方式进行,其中 print() 是从 MockMvcResultHandlers 静态导入的:

  • Java

  • Kotlin

mockMvc.perform(post("/persons"))
	.andDo(print())
	.andExpect(status().isOk())
	.andExpect(model().attributeHasErrors("person"));
import org.springframework.test.web.servlet.post

mockMvc.post("/persons").andDo {
		print()
	}.andExpect {
		status { isOk() }
		model {
			attributeHasErrors("person")
		}
	}

只要请求处理不会导致未处理的异常,print() 方法就会将所有可用的结果数据打印到 System.out。还有一个 log() 方法和 print() 方法的两个附加变体,一个接受 OutputStream,一个接受 Writer。例如,调用 print(System.err) 会将结果数据打印到 System.err,而调用 print(myWriter) 会将结果数据打印到自定义写入器。如果希望将结果数据记录而不是打印,可以调用 log() 方法,该方法将结果数据作为单个 DEBUG 消息记录在 org.springframework.test.web.servlet.result 日志类别下。

在某些情况下,您可能希望直接访问结果并验证无法以其他方式验证的内容。这可以通过在所有其他期望之后追加 .andReturn() 来实现,如以下示例所示:

  • Java

  • Kotlin

MvcResult mvcResult = mockMvc.perform(post("/persons")).andExpect(status().isOk()).andReturn();
// ...
var mvcResult = mockMvc.post("/persons").andExpect { status { isOk() } }.andReturn()
// ...

如果所有测试都重复相同的期望,您可以在构建 MockMvc 实例时一次性设置通用期望,如以下示例所示:

  • Java

  • Kotlin

standaloneSetup(new SimpleController())
	.alwaysExpect(status().isOk())
	.alwaysExpect(content().contentType("application/json;charset=UTF-8"))
	.build()
// Not possible in Kotlin until {kotlin-issues}/KT-22208 is fixed

请注意,通用期望总是被应用,并且在不创建单独的 MockMvc 实例的情况下无法覆盖。

当 JSON 响应内容包含使用 Spring HATEOAS 创建的超媒体链接时,您可以使用 JsonPath 表达式验证生成的链接,如以下示例所示:

  • Java

  • Kotlin

mockMvc.perform(get("/people").accept(MediaType.APPLICATION_JSON))
	.andExpect(jsonPath("$.links[?(@.rel == 'self')].href").value("http://localhost:8080/people"));
mockMvc.get("/people") {
	accept(MediaType.APPLICATION_JSON)
}.andExpect {
	jsonPath("$.links[?(@.rel == 'self')].href") {
		value("http://localhost:8080/people")
	}
}

当 XML 响应内容包含使用 Spring HATEOAS 创建的超媒体链接时,您可以使用 XPath 表达式验证生成的链接:

  • Java

  • Kotlin

Map<String, String> ns = Collections.singletonMap("ns", "http://www.w3.org/2005/Atom");
mockMvc.perform(get("/handle").accept(MediaType.APPLICATION_XML))
	.andExpect(xpath("/person/ns:link[@rel='self']/@href", ns).string("http://localhost:8080/people"));
val ns = mapOf("ns" to "http://www.w3.org/2005/Atom")
mockMvc.get("/handle") {
	accept(MediaType.APPLICATION_XML)
}.andExpect {
	xpath("/person/ns:link[@rel='self']/@href", ns) {
		string("http://localhost:8080/people")
	}
}