# Spring Boot 测试模式 ## 概述该技能为为 Spring Boot 应用程序编写健壮的测试套件提供了全面的指导。它涵盖了 Mockito 的单元测试、Testcontainers 的集成测试、性能优化的切片测试模式以及维护快速反馈循环的最佳实践。 ## 何时使用此技能在以下情况下使用此技能： * 为服务、存储库或实用程序编写单元测试 * 使用测试容器实现与真实数据库的集成测试 * 设置性能优化的测试切片（@DataJpaTest、@WebMvcTest） * 配置 Spring Boot 3.5+ @ServiceConnection 进行容器管理 * 使用 MockMvc、TestRestTemplate 或 WebTestClient 测试 REST API * 通过上下文缓存和容器重用优化测试性能 * 设置 CI/CD 管道以进行集成测试 * 为单体或微服务应用程序实施全面的测试策略 ## 核心概念 ### 测试架构哲学 Spring Boot 测试遵循具有不同测试类型的分层方法： **1\.单元测试** * 快速、独立的测试，无需 Spring 上下文 * 使用Mockito进行依赖注入 * 专注于业务逻辑验证 * 目标完成时间：每次测试 < 50ms **2\.切片测试** * 特定层的最小 Spring 上下文加载 * 使用@DataJpaTest进行存储库测试 * 使用@WebMvcTest进行控制器测试 * 使用@WebFluxTest进行反应式控制器测试 * 目标完成时间：每次测试 < 100ms **3\.集成测试** * 具有真实依赖关系的完整 Spring 上下文 * 将@SpringBootTest与@ServiceConnection容器一起使用 * 测试完整的应用程序流程 * 目标完成时间：每次测试 < 500ms ### 关键测试注释 **Spring Boot测试注解：** * `@SpringBootTest`：加载完整的应用程序上下文（谨慎使用） * `@DataJpaTest`：仅加载 JPA 组件（存储库、实体） * `@WebMvcTest`：仅加载 MVC 层（控制器、@ControllerAdvice） * `@WebFluxTest`：仅加载 WebFlux 层（反应式控制器） * `@JsonTest`: 只加载 JSON 序列化组件 **测试容器注释：** * `@ServiceConnection`：将 Testcontainer 连接到 Spring Boot 测试（Spring Boot 3.5+） * `@DynamicPropertySource`：在运行时注册动态属性 * `@Testcontainers`: 启用 Testcontainers 生命周期管理 ## 依赖关系 ### Maven 依赖项 <依赖关系> <依赖关系> org.springframework.boot spring-boot-starter-test <范围>测试 <依赖关系> org.testcontainers junit-jupiter <版本>1.19.0 <范围>测试 <依赖关系> org.testcontainers postgresql <版本>1.19.0 <范围>测试 <依赖关系> org.springframework.boot spring-boot-starter-data-jpa <依赖关系> org.springframework.boot spring-boot-starter-web ### Gradle 依赖项依赖项{ // Spring Boot 测试启动器 testImplementation("org.springframework.boot:spring-boot-starter-test") // 测试容器 testImplementation("org.testcontainers:junit-jupiter:1.19.0") testImplementation("org.testcontainers:postgresql:1.19.0") // 附加依赖项实现（“org.springframework.boot：spring-boot-starter-data-jpa”）实现（“org.springframework.boot：spring-boot-starter-web”） } ## 说明 ### 单元测试模式使用模拟依赖项测试业务逻辑：类 UserServiceTest { @模拟私有 UserRepository 用户存储库； @InjectMocks 私有 UserService 用户服务； @BeforeEach 无效设置（）{ MockitoAnnotations.openMocks(this); } @测试无效shouldFindUserByIdWhenExists（）{ // 排列长用户ID=1L；用户用户=新用户(); user.setId(userId); user.setEmail("test@example.com"); when(userRepository.findById(userId)).thenReturn(Optional.of(user)); // 行动可选<用户> 结果 = userService.findById(userId); // 断言断言（结果）.isPresent（）; assertThat(result.get().getEmail()).isEqualTo("test@example.com"); verify(userRepository, times(1)).findById(userId); } } ### 切片测试模式对特定层使用重点测试切片： // 使用最少上下文进行存储库测试 @DataJpaTest @AutoConfigureTestDatabase（替换= AutoConfigureTestDatabase.Replace.NONE） @TestContainerConfig 公共类 UserRepositoryIntegrationTest { @Autowired 私有 UserRepository 用户存储库； @测试无效shouldSaveAndRetrieveUserFromDatabase（）{ // 排列用户用户=新用户(); user.setEmail("test@example.com"); user.setName("测试用户"); // 行动用户已保存 = userRepository.save(user); userRepository.flush(); 可选<用户>检索= userRepository.findByEmail(“test@example.com”); // 断言断言（检索）.isPresent（）； assertThat(retrieved.get().getName()).isEqualTo("测试用户"); } } ### REST API 测试模式使用 MockMvc 测试控制器以加快执行速度： @SpringBootTest @AutoConfigureMockMvc @事务性公共类 UserControllerIntegrationTest { @Autowired 私人 MockMvc 模拟Mvc； @Autowired 私有 ObjectMapper 对象映射器； @Autowired 私有 UserService 用户服务； @测试 void shouldCreateUserAndReturn201() 抛出异常 { 用户用户=新用户(); user.setEmail("newuser@example.com"); user.setName("新用户"); mockMvc.perform(post("/api/users") .contentType(MediaType.APPLICATION_JSON) .content(objectMapper.writeValueAsString(用户))) .andExpect(status().isCreated()) .andExpect(jsonPath("$.id").exists()) .andExpect(jsonPath("$.email").value("newuser@example.com")) .andExpect(jsonPath("$.name").value("新用户")); } } ### 使用@ServiceConnection 测试容器使用 Spring Boot 3.5+ 配置容器： @测试配置公共类 TestContainerConfig { @豆子 @服务连接公共 PostgreSQLContainer postgresContainer() { 返回新的 PostgreSQLContainer<>(DockerImageName.parse("postgres:16-alpine")) .withDatabaseName("testdb") .withUsername("测试") .withPassword("测试"); } } ## 示例 ### 基本单元测试 @测试无效应该计算总价格（）{ // 排列 OrderItem item1 = new OrderItem(); item1.setPrice(10.0); item1.setQuantity(2); OrderItem item2 = new OrderItem(); item2.setPrice(15.0); item2.setQuantity(1); List items = List.of(item1, item2); // 行动双总计 = orderService.calculateTotal(items); // 断言 assertThat(总计).isEqualTo(35.0); } ### 与测试容器的集成测试 @SpringBootTest @TestContainerConfig 公共类 OrderServiceIntegrationTest { @Autowired 私有 OrderService orderService； @Autowired 私有 UserRepository 用户存储库； @MockBean 私人 PaymentService 支付服务； @测试无效shouldCreateOrderWithRealDatabase（）{ // 排列用户用户=新用户(); user.setEmail("customer@example.com"); user.setName("约翰·多伊"); 用户保存的用户 = userRepository.save(user); OrderRequest 请求 = new OrderRequest(); request.setUserId(savedUser.getId()); request.setItems(列表.of( 新的订单项目请求（1L，2），新的订单项目请求（2L，1）））； when( paymentService.processPayment(any())).thenReturn(true); // 行动 OrderResponse 响应 = orderService.createOrder(request); // 断言 assertThat(response.getOrderId()).isNotNull(); assertThat(response.getStatus()).isEqualTo("COMPLETED"); 验证( paymentService, times(1)).processPayment(any()); } } ### 反应测试模式 @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) @AutoConfigureWebTestClient 公共类ReactiveUserControllerIntegrationTest { @Autowired 私有WebTestClient webTestClient； @测试无效shouldReturnUserAsJsonReactive() { // 排列用户用户=新用户(); user.setEmail("reactive@example.com"); user.setName("反应用户"); // 行动与断言 webTestClient.get() .uri(“/api/users/1”) .exchange() .expectStatus().isOk() .expectBody() .jsonPath("$.email").isEqualTo("reactive@example.com") .jsonPath("$.name").isEqualTo("反应用户"); } } ## 最佳实践 ### 1\.选择正确的测试类型根据范围选择适当的测试注释： // 使用 @DataJpaTest 进行仅存储库测试（最快） @DataJpaTest 公共类 UserRepositoryTest { } // 使用 @WebMvcTest 进行仅控制器测试 @WebMvcTest(UserController.class) 公共类 UserControllerTest { } // 仅使用@SpringBootTest进行完整的集成测试 @SpringBootTest 公共类 UserServiceFullIntegrationTest { } ### 2\.使用@ServiceConnection进行容器管理更喜欢使用“@ServiceConnection”而不是手动“@DynamicPropertySource”以获得更清晰的代码： // 好 - Spring Boot 3.5+ @测试配置公共类测试配置{ @豆子 @服务连接公共 PostgreSQLContainer postgres() { 返回新的 PostgreSQLContainer<>(DockerImageName.parse("postgres:16-alpine")); } } ### 3\.保持测试的确定性始终显式初始化测试数据： // 好 - 显式设置 @BeforeEach 无效设置（）{ userRepository.deleteAll(); 用户用户=新用户(); user.setEmail("test@example.com"); userRepository.save(用户); } // 避免 - 取决于其他测试 @测试无效测试用户存在（）{ // 假设之前的测试创建了一个用户可选 user = userRepository.findByEmail("test@example.com"); 断言（用户）.isPresent（）； } ### 4\.使用有意义的断言利用 AssertJ 获得可读、流畅的断言： // 好 - 清晰、可读的断言断言(user.getEmail()) .isEqualTo("test@example.com"); 断言（用户） .hasSize(3) .contains(expectedUser); // 避免 - JUnit 断言 assertEquals("test@example.com", user.getEmail()); assertTrue(users.size() == 3); ### 5\.按层组织测试将相关测试分组到单独的类中以优化上下文缓存： // 存储库测试（使用@DataJpaTest）公共类 UserRepositoryTest { } // 控制器测试（使用@WebMvcTest）公共类 UserControllerTest { } // 服务测试（使用模拟，无上下文）公共类 UserServiceTest { } // 完整的集成测试（使用@SpringBootTest）公共类 UserFullIntegrationTest { } ## 性能优化 ### 上下文缓存策略通过对具有相似配置的测试进行分组来最大化 Spring 上下文缓存： // 将具有相同配置的存储库测试分组 @DataJpaTest @AutoConfigureTestDatabase（替换= AutoConfigureTestDatabase.Replace.NONE） @TestContainerConfig @TestPropertySource(属性 = "spring.datasource.url=jdbc:postgresql:testdb") 公共类 UserRepositoryTest { } // 使用相同配置进行组控制器测试 @WebMvcTest(UserController.class) @AutoConfigureMockMvc 公共类 UserControllerTest { } ### 容器重用策略在 JVM 级别重用测试容器以获得更好的性能： @测试容器公共类ContainerConfig { 静态最终 PostgreSQLContainer POSTGRES = new PostgreSQLContainer<>( DockerImageName.parse("postgres:16-alpine")) .withDatabaseName("testdb") .withUsername("测试") .withPassword("测试"); @之前所有静态无效startAll（）{ POSTGRES.start(); } @毕竟静态无效stopAll（）{ POSTGRES.stop(); } } ## 测试执行 ### Maven 测试执行 # 运行所有测试 ./mvnw测试 # 运行特定的测试类 ./mvnw测试-Dtest=UserServiceTest # 仅运行集成测试 ./mvnw 测试-Dintegration-test=true # 运行覆盖率测试 ./mvnw clean jacoco:准备代理测试 jacoco:报告 ### Gradle 测试执行 # 运行所有测试 ./gradlew测试 # 运行特定的测试类 ./gradlew 测试 --测试 UserServiceTest # 仅运行集成测试 ./gradlew 集成测试 # 运行覆盖率测试 ./gradlew 测试 jacocoTestReport ## CI/CD 配置 ### GitHub 操作示例名称：Spring Boot 测试上：[推，拉请求] 职位：测试：运行：ubuntu-latest 服务： postgres：图片：postgres：16-alpine 环境： POSTGRES_PASSWORD：测试 POSTGRES_USER：测试 POSTGRES_DB：测试数据库选项：>- --health-cmd pg_isready --健康间隔10s --健康超时5秒 --健康重试 5 步骤： - 使用：actions/checkout@v3 - 名称：设置 JDK 17 使用：actions/setup-java@v3 与： java 版本：'17' 分布：“铁木林” - 名称：缓存 Maven 依赖项使用：actions/cache@v3 与：路径：~/.m2/存储库关键： ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }} 恢复密钥：${{ runner.os }}-maven- - 名称：运行测试运行： ./mvnw test -Dspring.profiles.active=test ### Docker Compose 用于本地测试版本：'3.8' 服务： postgres：图片：postgres：16-alpine 环境： POSTGRES_DB：测试数据库 POSTGRES_USER：测试 POSTGRES_PASSWORD：测试端口： - “5432:5432” 卷： - postgres_data:/var/lib/postgresql/data 卷： postgres_数据： ## 参考文献有关详细信息，请参阅以下资源： * [API参考]() \- 完整的测试注释和实用程序 * [最佳实践]() \- 测试模式和优化 * [工作流程模式]() \- 完整的集成测试示例 ## 相关技能 * **spring-boot-dependency-injection** \- 使用构造函数注入进行单元测试模式 * **spring-boot-rest-api-standards** \- 要测试的 REST API 模式 * **spring-boot-crud-patterns** \- 要测试的 CRUD 模式 * **单元测试服务层** \- 高级服务层测试技术 ## 绩效目标 * **单元测试**：每次测试< 50ms * **切片测试**：每次测试 < 100 毫秒 * **集成测试**：每次测试< 500ms * **通过对具有相同配置的测试进行分组来最大化上下文缓存** * **尽可能在 JVM 级别重用测试容器** ## 关键原则 1. 使用测试切片进行集中、快速的测试 2. 在 Spring Boot 3.5+ 上更喜欢@ServiceConnection 3. 通过显式设置保持测试的确定性 4. 模拟外部依赖，使用真实数据库 5.除非绝对必要，否则避免使用@DirtiesContext 6. 按层组织测试以优化上下文重用 ## 限制和警告 * 除非绝对必要，否则切勿使用“@DirtiesContext”，因为它会强制重建上下文。 * 避免将“@MockBean”与不同的配置混合，因为它会创建单独的上下文。 * 测试容器需要Docker；确保 CI/CD 管道有 Docker 支持。 * 不依赖测试执行顺序；每个测试必须是独立的。 * 请谨慎使用“@TestPropertySource”，因为它会创建单独的上下文。 * 不要使用`@SpringBootTest`进行单元测试；使用普通的 Mockito 代替。 * 不同的`@MockBean`配置可以使上下文缓存失效。 * 在测试中避免静态可变状态，因为它可能导致不稳定的测试。这项技能可以构建全面的测试套件，可靠地验证 Spring Boot 应用程序，同时保持快速的开发反馈循环。

Spring Boot 测试模式

包含技能