name: "p3c-unit-testing" description: "Provides unit testing standards following AIR principles (Automatic, Independent, Repeatable). Invoke when user asks about unit testing best practices, test coverage, or test design patterns."
P3C 单元测试规范
本技能提供阿里巴巴Java开发手册中的单元测试相关规范。
AIR原则
- 【强制】好的单元测试必须遵守AIR原则
- A:Automatic(自动化)
- I:Independent(独立性)
- R:Repeatable(可重复)
自动化要求
- 【强制】单元测试应该是全自动执行的,并且非交互式的
- 不准使用System.out进行人肉验证,必须使用assert验证
独立性要求
- 【强制】保持单元测试的独立性
- 单元测试用例之间不能互相调用,也不能依赖执行先后次序
可重复性要求
- 【强制】单元测试是可以重复执行的,不能受到外界环境的影响
- 单元测试对外部环境(网络、服务、中间件等)有依赖时,需要改成注入,使用本地(内存)实现或Mock实现
测试粒度
- 【强制】保证测试粒度足够小,有助于精确定位问题
- 单测粒度至多是类级别,一般是方法级别
- 单测不负责检查跨类或跨系统的交互逻辑
核心业务测试
- 【强制】核心业务、核心应用、核心模块的增量代码确保单元测试通过
代码目录
- 【强制】单元测试代码必须写在src/test/java目录下,不允许写在业务代码目录下
测试覆盖率
- 【推荐】单元测试基本目标:语句覆盖率达到70%;核心模块语句覆盖率和分支覆盖率都要达到100%
- DAO层、Manager层、可重用度高的Service都应该进行单元测试
BCDE原则
- 【推荐】编写单元测试代码遵守BCDE原则
- B:Border,边界值测试
- C:Correct,正确的输入,并得到预期结果
- D:Design,与设计文档相结合
- E:Error,强制错误信息输入,并得到预期结果
数据库测试
【推荐】数据库相关操作不能假设数据库数据存在,使用程序插入或导入数据准备数据
【推荐】数据库相关单元测试可设定自动回滚机制,或对单元测试产生的数据有明确的前后缀标识
代码可测性
- 【推荐】不可测的代码建议做必要重构,使代码变得可测
测试范围确定
- 【推荐】设计评审阶段,开发人员需要和测试人员一起确定单元测试范围
测试时机
- 【推荐】单元测试建议在项目提测前完成,不建议项目发布后补充
代码设计建议
- 【参考】为了方便单元测试,业务代码应避免:
- 构造方法中做的事情过多
- 存在过多的全局变量和静态方法
- 存在过多的外部依赖
- 存在过多的条件语句
常见误解
- 【参考】不要对单元测试存在误解:
- 那是测试同学干的事情
- 单元测试代码是多余的
- 单元测试代码不需要维护
- 单元测试与线上故障没有辩证关系