yudao-cloud 开发指南 yudao-cloud 开发指南
  • 萌新必读
  • 后端手册
  • 微服务手册
  • 工作流手册
  • 大屏手册
  • 支付手册
  • 商城手册
  • ERP 手册
  • CRM 手册
  • AI 大模型手册
  • IoT 物联网手册
  • 公众号手册
  • 前端手册 Vue 2.x
  • 前端手册 Vue 3.x
  • 工作流手册
  • 大屏手册
  • 支付手册
  • 商城手册
  • ERP 手册
  • CRM 手册
  • AI 大模型手册
  • IoT 物联网手册
  • 公众号手册
  • 系统手册
视频教程
  • Vue3 + element-plus (opens new window)
  • Vue3 + vben(ant-design-vue) (opens new window)
  • Vue2 + element-ui (opens new window)
单体版 (opens new window)
作者博客 (opens new window)
GitHub (opens new window)
  • 萌新必读
  • 后端手册
  • 微服务手册
  • 工作流手册
  • 大屏手册
  • 支付手册
  • 商城手册
  • ERP 手册
  • CRM 手册
  • AI 大模型手册
  • IoT 物联网手册
  • 公众号手册
  • 前端手册 Vue 2.x
  • 前端手册 Vue 3.x
  • 工作流手册
  • 大屏手册
  • 支付手册
  • 商城手册
  • ERP 手册
  • CRM 手册
  • AI 大模型手册
  • IoT 物联网手册
  • 公众号手册
  • 系统手册
视频教程
  • Vue3 + element-plus (opens new window)
  • Vue3 + vben(ant-design-vue) (opens new window)
  • Vue2 + element-ui (opens new window)
