Spring Boot 项目测试最佳实践

欢迎来到 Spring Boot 测试实践交互式指南。本指南旨在将复杂的测试概念转化为易于理解和探索的模块。我们将从核心理念“测试金字塔”出发，了解关键工具，深入研究不同测试层级的具体实践，并最终为您提供一套可直接用于项目的测试规范。您可以通过顶部导航栏快速跳转至感兴趣的部分。

测试金字塔：核心理念

测试金字塔是一种策略，它指导我们编写不同类型的测试并保持它们的比例。其核心思想是：编写大量快速的单元测试，少量中速的集成测试，以及极少量慢速的端到端(E2E)测试。这种结构确保了测试套件的健壮性、快速反馈和低维护成本。

单元测试 (Unit)

焦点： 单个类或方法。
速度： 极快 (毫秒级)。
特点： 隔离、不启动 Spring 上下文、大量使用 Mock。

集成测试 (Integration)

焦点： 模块间交互 (如 Service-Repo, Controller-Service)。
速度： 中等 (秒级)。
特点： 启动部分或全部 Spring 上下文、使用内存数据库或 Testcontainers。

端到端测试 (E2E)

焦点： 完整的业务流程 (如 API-DB, UI-API-DB)。
速度： 慢 (秒级到分钟级)。
特点： 模拟真实用户操作、启动完整应用、覆盖关键路径。

核心工具栈

Spring Boot 生态系统提供了一套强大的工具来支持分层测试。以下是构建健壮测试套件时最常使用的核心库。

J5

JUnit 5

Java 测试的事实标准。提供 @Test, @BeforeEach, @DisplayName 等注解以及丰富的断言 API。

M

Mockito

最流行的 Mock 框架。用于创建和配置模拟对象（Mocks），以便在单元测试中隔离依赖。

A

AssertJ

一个流式的断言库，提供比标准 JUnit 断言更易读、更丰富的 API。例如 assertThat(list).hasSize(3).contains("A");

S

Spring Boot Test

Spring Boot 提供的测试支持库。包含 @SpringBootTest, 测试切片 (Slices) 以及自动配置等功能。

R

RestAssured

一个用于测试 REST API 的强大库。提供简洁的 BDD 风格 Gherkin 语法来发送请求和验证响应。

T

Testcontainers

在 Docker 容器中运行真实依赖（如数据库、消息队列）进行集成测试的库。提供了极高的测试保真度。

测试分层详解 (交互式)

理解不同测试层级的目标、工具和实践至关重要。点击下方的标签页，探索每一层的具体实现、关键注解和代码示例。

🧪 单元测试 (Unit)

目标： 验证单个类（如 Service, Controller, Component）的逻辑是否正确，完全隔离其依赖。

关键工具： JUnit 5, Mockito, AssertJ
Spring 上下文： 不加载。
注解： @Test, @ExtendWith(MockitoExtension.class), @Mock, @InjectMocks
实践： 对所有外部依赖（如 Repository, Service, Client）使用 @Mock。使用 @InjectMocks 自动注入 Mock 到被测类中。


// 示例：测试一个 UserService
@ExtendWith(MockitoExtension.class)
class UserServiceTest {

    @Mock
    private UserRepository userRepository;

    @InjectMocks
    private UserService userService;

    @Test
    void shouldRegisterUserSuccessfully() {
        // Given (给定)
        User newUser = new User("testUser", "pwd123");
        when(userRepository.findByUsername("testUser")).thenReturn(Optional.empty());
        when(userRepository.save(any(User.class))).thenReturn(newUser);

        // When (当)
        User registeredUser = userService.register(newUser);

        // Then (那么)
        assertThat(registeredUser).isNotNull();
        assertThat(registeredUser.getUsername()).isEqualTo("testUser");
        verify(userRepository, times(1)).findByUsername("testUser");
        verify(userRepository, times(1)).save(newUser);
    }
}

🧩 集成测试 (Integration)

目标： 验证多个组件协同工作的正确性。Spring 提供了“测试切片”来只加载相关上下文，提高速度。

关键工具： Spring Boot Test, JUnit 5, MockMvc, Testcontainers, H2/内存数据库
Spring 上下文： 加载部分 (切片) 或全部。
切片注解：
- @WebMvcTest(MyController.class): 只测试 Web 层 (Controller)，Mock Service 层。
- @DataJpaTest: 只测试 JPA 层 (Repository)，使用内存数据库。
- @SpringBootTest: (重量级) 加载完整上下文，用于测试 Service-Repo 真实集成。


