Spring Boot框架下的单元测试

news2025/2/4 7:00:02

1. 什么是单元测试

1.1 基本定义

  • 单元测试(Unit Test) 是对软件开发中最小可测单位（例如一个方法或者一个类）进行验证的一种测试方式。
  • 在 Java 后端的 Spring Boot 项目中，单元测试通常会借助 JUnit、Mockito 等框架对代码中核心逻辑进行快速且隔离的验证，保证功能正确性。

目的：及早发现并修复 BUG，使后续迭代功能或重构时能迅速验证不会破坏已实现的功能。

1.2 单元测试在 Spring Boot 中的地位

  • Spring Boot 提供了非常方便的测试支持，如 @SpringBootTest、@TestConfiguration 等注解，让开发者可以快速地在带有 Spring 容器上下文的环境中执行测试。
  • Spring Boot 本身也对 JUnit、Mockito、AssertJ 等常用测试框架或库提供了开箱即用的整合或依赖。

1.3 单元测试与其他测试的区别

  • 单元测试：聚焦在一个方法或者一个类层面，不涉及过多外部依赖，能极快地发现逻辑错误。
  • 集成测试：多个模块或组件交互时的测试，通常依赖真实数据库、消息队列等外部资源。
  • 端到端测试(E2E)：关注的是整个系统的完整流程，包括前端、后端、数据库、外部接口等。
  • 在 Spring Boot 环境中，可以使用 @SpringBootTest 搭配 Mock 或者内存数据库来实现集成测试，但这通常已经不只是“单元”级别了。

2. 为什么要写单元测试？

  • 快速发现 Bug：写完代码马上测，不用等到上线才被发现问题。
  • 减少回归成本：以后代码改动或升级，只要一键跑测试，就能知道改动有没有影响其他功能。
  • 保证代码质量：养成单元测试的习惯，会促使你把代码设计得更简洁和更容易测试。

简单说：花小时间写单元测试，能为你省下大时间修 Bug。

3. 环境准备

3.1 依赖

在一个常规的 Spring Boot 项目中，只要在 pom.xml（Maven）或 build.gradle（Gradle） 里加上：

<!-- 如果是 Maven -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>
  • JUnit 5：最常用的Java测试框架（写 @Test 方法）
  • Mockito：常用的“模拟”库（用来Mock其他依赖）
  • AssertJ / Hamcrest：更好用的断言库
  • Spring Test / Spring Boot Test：Spring官方提供的测试辅助

这也就够了，一般不需要额外安装别的。

3.2 项目结构

Spring Boot常见的目录结构（Maven示例）：

src
 ├─ main
 │   └─ java
 │       └─ com.example.demo
 │           ├─ DemoApplication.java
 │           └─ service
 │               └─ MyService.java
 └─ test
     └─ java
         └─ com.example.demo
             ├─ DemoApplicationTests.java
             └─ service
                 └─ MyServiceTest.java
  • src/main/java 放你的业务代码。
  • src/test/java 放你的测试代码。
  • 通常测试类的包路径要和被测类一致，这样在IDE里能很快对上号，也方便管理。

4. 最最简单的单元测试示例（不依赖Spring）

先从“纯JUnit”说起，最简单的情况就是：

  • 我有一个普通的工具类/方法
  • 我就想测试它的输入输出对不对
  • 不用装载Spring，也不用什么复杂注解

代码示例

假设我们有一个简单的工具类：

public class MathUtil {
    public static int add(int a, int b) {
        return a + b;
    }
}

那我们写一个测试类（路径：src/test/java/.../MathUtilTest.java）：

import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;

public class MathUtilTest {

    @Test
    void testAdd() {
        int result = MathUtil.add(2, 3);
        Assertions.assertEquals(5, result, "2 + 3 应该等于 5");
    }
}
  • @Test 表示这是一个测试方法。
  • Assertions.assertEquals(期望值, 实际值, "提示信息") 用来断言。
    • 如果断言不通过，测试就失败；通过则测试成功。

