对于最新的稳定版本,请使用 Spring Boot 3.4.0spring-doc.cn

测试

Spring Boot 包括许多测试实用程序和支持类,以及一个提供常见测试依赖项的专用Starters。 本节回答有关测试的常见问题。spring-doc.cn

使用 Spring Security 进行测试

Spring Security 支持以特定用户身份运行测试。 例如,下面代码段中的测试将使用具有该角色的经过身份验证的用户运行。ADMINspring-doc.cn

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.MockMvc;

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;

@WebMvcTest(UserController.class)
class MySecurityTests {

	@Autowired
	private MockMvc mvc;

	@Test
	@WithMockUser(roles = "ADMIN")
	void requestProtectedUrlWithUser() throws Exception {
		this.mvc.perform(get("/"));
	}

}
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.MockMvc
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders

@WebMvcTest(UserController::class)
class MySecurityTests(@Autowired val mvc: MockMvc) {

	@Test
	@WithMockUser(roles = ["ADMIN"])
	fun requestProtectedUrlWithUser() {
		mvc.perform(MockMvcRequestBuilders.get("/"))
	}

}

Spring Security 提供了与 Spring MVC Test 的全面集成,这也可以在使用 @WebMvcTest slice 和 MockMvc 测试控制器时使用。spring-doc.cn

有关 Spring Security 的测试支持的更多详细信息,请参阅 Spring Security 的参考文档spring-doc.cn

构建@Configuration Slice 测试中包含的类

切片测试的工作原理是将 Spring Framework 的组件扫描限制为基于其类型的一组有限的组件。 对于不是通过组件扫描创建的任何 bean,例如,使用 @Bean 注解创建的 bean,切片测试将无法在应用程序上下文中包含/排除它们。 请考虑以下示例:spring-doc.cn

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,以便可以测试控制器端点是否得到正确保护。 但是,@WebMvcTest 的组件扫描筛选条件不会选取它,因为它与筛选条件指定的任何类型都不匹配。 您可以通过使用 . 这将加载所有 bean,包括 HikariDataSource bean,这在测试 web 层时不是必需的。 将 configuration 类拆分为两个将允许仅导入 security configuration。MyConfiguration@Import(MyConfiguration.class)MyConfigurationspring-doc.cn

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 包含在 slice 测试中时,拥有单个配置类可能效率低下。 相反,将应用程序的配置构建为具有特定域的 bean 的多个细粒度类可以允许仅针对特定切片测试导入它们。spring-doc.cn