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