运行方法：

  • 在 IDE（如 IntelliJ/ Eclipse）里，右键这个 MathUtilTest 类 -> Run 'MathUtilTest'
  • 或者在命令行里运行 mvn test（Maven） / gradle test（Gradle）。

这就是最最基础的单元测试。

5. 在 Spring Boot 里测试 - Service层

当你要测试一个 Service（业务逻辑类） 时，它可能依赖其他Bean（例如 Repository、Dao 等）或者需要 Autowired。在 Spring Boot 里，有两种主要方法：

方法1：纯Mock（不启动Spring Context）

适合只想测试这个Service逻辑本身，不需要真的连数据库，也不需要整个Spring环境。速度最快。

  • 用 Mockito 来创建一个假的（Mock）依赖。
  • 注入到要测的Service里，这样你可以控制依赖的行为。

示例

UserRepository.java (假设它是个接口，用来访问数据库)：

public interface UserRepository {
    User findByName(String name);
    // ... 其他方法
}

UserService.java (我们要测这个类)：

public class UserService {

    private UserRepository userRepository;

    // 通过构造注入依赖
    public UserService(UserRepository userRepository) {
        this.userRepository = userRepository;
    }

    public String getUserNickname(String name) {
        User user = userRepository.findByName(name);
        if (user == null) {
            return "UNKNOWN";
        }
        return user.getNickname();
    }
}

UserServiceTest.java (测试类，不依赖 Spring)：

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.Assertions;
import org.mockito.Mockito;
import org.mockito.Mock;
import org.mockito.InjectMocks;
import org.mockito.junit.jupiter.MockitoExtension;
import org.junit.jupiter.api.extension.ExtendWith;

@ExtendWith(MockitoExtension.class) // JUnit5 启用Mockito
public class UserServiceTest {

    @Mock
    private UserRepository userRepository; // Mock出来的依赖

    @InjectMocks
    private UserService userService;       // 要测试的对象，会把上面这个Mock自动注入进来

    @Test
    void testGetUserNickname_found() {
        // 1. 假设我们模拟一个“数据库中查到的用户”：
        User mockUser = new User();
        mockUser.setName("alice");
        mockUser.setNickname("AliceWonder");

        // 2. 定义假数据的返回行为
        Mockito.when(userRepository.findByName("alice")).thenReturn(mockUser);

        // 3. 调用被测方法
        String nickname = userService.getUserNickname("alice");

        // 4. 断言结果
        Assertions.assertEquals("AliceWonder", nickname);
    }

    @Test
    void testGetUserNickname_notFound() {
        // 没有设置when，则默认返回null
        String nickname = userService.getUserNickname("bob");
        Assertions.assertEquals("UNKNOWN", nickname);
    }
}
  • 使用了 @Mock 注解声明要模拟的依赖 userRepository。
  • 使用了 @InjectMocks 注解告诉 Mockito，要把所有标记 @Mock 的对象注入进 UserService。
  • 这样就能让 UserService 这个对象在执行时使用模拟过的 userRepository 而不访问真实数据库。
  • 然后通过 Mockito.when(...) 来定义依赖方法的返回值，用于测试用例的前提条件设置。
  • 通过 Assertions 来验证执行结果是否符合预期。

这样就只测 UserService 的逻辑，不会真的访问数据库，也不需要启动Spring，执行很快。

方法2：使用 @SpringBootTest (集成上下文)

适合你想在测试时使用Spring管理Bean，比如自动注入 @Autowired，或想测试和别的Bean的连接配置是否正常。

  • 在测试类上加 @SpringBootTest。
  • 这样Spring容器会启动，你也能 @Autowired 你的Service或者别的Bean。

示例

UserService.java (类似前面，只不过换成了 Spring注入)：

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

    public String getUserNickname(String name) {
        User user = userRepository.findByName(name);
        if (user == null) {
            return "UNKNOWN";
        }
        return user.getNickname();
    }
}

UserServiceSpringTest.java (测试类，使用Spring上下文)：

@SpringBootTest
public class UserServiceSpringTest {

    @Autowired
    private UserService userService;

