在 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 執行，該權杖具有指定 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("/")
        // ...
}