2. 阿里巴巴Java开发手册主题

• 经验总结
  • 最终目的是，使用不同的参数调用一次或多次被测函数，保证跑到所有的分支代码。
    • 如果有返回值，每种情况的返回值要进行判断是否符合预期。
    • 如果依赖其他函数、接口等，那么要进行mock，且mock的数据的结构和值要合适，这样才能跑到所有的分支并保持正确的逻辑。且并不关心被依赖的函数或接口的逻辑，只要mock其合适的返回值就行。
  • 被测代码要便于测试，通常要把业务逻辑提取成函数（提出成的函数要有适合Mock模拟的输入参数格式），那么单元测试的任务就是测试不同输入情况下函数的输出了。
  • 单元测试中在检查函数输出时，通常将输出结果和输入数据的对应部分进行对比检查（assert、expect等）。
  • Mock模拟数据（接口调用、底层函数/库调用等）的准备
    • 只需要测是否成功调用了、入参对不对；在需要继续测返回的数据时，可以手动指定想让其返回的想要的不同情况下的Mock数据，也就对处理逻辑进行了进一步的测试。
    • 为了方便使用Mock模拟数据，所以不要把接口请求放到单元测试函数中，需要的数据最好都作为被测函数的参数输入。
    • Mock模拟数据可以单独存成文件，如json文件，如Typescript中可以直接引用json文件当成对象使用。
  • 单元测试需要测试正常输入、边界值、异常输入、特殊处理/输出（如无数据时返回'-'）等各种情况。
  • 其他
    • 测试范围要看项目要求，有的只要测所有的业务类即可，可在test.ts中配置。
    • 业务类中所有的public的函数都要测，理论上那些private的函数应该都被这些public的函数用到了，所以其实也一起测了，不然也就不需要放到这个业务类中了。
    • 要基于使用者的角度，从最外层黑盒的角度（expect所比较的对象是最外层参数调用和最终结果），把所有的可能性和分支都测到。
    • 如果入参有很多种排列组合的可能性，不一定要想办法全测到（如果入参是个对象，那么针对对象成员变量的所有值的排列组合，还要通过反射等方式进行组合。。。），但基本的最常见的要测（比如全空时，全有值时，一般场景等）。
      • 可以理解成只要代码都覆盖到就行，就说明没有因参数而异的太特殊的逻辑没有被覆盖到。
• • 强制
  • 好的单元测试必须遵守AIR原则。
    • 说明：单元测试在线上运行时，感觉像空气（AIR）一样并不存在，但在测试质量的保障上，却是非常关键的。好的单元测试宏观上来说，具有自动化、独立性、可重复执行的特点。
    • A：Automatic（自动化）
    • I：Independent（独立性）
    • R：Repeatable（可重复）
  • 单元测试应该是全自动执行的，并且非交互式的。测试用例通常是被定期执行的，执行过程必须完全自动化才有意义。输出结果需要人工检查的测试不是一个好的单元测试。单元测试中不准使用System.out来进行人肉验证，必须使用assert来验证。
  • 保持单元测试的独立性。为了保证单元测试稳定可靠且便于维护，单元测试用例之间决不能互相调用，也不能依赖执行的先后次序。
    • 反例：method2需要依赖method1的执行，将执行结果作为method2的输入。
  • 单元测试是可以重复执行的，不能受到外界环境的影响。
    • 说明：单元测试通常会被放到持续集成中，每次有代码check in时单元测试都会被执行。如果单测对外部环境（网络、服务、中间件等）有依赖，容易导致持续集成机制的不可用。
    • 正例：为了不受外界环境影响，要求设计代码时就把SUT的依赖改成注入，在测试时用spring 这样的DI框架注入一个本地（内存）实现或者Mock实现。
  • 对于单元测试，要保证测试粒度足够小，有助于精确定位问题。单测粒度至多是类级别，一般是方法级别。
    • 说明：只有测试粒度小才能在出错时尽快定位到出错位置。单测不负责检查跨类或者跨系统的交互逻辑，那是集成测试的领域。
  • 核心业务、核心应用、核心模块的增量代码确保单元测试通过。
    • 说明：新增代码及时补充单元测试，如果新增代码影响了原有单元测试，请及时修正。
  • 单元测试代码必须写在如下工程目录：src/test/java，不允许写在业务代码目录下。
    • 说明：源码编译时会跳过此目录，而单元测试框架默认是扫描此目录。
• 推荐
  • 单元测试的基本目标：语句覆盖率达到70%；核心模块的语句覆盖率和分支覆盖率都要达到100%
    • 说明：在工程规约的应用分层中提到的DAO层，Manager层，可重用度高的Service，都应该进行单元测试。
  • 编写单元测试代码遵守BCDE原则，以保证被测试模块的交付质量。
    • B：Border，边界值测试，包括循环边界、特殊取值、特殊时间点、数据顺序等。
    • C：Correct，正确的输入，并得到预期的结果。
    • D：Design，与设计文档相结合，来编写单元测试。
    • E：Error，强制错误信息输入（如：非法数据、异常流程、业务允许外等），并得到预期的结果。
  • 对于数据库相关的查询，更新，删除等操作，不能假设数据库里的数据是存在的，或者直接操作数据库把数据插入进去，请使用程序插入或者导入数据的方式来准备数据。
    • 反例：删除某一行数据的单元测试，在数据库中，先直接手动增加一行作为删除目标，但是这一行新增数据并不符合业务插入规则，导致测试结果异常。
  • 和数据库相关的单元测试，可以设定自动回滚机制，不给数据库造成脏数据。或者对单元测试产生的数据有明确的前后缀标识。
    • 正例：在企业智能事业部的内部单元测试中，使用ENTERPRISE_INTELLIGENCE _UNIT_TEST_的前缀来标识单元测试相关代码。
  • 对于不可测的代码在适当的时机做必要的重构，使代码变得可测，避免为了达到测试要求而书写不规范测试代码。
  • 在设计评审阶段，开发人员需要和测试人员一起确定单元测试范围，单元测试最好覆盖所有测试用例。
  • 单元测试作为一种质量保障手段，在项目提测前完成单元测试，不建议项目发布后补充单元测试用例。
• 参考
  • 为了更方便地进行单元测试，业务代码应避免以下情况：
    • 构造方法中做的事情过多。
    • 存在过多的全局变量和静态方法。
    • 存在过多的外部依赖。
    • 存在过多的条件语句。
      • 说明：多层条件语句建议使用卫语句、策略模式、状态模式等方式重构。
  • 不要对单元测试存在如下误解：
    • 那是测试同学干的事情。本文是开发手册，凡是本文内容都是与开发同学强相关的。
    • 单元测试代码是多余的。系统的整体功能与各单元部件的测试正常与否是强相关的。
    • 单元测试代码不需要维护。一年半载后，那么单元测试几乎处于废弃状态。
    • 单元测试与线上故障没有辩证关系。好的单元测试能够最大限度地规避线上故障。