在 Spring MVC 测试中作为用户运行测试

通常需要在测试中模拟特定用户。有两种简单的方法来设置用户：

在 Spring MVC 测试中使用 RequestPostProcessor 模拟用户

你有多种选择将用户与当前的 HttpServletRequest 关联起来。以下示例模拟了一个用户（该用户不需要实际存在），其用户名是 user，密码是 password，角色是 ROLE_USER。

  • Java

  • Kotlin

mvc
	.perform(get("/").with(user("user")))
mvc.get("/") {
    with(user("user"))
}

此功能通过将用户关联到 HttpServletRequest 来实现。为了将请求与 SecurityContextHolder 关联，你需要确保 SecurityContextPersistenceFilter 与 MockMvc 实例相关联。你可以通过以下几种方式来实现：

  • 调用 apply(springSecurity())

  • 将 Spring Security 的 FilterChainProxy 添加到 MockMvc

  • 使用 MockMvcBuilders.standaloneSetup 时，手动将 SecurityContextPersistenceFilter 添加到 MockMvc 实例可能更合理。

你可以轻松进行自定义。例如，以下示例将模拟一个用户（该用户不需要实际存在），其用户名为 "admin"，密码为 "pass"，角色为 "ROLE_USER" 和 "ROLE_ADMIN"。

  • Java

  • Kotlin

mvc
	.perform(get("/admin").with(user("admin").password("pass").roles("USER","ADMIN")))
mvc.get("/admin") {
    with(user("admin").password("pass").roles("USER","ADMIN"))
}

如果你有自定义的 UserDetails 希望使用，也可以轻松指定。例如，以下示例将使用指定的 UserDetails（该用户不需要实际存在）运行一个 UsernamePasswordAuthenticationToken，其 principal 为指定的 UserDetails。

  • Java

  • Kotlin

mvc
	.perform(get("/").with(user(userDetails)))
mvc.get("/") {
    with(user(userDetails))
}

你可以使用以下方式模拟匿名用户：

  • Java

  • Kotlin

mvc
	.perform(get("/").with(anonymous()))
mvc.get("/") {
    with(anonymous())
}

当你默认以某个用户身份运行时，如果希望以匿名用户处理某些请求，这种方法特别有用。

如果你想要一个自定义的 Authentication（该认证不需要实际存在），可以使用以下方式：

  • Java

  • Kotlin

mvc
	.perform(get("/").with(authentication(authentication)))
mvc.get("/") {
    with(authentication(authentication))
}

你甚至可以使用以下方式自定义 SecurityContext：

  • Java

  • Kotlin

mvc
	.perform(get("/").with(securityContext(securityContext)))
mvc.get("/") {
    with(securityContext(securityContext))
}

我们还可以通过使用 MockMvcBuilders 的默认请求来确保每个请求都以特定用户身份运行。例如，以下示例将模拟一个用户（该用户不需要实际存在），其用户名为 "admin"，密码为 "password"，角色为 "ROLE_ADMIN"。

  • Java

  • Kotlin

mvc = MockMvcBuilders
		.webAppContextSetup(context)
		.defaultRequest(get("/").with(user("user").roles("ADMIN")))
		.apply(springSecurity())
		.build();
mvc = MockMvcBuilders
    .webAppContextSetup(context)
    .defaultRequest<DefaultMockMvcBuilder>(get("/").with(user("user").roles("ADMIN")))
    .apply<DefaultMockMvcBuilder>(springSecurity())
    .build()

如果你发现在很多测试中都使用了相同的用户，建议将用户定义到一个方法中。例如，你可以在自己的类 CustomSecurityMockMvcRequestPostProcessors 中指定以下内容：

  • Java

  • Kotlin

public static RequestPostProcessor rob() {
	return user("rob").roles("ADMIN");
}
fun rob(): RequestPostProcessor {
    return user("rob").roles("ADMIN")
}

现在你可以对 CustomSecurityMockMvcRequestPostProcessors 进行静态导入，并在测试中使用它。

  • Java

  • Kotlin

import static sample.CustomSecurityMockMvcRequestPostProcessors.*;

...

mvc
	.perform(get("/").with(rob()))
import sample.CustomSecurityMockMvcRequestPostProcessors.*

//...

mvc.get("/") {
    with(rob())
}

在 Spring MVC 测试中使用注解模拟用户

除了使用 RequestPostProcessor 创建用户外，你还可以使用 测试方法安全 中描述的注解。例如，以下示例将使用用户（用户名 "user"，密码 "password"，角色 "ROLE_USER"）运行测试：

  • Java

  • Kotlin

@Test
@WithMockUser
public void requestProtectedUrlWithUser() throws Exception {
mvc
		.perform(get("/"))
		...
}
@Test
@WithMockUser
fun requestProtectedUrlWithUser() {
    mvc
        .get("/")
        // ...
}

或者，以下示例将使用用户（用户名 "user"，密码 "password"，角色 "ROLE_ADMIN"）运行测试：

  • Java

  • Kotlin

@Test
@WithMockUser(roles="ADMIN")
public void requestProtectedUrlWithUser() throws Exception {
mvc
		.perform(get("/"))
		...
}
@Test
@WithMockUser(roles = ["ADMIN"])
fun requestProtectedUrlWithUser() {
    mvc
        .get("/")
        // ...
}