当前位置：首页 > news >正文

Spring Boot 测试最佳实践：构建可靠的测试体系

news 2026/8/7 17:27:50

Spring Boot 测试最佳实践：构建可靠的测试体系

别叫我大神，叫我 Alex 就好。

一、引言

大家好，我是 Alex。在软件开发中，测试是确保代码质量和功能正确性的重要环节。Spring Boot 作为 Java 生态中最流行的框架之一，提供了丰富的测试工具和支持。今天，我想和大家分享一下 Spring Boot 测试的最佳实践，帮助大家构建可靠的测试体系，确保应用的质量和稳定性。

二、测试类型

1. 单元测试

测试范围：单个类或方法
测试工具：JUnit 5、Mockito
执行速度：快速

2. 集成测试

测试范围：多个组件或模块
测试工具：Spring Test、Testcontainers
执行速度：中等

3. 端到端测试

测试范围：整个应用
测试工具：Selenium、RestAssured
执行速度：较慢

三、测试工具

1. JUnit 5

JUnit 5 核心组件：

JUnit Jupiter：新的编程和扩展模型
JUnit Vintage：兼容 JUnit 3 和 4
JUnit Platform：测试框架的基础平台

基本注解：

@Test：标记测试方法
@BeforeEach：每个测试方法执行前
@AfterEach：每个测试方法执行后
@BeforeAll：所有测试方法执行前
@AfterAll：所有测试方法执行后
@DisplayName：测试方法名称
@Disabled：禁用测试方法

2. Mockito

Mock 模拟：

模拟外部依赖
控制方法返回值
验证方法调用

基本用法：

// 创建 mock 对象 UserRepository userRepository = Mockito.mock(UserRepository.class); // 设置 mock 行为 User expectedUser = new User(1L, "alex"); Mockito.when(userRepository.findById(1L)).thenReturn(Optional.of(expectedUser)); // 验证方法调用 Mockito.verify(userRepository, Mockito.times(1)).findById(1L);

3. Spring Test

Spring 测试支持：

加载 Spring 应用上下文
依赖注入
事务管理
测试切片

测试注解：

@SpringBootTest：加载完整的应用上下文
@WebMvcTest：测试 Web 控制器
@DataJpaTest：测试 JPA 存储库
@RestClientTest：测试 REST 客户端
@MockBean：模拟 Spring Bean

四、最佳实践

1. 测试结构

测试目录结构：

src/ ├── main/ │ └── java/ │ └── com/example/ │ ├── controller/ │ ├── service/ │ └── repository/ └── test/ └── java/ └── com/example/ ├── controller/ ├── service/ └── repository/

测试命名规范：

测试类：{被测类}Test
测试方法：test{测试场景}

2. 单元测试

最佳实践：

测试单个方法的功能
模拟所有外部依赖
测试正常和异常情况
保持测试方法短小精悍

示例：

