Testing
Spring Boot 提供了多个测试工具和辅助类，以及一个专用的 starter，用于提供常见的测试依赖。本节将解答有关测试的常见问题。
使用 Spring Security 进行测试
Spring Security 提供了以特定用户身份运行测试的支持。例如，下面代码片段中的测试将以一个拥有 ADMIN 角色的已认证用户身份运行。
- Java
- Kotlin
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.security.test.context.support.WithMockUser;
import org.springframework.test.web.servlet.assertj.MockMvcTester;
import static org.assertj.core.api.Assertions.assertThat;
@WebMvcTest(UserController.class)
class MySecurityTests {
@Autowired
private MockMvcTester mvc;
@Test
@WithMockUser(roles = "ADMIN")
void requestProtectedUrlWithUser() {
assertThat(this.mvc.get().uri("/")).doesNotHaveFailed();
}
}
import org.assertj.core.api.Assertions.assertThat
import org.junit.jupiter.api.Test
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest
import org.springframework.security.test.context.support.WithMockUser
import org.springframework.test.web.servlet.assertj.MockMvcTester
@WebMvcTest(UserController::class)
class MySecurityTests(@Autowired val mvc: MockMvcTester) {
@Test
@WithMockUser(roles = ["ADMIN"])
fun requestProtectedUrlWithUser() {
assertThat(mvc.get().uri("/"))
.doesNotHaveFailed()
}
}
Spring Security 提供了与 Spring MVC Test 的全面集成，当使用 @WebMvcTest 切片和 MockMvc 测试控制器时，也可以使用该集成。
有关 Spring Security 测试支持的更多详细信息，请参阅 Spring Security 的参考文档。
用于包含在 Slice 测试中的结构体类
切片测试通过根据组件的类型将 Spring Framework 的组件扫描限制在有限的一组组件内来工作。对于那些不是通过组件扫描创建的 Bean（例如，使用 @Bean 注解创建的 Bean），切片测试将无法将它们包含或排除在应用上下文之外。请看以下示例：
import com.zaxxer.hikari.HikariDataSource;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.jdbc.DataSourceBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.web.SecurityFilterChain;
@Configuration(proxyBeanMethods = false)
public class MyConfiguration {
@Bean
public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
http.authorizeHttpRequests((requests) -> requests.anyRequest().authenticated());
return http.build();
}
@Bean
@ConfigurationProperties("app.datasource.second")
public HikariDataSource secondDataSource() {
return DataSourceBuilder.create().type(HikariDataSource.class).build();
}
}
对于一个包含上述 @Configuration 类的应用程序，你可能会期望在 @WebMvcTest 中将 SecurityFilterChain bean 加载到应用上下文中，以便测试你的控制器端点是否被正确地保护。然而，MyConfiguration 并不会被 @WebMvcTest 的组件扫描过滤器所加载，因为它不匹配该过滤器指定的任何类型。你可以通过在测试类上添加 @Import(MyConfiguration.class) 注解来显式地包含该配置。但这会加载 MyConfiguration 中的所有 bean，包括在测试 Web 层时并不需要的 HikariDataSource bean。将配置类拆分为两个，就可以只导入安全相关的配置。
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.web.SecurityFilterChain;
@Configuration(proxyBeanMethods = false)
public class MySecurityConfiguration {
@Bean
public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
http.authorizeHttpRequests((requests) -> requests.anyRequest().authenticated());
return http.build();
}
}
import com.zaxxer.hikari.HikariDataSource;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.jdbc.DataSourceBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration(proxyBeanMethods = false)
public class MyDatasourceConfiguration {
@Bean
@ConfigurationProperties("app.datasource.second")
public HikariDataSource secondDataSource() {
return DataSourceBuilder.create().type(HikariDataSource.class).build();
}
}
当某个特定领域的 Bean 需要包含在切片测试中时，使用单一的配置类可能会效率低下。相反，将应用程序的配置结构化为多个细粒度的类，每个类仅包含特定领域的 Bean，这样就可以只为特定的切片测试导入所需的配置。
降级 Testcontainers Docker API 版本
Docker Desktop 的最新版本不再支持 Spring Boot 所管理的 Testcontainers 依赖项所使用的默认 API 版本。为帮助避免此类问题，Spring Boot 在 spring-boot-testcontainers 和 spring-boot-test jar 包中附带了 docker-java.properties 文件，用于升级 Testcontainers 所使用的 API 版本。
如果你不希望 API 版本被更改，应该在你自己的项目 classpath 中添加一个 docker-java.properties 文件。一个空文件将恢复默认行为，或者你可以设置 api.version 属性为你偏好的任意值。