    @MockBean
    private UserRepository userRepository; 
    // @MockBean的意思：Spring 启动时，
    // 把真正的UserRepository替换成一个Mock对象，
    // 我们就可以定义它的返回值，而不会真的连数据库

    @Test
    void testGetUserNickname_found() {
        User mockUser = new User();
        mockUser.setName("alice");
        mockUser.setNickname("AliceWonder");

        Mockito.when(userRepository.findByName("alice")).thenReturn(mockUser);

        String result = userService.getUserNickname("alice");
        Assertions.assertEquals("AliceWonder", result);
    }

    @Test
    void testGetUserNickname_notFound() {
        // 不设置when就会返回null
        String result = userService.getUserNickname("unknown");
        Assertions.assertEquals("UNKNOWN", result);
    }
}
  • @SpringBootTest会启动一个小型Spring环境，让 @Autowired 能起作用。
  • @MockBean 可以让你把某个Bean（比如 UserRepository）变成一个模拟对象。
  • 整体执行依然比较快，但比纯Mock稍微慢一点，因为要先启动Spring容器。

6. 测试 Controller 层

在 Spring Boot 里，Controller 是对外的 HTTP 接口。最常见的两种测试方式：

  • 用 @WebMvcTest + MockMvc：不启动整个应用，只启动Web层，速度较快；
  • 用 @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) + TestRestTemplate：会真正启动一个内嵌服务器，发起真实HTTP请求，更贴近实际环境。

6.1 @WebMvcTest 示例

@WebMvcTest(UserController.class) // 表示只测 UserController 相关
public class UserControllerTest {

    @Autowired
    private MockMvc mockMvc; // 用来模拟HTTP请求

    @MockBean
    private UserService userService; // Mock掉Service层

    @Test
    void testGetUser() throws Exception {
        // 假设Service返回一个User对象
        User mockUser = new User();
        mockUser.setName("test");
        mockUser.setNickname("TestNick");

        // 定义service行为
        Mockito.when(userService.getUserNickname("test")).thenReturn("TestNick");

        // 用MockMvc发起GET请求，对应Controller的 /user/{name} 路径
        mockMvc.perform(MockMvcRequestBuilders.get("/user/test"))
            .andExpect(MockMvcResultMatchers.status().isOk())
            .andExpect(MockMvcResultMatchers.content().string("TestNick"));
    }
}
  • @WebMvcTest 只会扫描和加载 Web 层相关的组件，不会启动整个 Spring Boot 应用，测试速度更快。
  • mockMvc.perform(get("/users/1")) 可以模拟一次 GET 请求到 /users/1，并断言返回的 JSON 结构和内容。

6.2 @SpringBootTest + TestRestTemplate

如果你想做一个更真实的集成测试（包括 Controller、Service、Repository 等所有层），可以使用 @SpringBootTest 并设置 webEnvironment = RANDOM_PORT 或 DEFINED_PORT 来启动内嵌服务器，然后注入 TestRestTemplate 来请求： 

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class UserControllerIntegrationTest {

    @Autowired
    private TestRestTemplate restTemplate; // 可以真的发请求

    @Test
    void testGetUser() {
        // 假设数据库里已经有对应数据，或者你用 @MockBean 替换依赖
        String result = restTemplate.getForObject("/user/test", String.class);
        Assertions.assertEquals("TestNick", result);
    }
}
  • 这里会真正启动一个随机端口的Tomcat，然后 TestRestTemplate 真的去请求本地这个 /user/test 接口。
  • 非常贴近真实部署，只是适合做集成测试，比前面的MockMvc测试稍慢一点。

7. 常见的断言与技巧

7.1 断言

  • Assertions.assertEquals(期望, 实际)：断言二者相等。
  • Assertions.assertTrue(条件)：断言条件为真。
  • Assertions.assertThrows(异常类型, 代码块)：断言执行代码块会抛出指定异常。

例如：

@Test
void testThrowException() {
    Assertions.assertThrows(IllegalArgumentException.class, () -> {
        // 假设调用了一个会抛出异常的方法
        someMethod(null);
    });
}