单体版 (opens new window)
作者博客 (opens new window)
GitHub (opens new window)
  • 萌新必读

    • 简介
    • 交流群
    • 视频教程
    • 功能列表
    • 快速启动(后端项目)
    • 快速启动(前端项目)
    • 接口文档
    • 技术选型
    • 项目结构
    • 代码热加载
    • 一键改包
    • 迁移模块(适合新项目)
    • 删除功能(以租户为例)
    • 表结构变更(版本升级)
    • 国产信创数据库(DM 达梦、大金、OpenGauss)
    • 内网穿透
    • 面试题、简历模版、简历优化
    • 项目外包
  • 后端手册

    • 新建服务
    • 代码生成【单表】(新增功能)
    • 代码生成【主子表】
    • 代码生成(树表)
    • 功能权限
    • 数据权限
    • 用户体系
    • 三方登录
    • OAuth 2.0(SSO 单点登录)
    • SaaS 多租户【字段隔离】
    • SaaS 多租户【数据库隔离】
    • WebSocket 实时通信
    • 异常处理(错误码)
    • 参数校验、时间传参
    • 分页实现
    • VO 对象转换、数据翻译
    • 文件存储(上传下载)
    • Excel 导入导出
    • 操作日志、访问日志、异常日志
    • MyBatis 数据库
    • MyBatis 联表&分页查询
    • 多数据源(读写分离)
    • Redis 缓存
    • 本地缓存
    • 异步任务
    • 分布式锁
    • 幂等性(防重复提交)
    • 请求限流(RateLimiter)
    • HTTP 接口签名(防篡改)
    • 单元测试
      • 1.测试组件
        • 1.1 快速测试的基类
        • 1.2 测试工具类
      • 2. BaseDbUnitTest 实战案例
        • 2.1 引入依赖
        • 2.2 新建 ut 配置文件
        • 2.3 添加 H2 SQL 脚本
        • 2.3 新建 DictTypeServiceTest 类
        • 2.4 新增方法的单测
        • 2.5 修改方法的单测
        • 2.6 删除方法的单测
        • 2.7 单条查询方法的单测
        • 2.8 分页查询方法的单测
      • 3. BaseMockitoUnitTest 实战案例
    • 验证码
    • 工具类 Util
    • 数据库文档
  • 微服务手册

    • 微服务调试(必读)
    • 注册中心 Nacos
    • 配置中心 Nacos
    • 服务网关 Spring Cloud Gateway
    • 服务调用 Feign
    • 定时任务 XXL Job
    • 消息队列(内存)
    • 消息队列(Redis)
    • 消息队列(RocketMQ)
    • 消息队列(RabbitMQ)
    • 消息队列(Kafka)
    • 消息队列(Cloud)
    • 分布式事务 Seata
    • 服务保障 Sentinel
  • 工作流手册

    • 工作流演示
    • 功能开启
    • 工作流(达梦适配)
    • 审批接入(流程表单)
    • 审批接入(业务表单)
    • 流程设计器(BPMN)
    • 流程设计器(钉钉、飞书)
    • 选择审批人、发起人自选
    • 会签、或签、依次审批
    • 流程发起、取消、重新发起
    • 审批通过、不通过、驳回
    • 审批加签、减签
    • 审批转办、委派、抄送
    • 执行监听器、任务监听器
    • 流程表达式
    • 流程审批通知
  • 大屏手册

    • 报表设计器
    • 大屏设计器
  • 支付手册

    • 功能开启
    • 支付宝支付接入
    • 微信公众号支付接入
    • 微信小程序支付接入
    • 支付宝、微信退款接入
    • 钱包充值、支付、退款
    • 模拟支付、退款
  • 会员手册

    • 功能开启
    • 微信公众号登录
    • 微信小程序登录
    • 微信小程序订阅消息
    • 微信小程序码
    • 会员用户、标签、分组
    • 会员等级、积分、签到
  • 商城手册

    • 商城演示
    • 功能开启
    • 商城装修
    • 在线客服
    • 【商品】商品分类
    • 【商品】商品属性
    • 【商品】商品 SPU 与 SKU
    • 【商品】商品评价
    • 【交易】购物车
    • 【交易】交易订单
    • 【交易】售后退款
    • 【交易】快递发货
    • 【交易】门店自提
    • 【交易】分销返佣
    • 【营销】优惠劵
    • 【营销】积分商城
    • 【营销】拼团活动
    • 【营销】秒杀活动
    • 【营销】砍价活动
    • 【营销】满减送活动
    • 【营销】限时折扣
    • 【营销】内容管理
    • 【统计】会员、商品、交易统计
  • ERP手册

    • ERP 演示
    • 功能开启
    • 【产品】产品信息、分类、单位
    • 【库存】产品库存、库存明细
    • 【库存】其它入库、其它出库
    • 【库存】库存调拨、库存盘点
    • 【采购】采购订单、入库、退货
    • 【销售】销售订单、出库、退货
    • 【财务】采购付款、销售收款
  • CRM手册

    • CRM 演示
    • 功能开启
    • 【线索】线索管理
    • 【客户】客户管理、公海客户
    • 【商机】商机管理、商机状态
    • 【合同】合同管理、合同提醒
    • 【回款】回款管理、回款计划
    • 【产品】产品管理、产品分类
    • 【通用】数据权限
    • 【通用】跟进记录、待办事项
  • AI大模型手册

    • AI 大模型演示
    • 功能开启
    • AI 聊天对话
    • AI 绘画创作
    • AI 知识库
    • AI 音乐创作
    • AI 写作助手
    • AI 思维导图
    • AI 工具(function calling)
    • AI 工作流
    • Dify 工作流
    • FastGPT 工作流
    • Coze 智能体
    • 【模型接入】OpenAI
    • 【模型接入】通义千问
    • 【模型接入】DeepSeek
    • 【模型接入】字节豆包
    • 【模型接入】腾讯混元
    • 【模型接入】硅基流动
    • 【模型接入】MiniMax
    • 【模型接入】月之暗灭
    • 【模型接入】百川智能
    • 【模型接入】文心一言
    • 【模型接入】LLAMA
    • 【模型接入】智谱 GLM
    • 【模型接入】讯飞星火
    • 【模型接入】微软 OpenAI
    • 【模型接入】谷歌 Gemini
    • 【模型接入】Stable Diffusion
    • 【模型接入】Midjourney
    • 【模型接入】Suno
  • IoT物联网手册

    • 功能开启
  • 公众号手册

    • 功能开启
    • 公众号接入
    • 公众号粉丝
    • 公众号标签
    • 公众号消息
    • 自动回复
    • 公众号菜单
    • 公众号素材
    • 公众号图文
    • 公众号统计
  • 系统手册

    • 短信配置
    • 邮件配置
    • 站内信配置
    • 数据脱敏
    • 敏感词
    • 地区 & IP 库
  • 运维手册

    • 开发环境
    • Linux 部署
    • Docker 部署
    • Jenkins 部署
    • 宝塔部署
    • HTTPS 证书
    • 服务监控
  • 前端手册 Vue 3.x

    • 开发规范
    • 菜单路由
    • Icon 图标
    • 字典数据
    • 系统组件
    • 通用方法
    • 配置读取
    • CRUD 组件
    • 国际化
    • IDE 调试
    • 代码格式化
  • 前端手册 Vue 2.x

    • 开发规范
    • 菜单路由
    • Icon 图标
    • 字典数据
    • 系统组件
    • 通用方法
    • 配置读取
  • 更新日志

    • 【v2.5.0】开发中...
    • 【v2.4.2】2025-04-12
    • 【v2.4.1】2025-02-09
    • 【v2.4.0】2024-12-31
    • 【v2.3.0】2024-10-07
    • 【v2.2.0】2024-08-02
    • 【v2.1.0】2024-05-05
    • 【v2.0.1】2024-03-01
    • 【v2.0.0】2024-01-26
    • 【v1.9.0】2023-12-01
  • 开发指南
  • 后端手册
