springboot 单元测试（长文解析）

💡一则或许对你有用的小广告

欢迎加入小哈的星球 ，你将获得：专属的项目实战 / 1v1 提问 / Java 学习路线 / 学习打卡 / 每月赠书 / 社群讨论

• 新项目:《从零手撸：仿小红书（微服务架构）》 正在持续爆肝中，基于 Spring Cloud Alibaba + Spring Boot 3.x + JDK 17...，点击查看项目介绍 ;演示链接： http://116.62.199.48:7070 ;
• 《从零手撸：前后端分离博客项目（全栈开发）》 2 期已完结，演示链接： http://116.62.199.48/ ;

截止目前， 星球 内专栏累计输出 90w+ 字，讲解图 3441+ 张，还在持续爆肝中.. 后续还会上新更多项目，目标是将 Java 领域典型的项目都整一波，如秒杀系统, 在线商城, IM 即时通讯，权限管理，Spring Cloud Alibaba 微服务等等，已有 3100+ 小伙伴加入学习 ，欢迎点击围观

单元测试的重要性：程序的“安全网”

在软件开发中，单元测试是保障代码质量的重要环节。它如同程序的“体检”，通过验证代码的最小功能单元（如方法或类）是否符合预期，帮助开发者尽早发现并修复问题。对于 Spring Boot 这样的框架，单元测试不仅能确保单个组件的正确性，还能减少因集成测试带来的复杂度。

为什么需要单元测试？

1. 降低风险：在修改或重构代码时，通过单元测试可以快速验证功能是否受损。
2. 提高可维护性：清晰的测试用例能帮助团队理解代码逻辑，降低长期维护成本。
3. 加速开发：自动化测试能替代人工手动验证，节省时间。

单元测试与集成测试的区别

环境准备：搭建 Spring Boot 单元测试环境

要开始单元测试，需确保项目中已引入相关依赖。在 Spring Boot 中，单元测试通常依赖以下工具：

• JUnit 5：主流的测试框架，提供 @Test 等注解。
• Spring Boot Test：集成 Spring 测试支持，如 @SpringBootTest。
• Mockito（可选）：用于模拟对象行为，减少对真实依赖的依赖。

Maven 依赖配置示例

<dependencies>
    <!-- Spring Boot 测试支持 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
    <!-- Mockito 用于模拟对象 -->
    <dependency>
        <groupId>org.mockito</groupId>
        <artifactId>mockito-core</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

基础案例：编写第一个 Spring Boot 单元测试

案例场景：用户服务测试

假设有一个简单的用户服务类 UserService，包含一个 getUserById 方法：

@Service
public class UserService {
    public User getUserById(Long id) {
        // 模拟从数据库查询
        if (id == 1L) {
            return new User(1L, "张三", 25);
        }
        return null;
    }
}

测试用例设计

我们需要验证以下场景：

1. 当 id 存在时，返回正确的用户对象。
2. 当 id 不存在时，返回 null。

测试类编写

使用 JUnit 5 和 Spring Boot Test 注解：

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
public class UserServiceTest {

    @Autowired
    private UserService userService;

    @BeforeEach
    void setUp() {
        // 初始化操作（可选）
    }

    @Test
    void testGetUserById_ExistingUser() {
        User user = userService.getUserById(1L);
        assertNotNull(user);
        assertEquals("张三", user.getName());
        assertEquals(25, user.getAge());
    }

    @Test
    void testGetUserById_NonExistingUser() {
        User user = userService.getUserById(2L);
        assertNull(user);
    }
}

关键注解解释

• @SpringBootTest：启动 Spring Boot 应用上下文，加载所有配置。
• @Autowired：注入被测试的 Bean。
• @BeforeEach：在每个测试方法前执行初始化代码。

进阶技巧：Mock 对象与参数化测试

使用 Mockito 模拟依赖

在实际开发中，服务类可能依赖其他组件（如数据库或第三方 API）。直接调用真实依赖会降低测试速度并引入外部风险。此时，可以使用 Mockito 创建模拟对象。

案例：模拟数据库操作

假设 UserService 依赖 UserRepository：

@Service
public class UserService {
    @Autowired
    private UserRepository userRepository;

    public User getUserById(Long id) {
        return userRepository.findById(id);
    }
}

测试时，我们不需要真实数据库，而是模拟 UserRepository 的行为：

import static org.mockito.Mockito.*;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.mock.mockito.MockBean;

@SpringBootTest
public class UserServiceWithMockTest {

    @Autowired
    private UserService userService;

    @MockBean
    private UserRepository userRepository;

    @Test
    void testGetUserById_Mocked() {
        // 定义模拟行为：当 id=1 时返回指定用户
        when(userRepository.findById(1L))
            .thenReturn(new User(1L, "张三", 25));

        // 执行被测试方法
        User user = userService.getUserById(1L);

        // 验证调用逻辑
        assertNotNull(user);
        verify(userRepository, times(1)).findById(1L);
    }
}

参数化测试：批量验证多种输入

JUnit 5 提供了 @ParameterizedTest 注解，可轻松测试多个输入组合。例如，验证用户年龄的合法性：

import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;

public class UserValidationTest {

    @ParameterizedTest
    @ValueSource(longs = {1L, 2L, 3L})
    void testValidUserIds(Long id) {
        // 验证 id >= 1
        assertTrue(id >= 1);
    }
}

最佳实践：让测试更健壮

1. 保持测试独立性

每个测试方法应独立运行，避免依赖其他测试的结果。例如：

@Test
void testMethod1() {
    // 不应修改共享资源
}

@Test
void testMethod2() {
    // 不应依赖 testMethod1 的结果
}

2. 命名规范：清晰表达测试意图

@Test
void testCalculateTotal_CorrectResult_WhenPositiveNumbers() { /* ... */ }

3. 避免副作用

测试结束后应清理资源，例如关闭数据库连接或重置模拟对象状态。

常见问题与解决方案

Q1: 测试不通过，但代码逻辑正确？

可能原因：

• 未正确注入依赖（如未使用 @MockBean）。
• 测试用例与代码逻辑不匹配（如断言条件错误）。

解决方案：

1. 检查依赖注入是否正确。
2. 使用调试工具逐步跟踪代码执行流程。

Q2: 测试运行缓慢？

优化建议：

• 减少 @SpringBootTest 的使用，改用更轻量级的注解（如 @WebMvcTest）。
• 对外部依赖使用模拟对象。

结论：单元测试是代码质量的基石

通过本文，我们从基础到进阶学习了 Spring Boot 单元测试的核心概念、工具和技巧。无论是编程初学者还是中级开发者，掌握单元测试都能显著提升代码的健壮性和开发效率。

实践建议：

1. 为每个新功能编写单元测试。
2. 定期运行测试并分析覆盖率报告。
3. 结合工具（如 IntelliJ IDEA 的测试插件）简化测试流程。

通过持续实践，单元测试将成为你开发过程中的得力助手，帮助你构建更可靠、可维护的 Spring Boot 应用。