7.2 Mock时常用的 Mockito 方法

  • Mockito.when( mockObj.方法(...) ).thenReturn(返回值);
  • Mockito.when( mockObj.方法(...) ).thenThrow(异常);
  • Mockito.verify( mockObj, Mockito.times(1) ).某方法(...); // 验证是否调用了某方法

8. 测试运行与整合

8.1 在本地IDE里运行

  • 右键单个测试类或测试方法 -> Run
  • 或者在项目主目录运行 mvn test / gradle test

8.2 与持续集成(CI)整合

  • 在 Jenkins、GitLab CI、GitHub Actions 等环境里，一般只要执行 mvn test 或 gradle test 就可以跑所有测试用例。
  • 如果测试全部通过，就说明代码基本没问题；如果测试挂了，说明你这次提交的改动有Bug或者破坏了原有逻辑。

9. 流程小结（简版“使用指南”）

  • 新手首次写单元测试：

    • 在 src/test/java 下创建和源代码同包路径的测试类：XXXTest.java。
    • 在类里加 @Test 注解的方法，里面写 Assertions.assertXXX(...)。
    • 右键运行，看输出是否通过。

  • 要测Service逻辑，但不想连数据库：

    • 在测试类上写： 
      @ExtendWith(MockitoExtension.class)
public class MyServiceTest {
    @Mock
    private MyRepository myRepository;

    @InjectMocks
    private MyService myService;
    ...
}
    • 用 Mockito.when(...) 来模拟依赖。
    • 用 assertEquals(...) 来判断结果。

  • 要测Service逻辑，并用Spring上下文：

    • 在测试类上加 @SpringBootTest。
    • 注入 Service：@Autowired private MyService myService;
    • 如果你不想真的连数据库，那就用 @MockBean MyRepository myRepository;

  • 要测Controller：

    • 用 @WebMvcTest(MyController.class) + @MockBean MyService myService; + MockMvc 做单元测试，速度较快；
    • 或者用 @SpringBootTest(webEnvironment = ... ) + TestRestTemplate 做近似真实的集成测试。

10. 其他常见问题

  • 测试和生产环境的配置冲突了怎么办？
    • 可以在 application-test.yml 里放测试专用配置，然后在测试时用 spring.profiles.active=test。
  • 需要数据库的测试怎么办？
    • 可以用@DataJpaTest+内存数据库（比如 H2），只测JPA相关逻辑，不影响真数据库。
  • 想看覆盖率怎么办？
    • 可以集成 Jacoco 插件，跑 mvn test 后生成覆盖率报告，看你的测试是不是覆盖到了主要逻辑。
  • 测试很慢怎么办？
    • 如果你的逻辑不是必须要Spring，就尽量用纯Mock，不用 @SpringBootTest。
    • 如果只是测Controller，就用 @WebMvcTest，不要启动全部。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/2291666.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

基于脉冲响应不变法的IIR滤波器设计与MATLAB实现

基于脉冲响应不变法的IIR滤波器设计与MATLAB实现

一、设计原理 脉冲响应不变法是一种将模拟滤波器转换为数字滤波器的经典方法。其核心思想是通过对模拟滤波器的冲激响应进行等间隔采样来获得数字滤波器的单位脉冲响应。 设计步骤&#xff1a; 确定数字滤波器性能指标 将数字指标转换为等效的模拟滤波器指标 设计对应的模拟…
阅读更多...
RabbitMQ快速上手及入门

RabbitMQ快速上手及入门

概念 概念&#xff1a; publisher&#xff1a;生产者&#xff0c;也就是发送消息的一方 consumer&#xff1a;消费者&#xff0c;也就是消费消息的一方 queue&#xff1a;队列&#xff0c;存储消息。生产者投递的消息会暂存在消息队列中&#xff0c;等待消费者处理 exchang…
阅读更多...
自动化构建-make/Makefile 【Linux基础开发工具】

自动化构建-make/Makefile 【Linux基础开发工具】

