【单元测试】SpringBoot

news2024/11/24 12:22:12

【单元测试】SpringBoot

1. 为什么单元测试很重要？‼️

在这里插入图片描述

从前，有一个名叫小明的程序员，他非常聪明，但有一个致命的缺点：懒惰。小明的代码写得又快又好，但他总觉得单元测试是一件麻烦事，觉得代码能跑就行，测试什么的全是浪费时间。

有一天，小明接到了一个重要的项目，他需要为一个在线购物网站开发一个新功能：用户可以在结账时使用优惠券。小明想：“这还不简单？半小时搞定！”于是，他迅速写好了代码，迫不及待地提交了。

第二天，项目经理来了，满脸怒气地对小明说：“小明，你的代码出问题了！所有用户在使用优惠券时都得到了负数的折扣，他们的账户反而被扣了更多的钱！”

小明惊讶地张大了嘴巴，不敢相信自己会犯这么低级的错误。他连忙检查代码，发现确实在计算折扣时，忘记处理负数的情况。小明赶紧修复了这个错误，但心里还是觉得不服气：“这只是个小问题，我不需要写单元测试。”

几天后，小明又收到一个新任务：实现一个积分系统，用户每消费一元就能积一分。小明想：“这次我一定不会犯错。”于是，他又快速写好了代码，提交了上去。

然而，不久之后，客户打电话过来抱怨：“我的积分怎么越消费越少了？！”

小明再次检查代码，发现自己在积分计算的函数里不小心多写了一个减号，导致积分被扣除而不是增加。他这次终于意识到，如果自己早点写单元测试，这些问题完全可以在开发阶段就被发现，而不是在上线后被用户发现。

于是，小明决定改过自新，认真学习单元测试。他发现，单元测试不仅可以帮助他捕捉到代码中的错误，还能让他更加自信地进行代码重构和优化。

总结

  1. 🔍早期发现问题：单元测试能够在开发阶段及时发现代码中的错误，避免错误在后期被发现，减少修复成本。

  2. 🐛确保代码质量：通过编写单元测试，可以验证每个模块的功能是否按预期工作，提升代码的可靠性和稳定性。

  3. 🔨方便重构：在进行代码重构或优化时，有单元测试作为保障，可以放心地修改代码，而不必担心引入新的错误

  4. 📄文档作用：单元测试可以作为代码的活文档，帮助新成员快速理解代码的功能和使用方法

2. 快速入门

2.1 基础配置

在 pom.xml 中添加以下依赖：

<dependencies>
    <!-- Spring Boot Starter Test -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

这个依赖包含了多个库和功能，主要有以下几个：

  • JUnit：JUnit是Java中最流行和最常用的单元测试框架，它提供了一套注解和断言来编写和运行单元测试。例如@Test注解表示一个测试方法，assertEquals断言表示两个值是否相等。
  • Spring Test：Spring Test是一个基于Spring的测试框架，它提供了一套注解和工具来配置和管理Spring上下文和Bean。例如@SpringBootTest注解表示一个集成测试类，@Autowired注解表示自动注入一个Bean。
  • Mockito：Mockito是一个Java中最流行和最强大的Mock对象库，它可以模拟复杂的真实对象行为，从而简化测试过程。例如@MockBean注解表示创建一个Mock对象，when方法表示定义Mock对象的行为。
  • Hamcrest：Hamcrest是一个Java中的匹配器库，它提供了一套语义丰富而易读的匹配器来进行结果验证。例如assertThat断言表示验证一个值是否满足一个匹配器，is匹配器表示两个值是否相等。
  • AssertJ：AssertJ是一个Java中的断言库，它提供了一套流畅而直观的断言语法来进行结果验证。例如assertThat断言表示验证一个值是否满足一个条件，isEqualTo断言表示两个值是否相等。

除了以上这些库外，spring-boot-starter-test还包含了其他一些库和功能，如JsonPath、JsonAssert、XmlUnit等。这些库和功能可以根据不同的测试场景进行选择和使用。

Mockito详解地址：https://pdai.tech/md/develop/ut/dev-ut-x-mockito.html

2.2 编写单元测试

为了更好的演示如何编写单元测试，以最简单的用户登录为例🌰

项目结构