@ExtendWith(MockitoExtension.class) class UserServiceTest { @Mock private UserRepository userRepository; @InjectMocks private UserService userService; @Test void testFindUserById() { // 准备 User expectedUser = new User(1L, "alex"); Mockito.when(userRepository.findById(1L)).thenReturn(Optional.of(expectedUser)); // 执行 User actualUser = userService.findUserById(1L); // 验证 assertEquals(expectedUser, actualUser); Mockito.verify(userRepository, Mockito.times(1)).findById(1L); } @Test void testFindUserById_NotFound() { // 准备 Mockito.when(userRepository.findById(1L)).thenReturn(Optional.empty()); // 执行 & 验证 assertThrows(UserNotFoundException.class, () -> { userService.findUserById(1L); }); Mockito.verify(userRepository, Mockito.times(1)).findById(1L); } }

3. 集成测试

最佳实践：

测试组件之间的交互
使用内存数据库
测试 REST API
保持测试环境隔离

示例：

@SpringBootTest @AutoConfigureMockMvc class UserControllerIntegrationTest { @Autowired private MockMvc mockMvc; @MockBean private UserService userService; @Test void testGetUserById() throws Exception { // 准备 User user = new User(1L, "alex"); Mockito.when(userService.findUserById(1L)).thenReturn(user); // 执行 & 验证 mockMvc.perform(get("/api/users/1")) .andExpect(status().isOk()) .andExpect(jsonPath("$.id").value(1)) .andExpect(jsonPath("$.name").value("alex")); } @Test void testGetUserById_NotFound() throws Exception { // 准备 Mockito.when(userService.findUserById(1L)).thenThrow(new UserNotFoundException()); // 执行 & 验证 mockMvc.perform(get("/api/users/1")) .andExpect(status().isNotFound()); } }

4. 数据库测试

使用 H2 内存数据库：

@DataJpaTest class UserRepositoryTest { @Autowired private UserRepository userRepository; @Autowired private TestEntityManager entityManager; @Test void testSaveUser() { // 准备 User user = new User(null, "alex"); // 执行 User savedUser = userRepository.save(user); // 验证 assertNotNull(savedUser.getId()); assertEquals("alex", savedUser.getName()); // 从数据库中获取并验证 User foundUser = entityManager.find(User.class, savedUser.getId()); assertEquals(savedUser, foundUser); } @Test void testFindByUsername() { // 准备 User user = new User(null, "alex"); entityManager.persist(user); entityManager.flush(); // 执行 Optional<User> foundUser = userRepository.findByUsername("alex"); // 验证 assertTrue(foundUser.isPresent()); assertEquals("alex", foundUser.get().getName()); } }

5. 测试配置

测试配置类：

@TestConfiguration public class TestConfig { @Bean public UserService userService(UserRepository userRepository) { return new UserServiceImpl(userRepository); } @Bean public PasswordEncoder passwordEncoder() { return NoOpPasswordEncoder.getInstance(); } }

测试属性：

# application-test.yml spring: datasource: url: jdbc:h2:mem:testdb username: sa password: driver-class-name: org.h2.Driver jpa: hibernate: ddl-auto: create-drop show-sql: true

6. 测试覆盖率

JaCoCo 配置：

<plugin> <groupId>org.jacoco</groupId> <artifactId>jacoco-maven-plugin</artifactId> <version>0.8.7</version> <executions> <execution> <goals> <goal>prepare-agent</goal> </goals> </execution> <execution> <id>report</id> <phase>test</phase> <goals> <goal>report</goal> </goals> </execution> </executions> <configuration> <rules> <rule implementation="org.jacoco.maven.RuleConfiguration"> <element>CLASS</element> <limits> <limit implementation="org.jacoco.report.check.Limit"> <counter>LINE</counter> <value>COVEREDRATIO</value> <minimum>0.8</minimum> </limit> </limits> </rule> </rules> </configuration> </plugin>

五、高级测试技巧

1. 参数化测试

@ParameterizedTest @ValueSource(ints = {1, 2, 3}) void testWithValueSource(int argument) { assertTrue(argument > 0 && argument < 4); } @ParameterizedTest @CsvSource({ "1, one", "2, two", "3, three" }) void testWithCsvSource(int id, String name) { assertNotNull(id); assertNotNull(name); }

2. 测试容器

Testcontainers：

@Testcontainers class DatabaseIntegrationTest { @Container private static final MySQLContainer<?> mysqlContainer = new MySQLContainer<>() .withDatabaseName("test") .withUsername("test") .withPassword("test"); @DynamicPropertySource static void registerProperties(DynamicPropertyRegistry registry) { registry.add("spring.datasource.url", mysqlContainer::getJdbcUrl); registry.add("spring.datasource.username", mysqlContainer::getUsername); registry.add("spring.datasource.password", mysqlContainer::getPassword); } @Autowired private UserRepository userRepository; @Test void testSaveUser() { // 测试代码 } }

3. 模拟 Web 服务

WireMock：

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) class ExternalServiceTest { @Autowired private TestRestTemplate restTemplate; @LocalServerPort private int port; @Rule public WireMockRule wireMockRule = new WireMockRule(8089); @Test void testExternalServiceCall() { // 模拟外部服务 wireMockRule.stubFor(get(urlEqualTo("/api/external")) .willReturn(aResponse() .withStatus(200) .withHeader("Content-Type", "application/json") .withBody("{\"status\": \"success\"}")); // 执行测试 String url = "http://localhost:" + port + "/api/internal"; ResponseEntity<String> response = restTemplate.getForEntity(url, String.class); // 验证 assertEquals(HttpStatus.OK, response.getStatusCode()); } }