在 Spring MVC 测试中以用户身份运行测试

通常希望以特定用户身份运行测试。有两种简单的方法可以填充用户

使用 RequestPostProcessor 在 Spring MVC 测试中以用户身份运行

您可以使用多种选项将用户与当前的 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（不需要存在）以具有指定 UserDetails 作为主体的 UsernamePasswordAuthenticationToken 运行

  • 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("/")
        // ...
}