src
├── main
│   └── java
│       └── com
│           └── hwq
│               └── fuwork01
│                   ├── common
│                   ├── controller
│                   │   └── UserController.java
│                   ├── dto
│                   ├── exception
│                   └── service
│                   		└── UserService
└── test
    └── java
        └── com
            └── hwq
                └── fuwork01
                    ├── controller
                    │   └── UserControllerTest.java
                    └── service
                    └──FuWork01ApplicationTests.java
UserServiceImpl（Service层）
/**
* @author wqh
* @description 针对表【user(用户表)】的数据库操作Service实现
* @createDate 2024-07-15 17:13:27
*/
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User>
    implements UserService{

    @Override
    public Long userLogin(String userAccount, String userPassword, HttpServletRequest request) {
        LambdaQueryWrapper<User> userLambdaQueryWrapper = new LambdaQueryWrapper<>();
        userLambdaQueryWrapper.eq(User::getUserAccount, userAccount)
                .eq(User::getUserPassword, userPassword);
        User user = this.getOne(userLambdaQueryWrapper);
        if (user == null) {
            throw new BusinessException(ErrorCode.NOT_FOUND_ERROR ,"用户不存在");
        }
        // 存储用户登录态
        request.getSession().setAttribute("userLogin", user);
        return user.getId();
    }

    @Override
    public User getLoginUser(HttpServletRequest request) {
        return (User)request.getSession().getAttribute("userLogin");
    }


}
针对Service层的测试
@SpringBootTest
public class UserServiceTest {

    @Resource
    private UserService userService;


    private HttpServletRequest request;

    @BeforeEach
    void setUp() {
        // 模拟构造request
        request = new MockHttpServletRequest();
    }

    /**
     * 测试用户登录
     */
    @Test
    void userLogin() {
        String userAccount = "huang";
        String userPassword = "huangwenqing";

        Long userId = userService.userLogin(userAccount, userPassword, request);
        // 验证结果对象与user对象相等
        assertThat(userId, Matchers.is(1L));
    }

}

解释

  • request = new MockHttpServletRequest()，构造一个模拟的request
  • assertThat，判断userId是否符合正常
新断言assertThat使用

JUnit 4.4 结合 Hamcrest 提供了一个全新的断言语法——assertThat。程序员可以只使用 assertThat 一个断言语句，结合 Hamcrest 提供的匹配符，就可以表达全部的测试思想。

assertThat 的优点：

优点 1： 以前 JUnit 提供了很多的 assertion 语句，如：assertEquals，assertNotSame，assertFalse，assertTrue，assertNotNull，assertNull 等，现在有了 JUnit 4.4，一条 assertThat 即可以替代所有的 assertion 语句，这样可以在所有的单元测试中只使用一个断言方法，使得编写测试用例变得简单，代码风格变得统一，测试代码也更容易维护。

优点 2： assertThat 使用了 Hamcrest 的 Matcher 匹配符，用户可以使用匹配符规定的匹配准则精确的指定一些想设定满足的条件，具有很强的易读性，而且使用起来更加灵活。

优点 3： assertThat 不再像 assertEquals 那样，使用比较难懂的“谓宾主”语法模式（如：assertEquals(3, x);），相反，assertThat 使用了类似于“主谓宾”的易读语法模式（如：assertThat(x,is(3));），使得代码更加直观、易读。

UserController（登录控制层）
@RestController
@RequestMapping("/user")
@CrossOrigin("*")
public class UserController {
    @Resource
    private UserService userService;

    @PostMapping("/login")
    public BaseResponse<Long> userLogin(@RequestBody UserLoginDTO userLoginDTO, HttpServletRequest request) {
        if (userLoginDTO == null) {
            throw new BusinessException(ErrorCode.PARAMS_ERROR, "参数错误");
        }
        String userAccount = userLoginDTO.getUserAccount();
        String userPassword = userLoginDTO.getUserPassword();
        if (StringUtils.isEmpty(userAccount)) {
            throw new BusinessException(ErrorCode.PARAMS_ERROR, "账户不得为空");
        }
        if (StringUtils.isEmpty(userPassword)) {
            throw new BusinessException(ErrorCode.PARAMS_ERROR, "密码不得为空");

        }
        return ResultUtils.success(userService.userLogin(userAccount, userPassword, request));
    }
}

