在 Spring MVC Test 中以使用者身份執行測試

通常需要以特定使用者身份執行測試。有兩種簡單的方法可以填充使用者。

在 Spring MVC Test 中使用 RequestPostProcessor 以使用者身份執行
在 Spring MVC Test 中使用註解以使用者身份執行

在 Spring MVC Test 中使用 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 Test 中使用註解以使用者身份執行

作為使用 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("/")
        // ...
}