测试

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 的参考文档。

为包含在切片测试中的 @Configuration 类进行结构设计

切片测试通过限制 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 的精细类，可以使得仅为特定的切片测试导入它们。