内容

  • 对上传的登录参数进行校验
  • 登录成功，返回用户id
针对controller层单元测试
@SpringBootTest
@AutoConfigureMockMvc
public class UserControllerTest {
    @Autowired
    private MockMvc mockMvc;

    @MockBean
    private UserService userService;

    /**
     * 用户登录成功测试
     * @throws Exception
     */
    @Test
    void testUserLoginSuccess() throws Exception {
        UserLoginDTO userLoginDTO = new UserLoginDTO();
        userLoginDTO.setUserAccount("huang");
        userLoginDTO.setUserPassword("huangwenqing");
        // userService测试
        when(userService.userLogin("huang", "huangwenqing", new MockHttpServletRequest())).thenReturn(1L);
        // 模拟http登录请求
        mockMvc.perform(post("/user/login")
                        .contentType(MediaType.APPLICATION_JSON)
                        .content("{\"userAccount\":\"huang\",\"userPassword\":\"huangwenqing\"}"))
                .andExpect(status().isOk())
                .andExpect(jsonPath("$.code").value(0))
                .andExpect(jsonPath("$.data").value(0L));
    }

    /**
     * 用户登录异常测试
     * @throws Exception
     */
    @Test
    void testUserLoginNullParams() throws Exception {
        mockMvc.perform(post("/user/login")
                        .contentType(MediaType.APPLICATION_JSON)
                        .content("{}"))
                .andExpect(status().isOk())
                .andExpect(jsonPath("$.code").value(40000));
    }
}

要点

  • @SpringBootTest: 加载完整的 Spring 应用程序上下文。
  • @AutoConfigureMockMvc: 自动配置 MockMvc，用于模拟 HTTP 请求。
  • MockMvc: 用于模拟 HTTP 请求和响应的测试。
  • @MockBean: 创建并注入一个模拟的 UserService 实例，以便于测试控制器而不需要实际的服务实现。
  • 使用 mockMvc.perform 方法发送 POST 请求，模拟用户登录。
  • 使用 andExpect 方法验证 HTTP 状态码和响应体中的数据。
2.3测试原则
  1. 保持测试独立：确保每个测试独立运行，不依赖其他测试的执行结果
  2. 使用模拟对象：对于外部依赖，如数据库、网络请求等，尽量使用模拟对象，以提高测试的速度和稳定性。
  3. 覆盖各种场景：编写充分的测试用例，覆盖正常路径、异常路径和边界条件。
  4. 保持测试简洁：测试代码应该简洁明了，避免过于复杂的逻辑，以提高可维护性。

3.总结

编写优雅的单元测试是保证代码质量的关键。在 Spring Boot 中，我们可以使用 @SpringBootTest 和 @AutoConfigureMockMvc 等注解简化测试配置，使用 Mockito 等工具模拟依赖，编写覆盖全面的测试用例。通过遵循最佳实践，我们可以编写高效、稳定的单元测试，提高开发效率和代码质量。

希望本文对您在 Spring Boot 项目中编写单元测试有所帮助。Happy Testing!

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

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

相关文章

2.RabbitMQ相关概念

2.RabbitMQ相关概念

介绍 RabbitMQ是一个消息中间件&#xff0c;接受并转发消息。它接收、存储和转发消息数据。 四大核心概念&#xff1a; 1.生产者 产生数据发送消息的程序是生产者。 2.消费者 3.队列 每一个队列对应一个消费者。 如果两个消费者对应同一个队列&#xff0c;那么队列中的…
阅读更多...
云监控（华为） | 实训学习day1（10）

云监控（华为） | 实训学习day1（10）

云监控&#xff1a;确保服务器高效运行 在当今的数字化时代&#xff0c;服务器的稳定运行对于任何企业都至关重要。为了确保服务器的 CPU、内存和硬盘等资源的合理运行&#xff0c;云监控成为了一项不可或缺的技术。本文将详细介绍云监控的基本概念、所需软件、配置方法以及如何…
阅读更多...
分布式 I/O 系统 BL200 Modbus TCP 耦合器

分布式 I/O 系统 BL200 Modbus TCP 耦合器