芋道源码
2022-04-04
目录

单元测试

项目使用 Junit5 + Mockito 实现单元测试,提升代码质量、重复测试效率、部署可靠性等。

截止目前,项目已经有 500+ 测试用例。

内容推荐

如果你想系统学习单元测试,可以阅读《有效的单元测试》 (opens new window)这本书,非常适合 Java 工程师。

如果只是想学习 Spring Boot Test 的话,可以阅读 《芋道 Spring Boot 单元测试 Test 入门 》 (opens new window) 文章。

# 1.测试组件

yudao-spring-boot-starter-test (opens new window) 是项目提供的测试组件,用于单元测试、集成测试等等。

# 1.1 快速测试的基类

测试组件提供了 4 种单元测试的基类,通过继承它们,可以快速的构建单元测试的环境。

基类 作用
BaseMockitoUnitTest (opens new window) 纯 Mockito 的单元测试
BaseDbUnitTest (opens new window) 使用内嵌的 H2 数据库的单元测试
BaseRedisUnitTest (opens new window) 使用内嵌的 Redis 缓存的单元测试
BaseDbAndRedisUnitTest (opens new window) 使用内嵌的 H2 数据库 + Redis 缓存的单元测试

疑问:什么是内嵌的 Redis 缓存?

基于 jedis-mock (opens new window) 开源项目,通过 RedisTestConfiguration (opens new window) 配置类,启动一个 Redis 进程。一般情况下,会使用 16379 端口。

# 1.2 测试工具类

① RandomUtils (opens new window) 基于 podam (opens new window) 开源项目,实现 Bean 对象的随机生成。

② AssertUtils (opens new window) 封装 Junit 的 Assert 断言,实现 Bean 对象的断言,支持忽略部分属性。

# 2. BaseDbUnitTest 实战案例

以字典类型模块的 DictTypeServiceImpl (opens new window) 为例子,讲解它的 DictTypeServiceTest (opens new window) 单元测试的编写实现。

# 2.1 引入依赖

在 yudao-module-system-biz 模块中,引入 yudao-spring-boot-starter-test 技术组件。如下所示:

<dependency>
    <groupId>cn.iocoder.cloud</groupId>
    <artifactId>yudao-spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>

# 2.2 新建 ut 配置文件

在 test/resources (opens new window) 目录,新建单元测试的 application-unit-test.yaml (opens new window) 配置文件,内容如下:

application-unit-test.yaml` 配置文件

# 2.3 添加 H2 SQL 脚本

修改 test/resources/sql (opens new window) 目录的两个 H2 SQL 脚本:

① 在 create_tables.sql (opens new window) 文件中,添加 system_dict_type 的 H2 建表语句。SQL 如下:

CREATE TABLE IF NOT EXISTS "system_dict_type" (
    "id" bigint NOT NULL GENERATED BY DEFAULT AS IDENTITY,
    "name" varchar(100) NOT NULL DEFAULT '',
    "type" varchar(100) NOT NULL DEFAULT '',
    "status" tinyint NOT NULL DEFAULT '0',
    "remark" varchar(500) DEFAULT NULL,
    "creator" varchar(64) DEFAULT '',
    "create_time" timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
    "updater" varchar(64) DEFAULT '',
    "update_time" timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
    "deleted" bit NOT NULL DEFAULT FALSE,
    PRIMARY KEY ("id")
) COMMENT '字典类型表';

注意,H2 和 MySQL 的建表语句有区别,需要手动进行转换。如果你不想进行转换,可以使用 [基础设置 -> 代码生成] 菜单的代码生成器功能,如下图所示:

基础设置 -> 代码生成

② 在 clean.sql (opens new window) 文件中,添加 system_dict_type 的清空数据的语句。SQL 如下:

DELETE FROM "system_dict_type";

每次单元测试的方法执行完后,会执行 clean.sql 脚本,进行数据的清理,保证每个单元测试的方法的数据隔离性。

# 2.3 新建 DictTypeServiceTest 类

新建 DictTypeServiceTest 测试类,继承 BaseMockitoUnitTest 基类,并完成它的配置。代码如下图所示:

DictTypeServiceTest 总体

  • 属于自己模块的,使用 Spring 初始化成真实的 Bean,然后通过 @Resource 注入。例如说:dictTypeService、dictTypeMapper
  • 属于别人模块的,使用 Spring @MockBean 注解,模拟 Mock 成一个 Bean 后注入。例如说:dictDataService

疑问:为什么有的进行 Mock,有的不进行 Mock 呢?

  • 单元测试需要避免对外部的依赖,而 dictDataService 是外部依赖,所以需要 Mock 掉。
  • dictTypeMapper 某种程度来说,也是一种外部依赖,但是通过内嵌的 H2 内存数据库,进行“真实”的数据库操作,反而单元测试的编写效率更高,效果更好,所以不需要 Mock 掉。

另外,[基础设置 -> 代码生成] 菜单的代码生成器功能,已经生成了绝大多数的单元测试的逻辑,这里主要是希望让你了解单元测试的具体使用,所以并没有使用它。如下图所示:

基础设置 -> 代码生成

# 2.4 新增方法的单测

# 2.5 修改方法的单测

# 2.6 删除方法的单测

# 2.7 单条查询方法的单测

# 2.8 分页查询方法的单测

# 3. BaseMockitoUnitTest 实战案例

一些类由于不依赖 MySQL 和 Redis,可以通过继承 BaseMockitoUnitTest 基类,实现纯 Mockito 的单元测试。例如说 SmsSendServiceTest (opens new window) 单元测试类,代码如下:

具体 SmsSendServiceTest 的每个测试方法,和 DictTypeServiceTest 并没有什么差别,还是 Mock 模拟 + Assert 断言 + Verify 调用,你可以自己花点时间瞅瞅。

HTTP 接口签名(防篡改)
验证码

← HTTP 接口签名(防篡改) 验证码→

Theme by Vdoing | Copyright © 2019-2025 芋道源码 | MIT License
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式
×