瑞_Java开发手册_（三）单元测试

前言：本文章为瑞_系列专栏之《Java开发手册》的单元测试篇。由于博主是从阿里的《Java开发手册》学习到Java的编程规约，所以本系列专栏主要以这本书进行讲解和拓展，有需要的小伙伴可以点击链接下载。本文仅供大家交流、学习及研究使用，禁止用于商业用途，违者必究！

本系列第一篇链接：（一）编程规约
本系列第二篇链接：（二）异常日志

单元测试的意义

  单元测试，又被称为模块测试，是针对程序模块（软件设计的最小单位）进行的准确度检验。这种测试主要集中于程序的逻辑和功能，而非系统的整体行为，它可以帮助开发人员写出更高质量的代码，提高开发效率，减少维护成本，并增强软件的可靠性。

  在实际开发过程中，由于项目进度紧张，很多开发者为了尽快完成功能而忽略了单元测试，或者过于依赖自己的经验而认为代码没有问题，从而忽略了单元测试的重要性。要知道小心驶得万年船，往往很多问题通过简单的单元测试就能及时发现和修复潜在的问题，因此，我们应该重视单元测试，并将其纳入软件开发的标准流程中。

  单元测试主要的意义如下：

• 确保代码实现符合预期：单元测试可以验证代码的每个部分是否按预期工作。如果测试失败，那就意味着代码中存在错误，需要修复。
• 尽早发现错误：通过单元测试，可以在开发早期就发现和修复错误，这样可以节省大量的时间和精力。
• 提高代码质量：单元测试鼓励开发人员写出更加模块化、可维护和可读的代码。这是因为每个模块都需要进行测试，所以代码必须清晰、易于理解和易于维护。
• 建立信心：随着单元测试的通过，开发人员会对他们的代码越来越有信心。这不仅提高了开发效率，也减少了在后期修复错误的可能性。
• 文档和说明：单元测试本身就是一种文档和说明。它们可以清晰地解释代码的工作原理和预期行为，这对于维护和未来的开发是非常有帮助的。
• 防止重构引入错误：如果代码已经过充分的单元测试，那么在重构时，就可以更放心地修改代码，因为单元测试会捕捉到任何潜在的错误。
• 优化性能：通过单元测试，可以发现性能问题并进行优化。例如，如果一个函数的执行时间过长，单元测试就会捕捉到这个问题。
• 集成测试的基础：单元测试是集成测试的基础。只有当每个单元都正常工作时，整个系统才能正常工作。
• 减少后期维护成本：如果在项目后期才发现错误，修复的成本会比早期发现错误高出很多倍。通过单元测试，可以在项目早期就发现和修复错误，从而降低后期维护成本。
• 自动化和持续集成：单元测试可以很容易地与自动化工具集成，从而实现持续集成和持续部署（CI/CD），进一步提高开发效率和代码质量。

---

单元测试

1. 【强制】好的单元测试必须遵守 AIR 原则。
   说明：单元测试在线上运行时，感觉像空气（AIR）一样并不存在，但在测试质量的保障上，却是非常关键的。好的单元测试宏观上来说，具有自动化、独立性、可重复执行的特点。
   • A：Automatic（自动化）
   • I：Independent（独立性）
   • R：Repeatable（可重复）

瑞：
  A：单元测试应该是全自动执行的，无需人工干预。因为测试用例通常会定期执行，如果需要人工参与，那么效率将大打折扣。此外，输出结果需要人工检查的测试不能被视为一个好的单元测试。
  I：单元测试用例之间必须保持独立，决不能互相调用，也不能依赖执行的先后次序。这样做可以确保单元测试的稳定性和可靠性，同时也使得测试更加便于维护。
  R：单元测试是可以重复执行的，无论何时执行，都应得到相同的结果。这是为了确保测试的一致性，并减少由于环境变化导致的结果差异。

2. 【强制】单元测试应该是全自动执行的，并且非交互式的。测试用例通常是被定期执行的，执行过程必须完全自动化才有意义。输出结果需要人工检查的测试不是一个好的单元测试。单元测试中不准使用System.out 来进行人肉验证，必须使用 assert 来验证。

瑞：需要注意的是，assert语句在Java中默认是被禁用的，只有在开发和调试阶段，assert才会被启用。如下示例：

    @Test
    public void test(){
        int age = -1;
        assert age >= 0 : "年龄不能为负数";
    }

3. 【强制】保持单元测试的独立性。为了保证单元测试稳定可靠且便于维护，单元测试用例之间决不能互相调用，也不能依赖执行的先后次序。
   反例：method2 需要依赖 method1 的执行，将执行结果作为 method2 的输入。

瑞：每个测试用例只负责测试目标方法的逻辑正确性，而不应该受其内部调用的其他方法的逻辑影响。总有大聪明忽略这条，并且在用maven打包的时候没有跳过test，后果可想而知…

4. 【强制】单元测试是可以重复执行的，不能受到外界环境的影响。
   说明：单元测试通常会被放到持续集成中，每次有代码 check in 时单元测试都会被执行。如果单测对外部环境（网络、服务、中间件等）有依赖，容易导致持续集成机制的不可用。
   正例：为了不受外界环境影响，要求设计代码时就把 SUT 的依赖改成注入，在测试时用 spring 这样的 DI框架注入一个本地（内存）实现或者 Mock 实现。