BL200 耦合器是一个数据采集和控制系统&#xff0c;基于强大的 32 位微处理器设计&#xff0c;采用 Linux 操作系统&#xff0c;支持 Modbus 协议&#xff0c;可以快速接入现场 PLC、SCADA 以及 ERP 系统&#xff0c; 内置逻辑控制、边缘计算应用&#xff0c;适用于 IIoT 和工业…
阅读更多...
redis登录缓存

redis登录缓存

1.pom.xml中引入redis依赖 <!-- Redis依赖--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-redis</artifactId></dependency> 2.将登录成功的token存储到redis中 if(Md5…
阅读更多...
捷配PCB打样采用机械盲埋孔制造，有何优势？

捷配PCB打样采用机械盲埋孔制造，有何优势？

在电子制造领域&#xff0c;盲孔&#xff08;Blind Vias&#xff09;与埋孔&#xff08;Buried Vias&#xff09;是两种关键的PCB&#xff08;印刷电路板&#xff09;过孔技术。盲孔特指那些连接内层走线至外层走线的过孔&#xff0c;但并不贯穿整个板体。相对地&#xff0c;埋…
阅读更多...
【数学建模】技术革新——Lingo的使用超详解

【数学建模】技术革新——Lingo的使用超详解

目录 基础知识 1. 变量声明 示例 2. 常量声明 语法格式 示例 3. 目标函数 语法格式 示例 4. 约束条件 语法格式 示例 5. 完整的Lingo模型示例 示例 解释 6. 整数变量声明 语法格式 示例 7. 非线性规划 示例 8. 多目标优化 语法格式 示例 9. 数据输入与…
阅读更多...
持续集成02--Linux环境更新/安装Java新版本

持续集成02--Linux环境更新/安装Java新版本

前言 在持续集成/持续部署&#xff08;CI/CD&#xff09;的旅程中&#xff0c;确保开发环境的一致性至关重要。本篇“持续集成02--Linux环境更新/安装Java新版本”将聚焦于如何在Linux环境下高效地更新或安装Java新版本。Java作为广泛应用的编程语言&#xff0c;其版本的更新对…
阅读更多...
ModuleNotFoundError: No module named ‘_cffi_backend‘的二中情况解决方案

ModuleNotFoundError: No module named ‘_cffi_backend‘的二中情况解决方案

1、问题概述？ 创作时间：2024年7月 在pycharm中执行python脚本出现如下问题： No module named _cffi_backend 主要说明二中情况： 第一种原因：最常见的原因就是没有安装cffi模块，我们通过命令安装就可以了。 第二种原因：不常见的原因，如果你在pycharm中运行了别人的…
阅读更多...
【自撰写】【国际象棋入门】第10课 常见兵型及其分析

【自撰写】【国际象棋入门】第10课 常见兵型及其分析

第10课 常见兵型及其分析 兵型是国际象棋棋局当中十分重要的局面因素。好的兵型不仅可以为己方创造空间和布局上的优势&#xff0c;也能够充当进攻或者防守时的有力工具&#xff1b;与此同时&#xff0c;坏的兵型则会削弱己方的优势&#xff0c;并给对方创造进攻的可乘之机。本…
阅读更多...
MySQL Workbench下载安装

MySQL Workbench下载安装

官方下载地址&#xff1a; https://dev.mysql.com/downloads/workbench/ 下载完后&#xff0c;点击安装包即可 但是安装之前&#xff0c;必须要先安装Visual C 2019运行库 安装完后&#xff0c;添加数据库连接 点击 Schemas可以看到列表 点击Server可以找到导出、导入数据的菜…
阅读更多...
Godoc学习：安装Godoc

Godoc学习：安装Godoc

目录 前言 1&#xff0c;安装python 2&#xff0c;安装Scons 3&#xff0c;拉取Godoc代码 4&#xff0c;编译并生成工程 前言 根据官网教程安装&#xff1a; 1&#xff0c;安装python 注意&#xff1a;我安装的是3.9的版本&#xff0c;不建议安装最新的版本&#xff0c;…
阅读更多...
【FPGA】优雅地使用ILA进行FPGA硬件调试

【FPGA】优雅地使用ILA进行FPGA硬件调试

Vivado&#xff08;Vitis&#xff09;版本&#xff1a;2020.2FPGA开发板&#xff1a;Microphase Z7-Lite 7020开发板 FPGA设计调试流程 FPGA开发是一个不断迭代的过程&#xff0c;一般的FPGA设计流程一般包含下面几个步骤&#xff1a; 硬件架构和算法验证&#xff1a;实现需要…
阅读更多...
权威认可 | 海云安开发者安全助手系统通过信通院支撑产品功能认证并荣获信通院2024年数据安全体系建设优秀案例

权威认可 | 海云安开发者安全助手系统通过信通院支撑产品功能认证并荣获信通院2024年数据安全体系建设优秀案例

近日&#xff0c;2024全球数字经济大会——数字安全生态建设专题论坛&#xff08;以下简称“论坛”&#xff09;在京成功举办。由全球数字经济大会组委会主办&#xff0c;中国信息通信研究院及公安部第三研究所共同承办&#xff0c;论坛邀请多位专家和企业共同参与。 会上颁发…
阅读更多...
【ollama】ollama运行GLM4-9B和CodeGeeX4-ALL-9B

【ollama】ollama运行GLM4-9B和CodeGeeX4-ALL-9B

一、GGUF模型链接 glm-4-9b-chat-GGUFcodegeex4-all-9b-GGUF 使用modelscope下载 先安装 pip install modelscope 命令1 modelscope download --modelLLM-Research/glm-4-9b-chat-GGUF --local_dir . glm-4-9b-chat.Q5_K.gguf命令2 modelscope download --modelLLM-Researc…
阅读更多...
一图了解网络通信原理

一图了解网络通信原理

&#x1f4d1;打牌 &#xff1a; da pai ge的个人主页 &#x1f324;️个人专栏 &#xff1a; da pai ge的博客专栏 ☁️宝剑锋从磨砺出&#xff0c;梅花香自苦寒来 ☁️运维工程师的职责&#xff1a;监…
阅读更多...
SHOT（方向直方图）

SHOT（方向直方图）

Salti等人在2014年提出一种表面匹配的局部三维描述子SHOT。Salti等人将现有三维局部特征描述方法分为两类&#xff0c;即基于特征的描述方法与基于直方图的描述方法&#xff0c;并分析了两种方法的优势&#xff0c;提出基于特征的局部特征描述方法要比后者在特征的描述能力上更…
阅读更多...
Unity动画系统（3）---融合树

Unity动画系统（3）---融合树

6.1 动画系统基础2-6_哔哩哔哩_bilibili Animator类 using System.Collections; using System.Collections.Generic; using UnityEngine; public class EthanController : MonoBehaviour { private Animator ani; private void Awake() { ani GetComponen…
阅读更多...
Porfinet从转DeviceNet从总线协议转换网关

Porfinet从转DeviceNet从总线协议转换网关

产品功能 1. 远创智控YC-DNT-PN型是Porfinet从转Devicenet从工业级Porfinet 网关。‌这种网关设备允许将Porfinet网络中的设备连接到Devicenet网络中&#xff0c;‌从而实现不同工业通信协议之间的互操作性。‌这些网关设备通常具有两个以太网接口&#xff0c;‌分别用于连接Po…
阅读更多...
数学基础【俗说矩阵】：齐次线性方程和非齐次线性方程求解-学习笔记

数学基础【俗说矩阵】：齐次线性方程和非齐次线性方程求解-学习笔记

一、矩阵基础知识 二元一次方程的传统解法 不论是代入消元法还是加减消元法都统称 【高斯消元法】。 齐次方程组和非齐次方程组 线性方程组的解 线性方程的向量展示 向量规则 矩阵的高斯消元和初等行变行及其规则 高斯消元规则 初等行变换 矩阵经初等行变换成阶梯矩阵&…
阅读更多...
关于 Docker Registry (镜像仓库)

关于 Docker Registry (镜像仓库)

什么是镜像仓库 概念 镜像仓库&#xff08;Docker Registry&#xff09;负责存储、管理和分发镜像&#xff0c;并提供了登录认证能力&#xff0c;建立了仓库的索引。 镜像仓库管理多个 Repository&#xff0c;Repository 通过命名来区分。每个 Repository 包含一个或多个镜像…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023