文章目录 一、背景二、Makefile编译过程三、变量四、变量赋值1、""是最普通的等号2、“:” 表示直接赋值3、“?” 表示如果该变量没有被赋值&#xff0c;4、""和写代码是一样的&#xff0c; 五、预定义变量六、函数**通配符** 七、伪目标 .PHONY八、其他常…
阅读更多...
响应式编程与协程

响应式编程与协程

响应式编程与协程的比较 响应式编程的弊端虚拟线程Java线程内核线程的局限性传统线程池的demo虚拟线程的demo 响应式编程的弊端 前面用了几篇文章介绍了响应式编程&#xff0c;它更多的使用少量线程实现线程间解耦和异步的作用&#xff0c;如线程的Reactor模型&#xff0c;主要…
阅读更多...
智能小区物业管理系统推动数字化转型与提升用户居住体验

智能小区物业管理系统推动数字化转型与提升用户居住体验

内容概要 在当今快速发展的社会中&#xff0c;智能小区物业管理系统的出现正在改变传统的物业管理方式。这种系统不仅仅是一种工具&#xff0c;更是一种推动数字化转型的重要力量。它通过高效的技术手段&#xff0c;将物业管理与用户居住体验紧密结合&#xff0c;无疑为社区带…
阅读更多...
从Proxmox VE开始：安装与配置指南

从Proxmox VE开始：安装与配置指南

前言 Proxmox Virtual Environment (Proxmox VE) 是一个开源的虚拟化平台&#xff0c;基于Debian Linux&#xff0c;支持KVM虚拟机和LXC容器。它提供了一个强大的Web管理界面&#xff0c;方便用户管理虚拟机、存储、网络等资源。Proxmox VE广泛应用于企业级虚拟化、云计算和开…
阅读更多...
【C++】B2115 密码翻译

【C++】B2115 密码翻译

博客主页&#xff1a; [小ᶻ☡꙳ᵃⁱᵍᶜ꙳] 本文专栏: C 文章目录 &#x1f4af;前言&#x1f4af;题目解析&#x1f4af;1. 老师的做法代码实现&#xff1a;思路解析&#xff1a; &#x1f4af;2. 我的做法代码实现&#xff1a;思路分析&#xff1a; &#x1f4af;3. 老师…
阅读更多...
Leetcode—598. 区间加法 II【简单】

Leetcode—598. 区间加法 II【简单】

2025每日刷题&#xff08;206&#xff09; Leetcode—598. 区间加法 II 实现代码 class Solution { public:int maxCount(int m, int n, vector<vector<int>>& ops) {int ans m * n;int x ops.size();if(ops.empty()) {return ans;}int xm ops[0][0], ym …
阅读更多...
OpenCV：图像轮廓

OpenCV：图像轮廓

目录 简述 1. 什么是图像轮廓&#xff1f; 2. 查找图像轮廓 2.1 接口定义 2.2 参数说明 2.3 代码示例 2.4 运行结果 3. 绘制图像轮廓 3.1 接口定义 3.2 参数说明 3.3 代码示例 3.4 运行结果 4. 计算轮廓周长 5. 计算轮廓面积 6. 示例&#xff1a;计算图像轮廓的面…
阅读更多...
文字显示省略号

文字显示省略号

多行文本溢出显示省略号
阅读更多...
Cosmos - 世界模型开发平台

Cosmos - 世界模型开发平台

文章目录 一、关于 Cosmos主要特点模型家族 二、使用示例1、推理2、后训练 许可证和联系方式 一、关于 Cosmos NVIDIA Cosmos是开发者第一的世界基础模型平台&#xff0c;旨在帮助物理AI开发者更好、更快地构建他们的物理AI系统。宇宙包含 预训练模型&#xff0c;可通过拥抱脸…
阅读更多...
图像分割中根据mask的ROI，去除mask和image中没有勾画ROI层数以外的图像

图像分割中根据mask的ROI，去除mask和image中没有勾画ROI层数以外的图像