// 示例：使用 @WebMvcTest 测试 Controller
@WebMvcTest(UserController.class)
class UserControllerTest {

    @Autowired
    private MockMvc mockMvc;

    @MockBean
    private UserService userService;

    @Test
    void shouldReturnUserWhenFound() throws Exception {
        // Given
        User user = new User(1L, "testUser");
        when(userService.findById(1L)).thenReturn(Optional.of(user));

        // When & Then
        mockMvc.perform(get("/api/users/1")
                .contentType(MediaType.APPLICATION_JSON))
                .andExpect(status().isOk())
                .andExpect(jsonPath("$.username").value("testUser"));
    }
}

🌐 端到端测试 (E2E)

目标： 模拟真实用户场景，从 API 入口到数据库，验证完整的业务流程。通常只覆盖最关键的核心路径 (Happy Path)。

关键工具： @SpringBootTest, RestAssured, Testcontainers
Spring 上下文： 完整加载。
注解： @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
实践： 启动一个运行在随机端口的真实应用。使用 RestAssured 发送真实 HTTP 请求。使用 Testcontainers 启动真实数据库。


// 示例：使用 @SpringBootTest 和 RestAssured
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@Testcontainers
class UserE2ETest {

    @LocalServerPort
    private int port;

    @Container
    static PostgreSQLContainer postgres = new PostgreSQLContainer<>("postgres:15-alpine");

    @DynamicPropertySource
    static void setDatasourceProperties(DynamicPropertyRegistry registry) {
        registry.add("spring.datasource.url", postgres::getJdbcUrl);
        registry.add("spring.datasource.username", postgres::getUsername);
        registry.add("spring.datasource.password", postgres::getPassword);
    }
    
    @BeforeEach
    void setup() {
        RestAssured.port = port;
        // 清理数据库...
    }

    @Test
    void shouldRegisterAndLoginUser() {
        // Given: 注册
        String registerJson = "{\"username\": \"e2eUser\", \"password\": \"e2ePass\"}";
        given()
            .contentType(ContentType.JSON)
            .body(registerJson)
        .when()
            .post("/api/register")
        .then()
            .statusCode(201);

        // When & Then: 登录
        String loginJson = "{\"username\": \"e2eUser\", \"password\": \"e2ePass\"}";
        given()
            .contentType(ContentType.JSON)
            .body(loginJson)
        .when()
            .post("/api/login")
        .then()
            .statusCode(200)
            .body("token", notNullValue());
    }
}

项目测试规范 (Checklist)

这是一套用于指导日常开发的测试规范。遵循这些实践可以显著提高代码质量、可维护性和团队协作效率。

✓ 命名规范： 测试类命名为 [ClassName]Test。测试方法命名应清晰描述场景，如 should[DoSomething]When[SomeCondition]。
✓ 结构清晰： 遵循 Given-When-Then (或 Arrange-Act-Assert) 结构组织测试代码，使用注释或空行分隔。
✓ 使用 AssertJ： 优先使用 AssertJ 进行断言，以增强可读性 (assertThat(result).isEqualTo(expected))。
✓ 单元测试隔离： 单元测试必须使用 Mockito 隔离所有外部依赖（数据库、其他 Service、API Client）。
✓ 优先使用测试切片： 编写集成测试时，优先使用 @WebMvcTest, @DataJpaTest 等切片注解，而不是重量级的 @SpringBootTest。
✓ 数据库隔离： 集成测试必须使用 H2、HSQLDB 等内存数据库，或使用 Testcontainers 启动的真实数据库实例，确保测试可重复执行。
✓ 配置分离： 测试环境应有独立的配置文件 application-test.properties (或 .yml)，并通过 @ActiveProfiles("test") 激活。
✓ 覆盖率目标： 追求有意义的覆盖率，而不是盲目追求行覆盖率。重点覆盖核心业务逻辑和边界条件。单元测试应达到高覆盖率（如 80%+）。
✓ CI/CD 集成： 所有测试必须在 CI/CD 管道中自动执行。构建失败的提交（Test Failed）不允许被合并。