瑞：让我想起一个段子：一个前端程序员一直盯着系统时间，问他在干嘛，他说他在等token过期后再测一遍

5. 【强制】对于单元测试，要保证测试粒度足够小，有助于精确定位问题。单测粒度至多是类级别，一般是方法级别。
   说明：只有测试粒度小才能在出错时尽快定位到出错位置。单测不负责检查跨类或者跨系统的交互逻辑，那是集成测试的领域。

瑞：要搞清楚单元测试和集成测试的区别

6. 【强制】核心业务、核心应用、核心模块的增量代码确保单元测试通过。
   说明：新增代码及时补充单元测试，如果新增代码影响了原有单元测试，请及时修正。

7. 【强制】单元测试代码必须写在如下工程目录：src/test/java，不允许写在业务代码目录下。
   说明：源码编译时会跳过此目录，而单元测试框架默认是扫描此目录。

瑞：这是大家公认的单元测试路径约定，随意修改容易造成误导。并且测试类的类名请用XXXTest命名。

8. 【推荐】单元测试的基本目标：语句覆盖率达到 70%；核心模块的语句覆盖率和分支覆盖率都要达到 100%
   说明：在工程规约的应用分层中提到的 DAO 层，Manager 层，可重用度高的 Service，都应该进行单元测试。

9. 【推荐】编写单元测试代码遵守 BCDE 原则，以保证被测试模块的交付质量。

   • B：Border，边界值测试，包括循环边界、特殊取值、特殊时间点、数据顺序等。
   • C：Correct，正确的输入，并得到预期的结果。
   • D：Design，与设计文档相结合，来编写单元测试。
   • E：Error，强制错误信息输入（如：非法数据、异常流程、业务允许外等），并得到预期的结果。

10. 【推荐】对于数据库相关的查询，更新，删除等操作，不能假设数据库里的数据是存在的，或者直接操作数据库把数据插入进去，请使用程序插入或者导入数据的方式来准备数据。
    反例：删除某一行数据的单元测试，在数据库中，先直接手动增加一行作为删除目标，但是这一行新增数据并不符合业务插入规则，导致测试结果异常。

瑞：反例是容易造成脏数据的巨坑之一，无论什么时候都建议不要直接使用数据库进行插入操作，尽量使用前端或者程序的最上层接口方法或者直接导入

11. 【推荐】和数据库相关的单元测试，可以设定自动回滚机制，不给数据库造成脏数据。或者对单元测试产生的数据有明确的前后缀标识。
    正例：在阿里巴巴企业智能事业部的内部单元测试中，使用ENTERPRISE_INTELLIGENCE _UNIT_TEST_的前缀来标识单元测试相关代码。

瑞：博主认为本条应该修改为【强制】使用特殊前后缀标识来区分测试数据，防止脏数据产生时无法判断该脏数据是否为脏数据

12. 【推荐】对于不可测的代码在适当的时机做必要的重构，使代码变得可测，避免为了达到测试要求而书写不规范测试代码。

13. 【推荐】在设计评审阶段，开发人员需要和测试人员一起确定单元测试范围，单元测试最好覆盖所有测试用例（UC）。

14. 【推荐】单元测试作为一种质量保障手段，在项目提测前完成单元测试，不建议项目发布后补充单元测试用例。

瑞：实在来不及的话，那该测还是得测

15. 【参考】为了更方便地进行单元测试，业务代码应避免以下情况：
    • 构造方法中做的事情过多。
    • 存在过多的全局变量和静态方法。
    • 存在过多的外部依赖。
    • 存在过多的条件语句。
      说明：多层条件语句建议使用卫语句、策略模式、状态模式等方式重构。

瑞：其中卫语句示例如下：

    public void findBoyfriend(Man man) {
        if (man.isUgly()) {
            System.out.println("本姑娘是外貌协会的资深会员");
            return;
        }
        if (man.isPoor()) {
            System.out.println("贫贱夫妻百事哀");
            return;
        }
        if (man.isBadTemper()) {
            System.out.println("银河有多远，你就给我滚多远");
            return;
        }
        System.out.println("可以先交往一段时间看看");
    }

16. 【参考】不要对单元测试存在如下误解：
    • 那是测试同学干的事情。本文是开发手册，凡是本文内容都是与开发同学强相关的。
    • 单元测试代码是多余的。系统的整体功能与各单元部件的测试正常与否是强相关的。
    • 单元测试代码不需要维护。一年半载后，那么单元测试几乎处于废弃状态。
    • 单元测试与线上故障没有辩证关系。好的单元测试能够最大限度地规避线上故障。

瑞：后端同学也一定要养成好的单元测试习惯

---

本文是博主的粗浅理解，可能存在一些错误或不完善之处，如有遗漏或错误欢迎各位补充，谢谢

  如果觉得这篇文章对您有所帮助的话，请动动小手点波关注，你的点赞收藏⭐️转发评论都是对博主最好的支持~