在分割任务中&#xff0c;一个患者有很多层图像&#xff0c;但是勾画的ROI仅有那么几层。我想去除ROI以外层数的那些没用的图像。这里以一个36张图像的nii格式数据为例 查看一下mask文件中有多少个非0图像 import nibabel as nib import numpy as np# 加载 .nii 文件 file_pat…
阅读更多...
全栈开发：使用.NET Core WebAPI构建前后端分离的核心技巧（一）

全栈开发：使用.NET Core WebAPI构建前后端分离的核心技巧（一）

目录 cors解决跨域 依赖注入使用 分层服务注册 缓存方法使用 内存缓存使用 缓存过期清理 缓存存在问题 分布式的缓存 cors解决跨域 前后端分离已经成为一种越来越流行的架构模式&#xff0c;由于跨域资源共享(cors)是浏览器的一种安全机制&#xff0c;它会阻止前端应用…
阅读更多...
springboot使用rabbitmq

springboot使用rabbitmq

使用springboot创建rabbitMQ的链接。 整个项目结构如下&#xff1a; 1.maven依赖 <dependency><groupId>com.rabbitmq</groupId><artifactId>amqp-client</artifactId><version>3.4.1</version> </dependency>application.y…
阅读更多...
Linux——ext2文件系统（二）

Linux——ext2文件系统（二）

Linux——ext2文件系统 ext2文件系统宏观认识一、磁盘分区与格式化二、块组&#xff08;Block Group&#xff09;结构三、文件系统特性 文件名与目录名与inode一、inode的作用原理二、文件与目录名与inode的关系 路径一&#xff0c;路径解析二&#xff0c;路径缓存三&#xff0…
阅读更多...
如何让DeepSeek恢复联网功能？解决（由于技术原因，联网搜索暂不可用）

如何让DeepSeek恢复联网功能？解决（由于技术原因，联网搜索暂不可用）

DeekSeek提示&#xff1a;&#xff08;由于技术原因&#xff0c;联网搜索暂不可用&#xff09; 众所周知&#xff0c;因为海外黑客的ddos攻击、僵尸网络攻击&#xff0c;deepseek的联网功能一直处于宕机阶段&#xff0c;但是很多问题不联网出来的结果都还是2023年的&#xff0c…
阅读更多...
python的ruff简单使用

python的ruff简单使用

Ruff 是一个用 Rust 编写的高性能 Python 静态分析工具和代码格式化工具。它旨在提供快速的代码检查和格式化功能&#xff0c;同时支持丰富的配置选项和与现有工具的兼容性。ruff是用rust实现的python Linter&Formatter。 安装&#xff1a; conda install -c conda-forge…
阅读更多...
【漫话机器学习系列】077.范数惩罚是如何起作用的（How Norm Penalties Work）

【漫话机器学习系列】077.范数惩罚是如何起作用的（How Norm Penalties Work）

范数惩罚的作用与原理 范数惩罚&#xff08;Norm Penalty&#xff09; 是一种常用于机器学习模型中的正则化技术&#xff0c;它的主要目的是控制模型复杂度&#xff0c;防止过拟合。通过对模型的参数进行惩罚&#xff08;即在损失函数中加入惩罚项&#xff09;&#xff0c;使得…
阅读更多...
LLMs之OpenAI o系列：OpenAI o3-mini的简介、安装和使用方法、案例应用之详细攻略

LLMs之OpenAI o系列：OpenAI o3-mini的简介、安装和使用方法、案例应用之详细攻略

LLMs之OpenAI o系列&#xff1a;OpenAI o3-mini的简介、安装和使用方法、案例应用之详细攻略 目录 相关文章 LLMs之o3&#xff1a;《Deliberative Alignment: Reasoning Enables Safer Language Models》翻译与解读 LLMs之OpenAI o系列&#xff1a;OpenAI o3-mini的简介、安…
阅读更多...
Notepad++消除生成bak文件

Notepad++消除生成bak文件

设置(T) ⇒ 首选项... ⇒ 备份 ⇒ 勾选 "禁用" 勾选禁用 就不会再生成bak文件了 notepad怎么修改字符集编码格式为gbk 如图所示
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023