[docs add]单元测试指南

Author: Snailclimb

README.md

@@ -216,8 +216,9 @@ JVM 这部分内容主要参考 [JVM 虚拟机规范-Java8 ](https://docs.oracle
 ### 基础
 
 - [RestFul API 简明教程](docs/system-design/basis/RESTfulAPI.md)
--  [Java 命名之道](docs/system-design/basis/naming.md) 
-- [重构](./docs/system-design/basis/refactoring.md)
+- [Java 编码命名之道](docs/system-design/basis/naming.md) 
+- [代码重构指南](./docs/system-design/basis/refactoring.md)
+- [单元测试指南](./docs/system-design/basis/unit-test.md)
 
 ### 常用框架
 

docs/.vuepress/sidebar.ts

@@ -334,7 +334,24 @@ export const sidebarConfig = defineSidebarConfig({
           prefix: "basis/",
           icon: "basic",
           collapsable: true,
-          children: ["RESTfulAPI", "naming", "refactoring"],
+          children: [
+            {
+              text: "RESTful API",
+              link: "RESTfulAPI",
+            },
+            {
+              text: "编码命名",
+              link: "naming",
+            },
+            {
+              text: "重构",
+              link: "refactoring",
+            },
+            {
+              text: "单元测试",
+              link: "unit-test",
+            },
+          ],
         },
         {
           text: "安全",

docs/system-design/basis/RESTfulAPI.md

@@ -1,12 +1,10 @@
 ---
-title:  RestFul API
+title: RestFul API 简明教程
 category: 代码质量
 ---
 
 ![](https://img-blog.csdnimg.cn/2021050713553862.png)
 
-大家好，我是 Guide哥！
-
 这篇文章简单聊聊后端程序员必备的 RESTful API 相关的知识。
 
 开始正式介绍 RESTful API 之前，我们需要首先搞清 ：**API 到底是什么？**

docs/system-design/basis/naming.md

@@ -1,5 +1,5 @@
 ---
-title:  命名
+title:  Java 编码命名之道
 category: 代码质量
 ---
 

docs/system-design/basis/refactoring.md

@@ -1,5 +1,5 @@
 ---
-title:  重构
+title:  代码重构指南
 category: 代码质量
 ---
 

docs/system-design/basis/unit-test.md

@@ -0,0 +1,122 @@
+---
+title:  单元测试到底是什么？应该怎么做？
+category: 代码质量
+---
+
+> 本文重构完善自[谈谈为什么写单元测试 - 键盘男 - 2016](https://www.jianshu.com/p/fa41fb80d2b8)这篇文章。
+
+## 何谓单元测试？
+
+维基百科是这样介绍单元测试的：
+
+> 在计算机编程中，单元测试（Unit Testing）是针对程序模块（软件设计的最小单位）进行的正确性检验测试工作。
+>
+> 程序单元是应用的 **最小可测试部件** 。在过程化编程中，一个单元就是单个程序、函数、过程等；对于面向对象编程，最小单元就是方法，包括基类（超类）、抽象类、或者派生类（子类）中的方法。
+
+由于每个单元有独立的逻辑，在做单元测试时，为了隔离外部依赖，确保这些依赖不影响验证逻辑，我们经常会用到 Fake、Stub 与 Mock 。
+
+关于 Fake、Mock 与 Stub 这几个概念的解读，可以看看这篇文章：[测试中 Fakes、Mocks 以及 Stubs 概念明晰 - 王下邀月熊 - 2018](https://zhuanlan.zhihu.com/p/26942686) 。
+
+## 为什么需要单元测试？
+
+### 为重构保驾护航
+
+我在[重构](./refactoring.md)这篇文章中这样写到：
+
+> 单元测试可以为重构提供信心，降低重构的成本。我们要像重视生产代码那样，重视单元测试。
+
+每个开发者都会经历重构，重构后把代码改坏了的情况并不少见，很可能你只是修改了一个很简单的方法就导致系统出现了一个比较严重的错误。
+
+如果有了单元测试的话，就不会存在这个隐患了。写完一个类，把单元测试写了，确保这个类逻辑正确；写第二个类，单元测试.....写 100 个类，道理一样，每个类做到第一点“保证逻辑正确性”，100 个类拼在一起肯定不出问题。你大可以放心一边重构，一边运行 APP；而不是整体重构完，提心跳胆地 run。
+
+### 提高代码质量
+
+由于每个单元有独立的逻辑，做单元测试时需要隔离外部依赖，确保这些依赖不影响验证逻辑。因为要把各种依赖分离，单元测试会促进工程进行组件拆分，整理工程依赖关系，更大程度减少代码耦合。这样写出来的代码，更好维护，更好扩展，从而提高代码质量。
+
+### 减少 bug
+
+一个机器，由各种细小的零件组成，如果其中某件零件坏了，机器运行故障。必须保证每个零件都按设计图要求的规格，机器才能正常运行。
+
+一个可单元测试的工程，会把业务、功能分割成规模更小、有独立的逻辑部件，称为单元。单元测试的目标，就是保证各个单元的逻辑正确性。单元测试保障工程各个“零件”按“规格”（需求）执行，从而保证整个“机器”（项目）运行正确，最大限度减少 bug。
+
+### 快速定位 bug
+
+如果程序有 bug，我们运行一次全部单元测试，找到不通过的测试，可以很快地定位对应的执行代码。修复代码后，运行对应的单元测试；如还不通过，继续修改，运行测试.....直到**测试通过**。
+
+### 持续集成依赖单元测试
+
+持续集成需要依赖单元测试，当持续集成服务自动构建新代码之后，会自动运行单元测试来发现代码错误。
+
+## 谁逼你写单元测试？
+
+### 领导要求
+
+有些经验丰富的领导，或多或少都会要求团队写单元测试。对于有一定工作经验的队友，这要求挺合理；对于经验尚浅的、毕业生，恐怕要死要活了，连代码都写不好，还要写单元测试，are you kidding me？
+
+培训新人单元测试用法，是一项艰巨的任务。新人代码风格未形成，也不知道单元测试多重要，强制单元测试会让他们感到困惑，没办法按自己思路写代码。
+
+### 大牛都写单元测试
+
+国外很多家喻户晓的开源项目，都有大量单元测试。例如，[retrofit](https://link.jianshu.com?t=https://github.com/square/retrofit/tree/master/retrofit/src/test/java/retrofit2)、[okhttp](https://link.jianshu.com?t=https://github.com/square/okhttp/tree/master/okhttp-tests/src/test/java/okhttp3)、[butterknife](https://link.jianshu.com?t=https://github.com/JakeWharton/butterknife/tree/master/butterknife-compiler/src/test/java/butterknife).... 国外大牛都写单元测试，我们也写吧！
+
+很多读者都有这种想法，一开始满腔热血。当真要对自己项目单元测试时，便困难重重，很大原因是项目对单元测试不友好。最后只能对一些不痛不痒的工具类做单元测试，久而久之，当初美好愿望也不了了之。
+
+### 保住面子
+
+都是有些许年经验的老鸟，还天天被测试同学追 bug，好意思么？花多一点时间写单元测试，确保没低级 bug，还能彰显大牛风范，何乐而不为？
+
+### 心虚
+
+笔者也是个不太相信自己代码的人，总觉得哪里会突然冒出莫名其妙的 bug，也怕别人不小心改了自己的代码（被害妄想症），新版本上线提心跳胆......花点时间写单元测试，有事没事跑一下测试，确保原逻辑没问题，至少能睡安稳一点。
+
+## TDD 测试驱动开发
+
+### 何谓 TDD？
+
+TDD 即 Test-Driven Development（ 测试驱动开发），这是敏捷开发的一项核心实践和技术，也是一种设计方法论。
+
+TDD 原理是开发功能代码之前，先编写测试用例代码，然后针对测试用例编写功能代码，使其能够通过。
+
+TDD 的节奏：“红 - 绿 - 重构”。
+
+![](https://static001.geekbang.org/resource/image/09/7f/090e1fc6aff08b4aa66376f776c2337f.png)
+
+由于 TDD 对开发人员要求非常高，跟传统开发思维不一样，因此实施起来相当困难。
+
+TDD 在很多人眼中是不实用的，一来他们并不理解测试“驱动”开发的含义，但更重要的是，他们很少会做任务分解。而任务分解是做好 TDD 的关键点。只有把任务分解到可以测试的地步，才能够有针对性地写测试。
+
+### TDD 优缺点分析
+
+测试驱动开发有好处也有坏处。因为每个测试用例都是根据需求来的，或者说把一个大需求分解成若干小需求编写测试用例，所以测试用例写出来后，开发者写的执行代码，必须满足测试用例。如果测试不通过，则修改执行代码，直到测试用例通过。
+
+**优点** ：
+
+1. 帮你整理需求，梳理思路；
+2. 帮你设计出更合理的接口（空想的话很容易设计出屎）；
+3. 减小代码出现 bug 的概率；
+4. 提高开发效率（前提是正确且熟练使用 TDD）。
+
+**缺点** ：
+
+1. 能用好 TDD 的人非常少，看似简单，实则门槛很高；
+2. 投入开发资源（时间和精力）通常会更多；
+3. 由于测试用例在未进行代码设计前写；很有可能限制开发者对代码整体设计；
+4. 可能引起开发人员不满情绪，我觉得这点很严重，毕竟不是人人都喜欢单元测试，尽管单元测试会带给我们相当多的好处。
+
+相关阅读：[如何用正确的姿势打开 TDD？ - 陈天 - 2017](https://zhuanlan.zhihu.com/p/24997923)  。
+
+## 总结
+
+单元测试确实会带给你相当多的好处，但不是立刻体验出来。正如买重疾保险，交了很多保费，没病没痛，十几年甚至几十年都用不上，最好就是一辈子用不上理赔，身体健康最重要。单元测试也一样，写了可以买个放心，对代码的一种保障，有 bug 尽快测出来，没 bug 就最好，总不能说“写那么多单元测试，结果测不出 bug，浪费时间”吧？
+
+以下是个人对单元测试一些建议：
+
+> - 越重要的代码，越要写单元测试；
+> - 代码做不到单元测试，多思考如何改进，而不是放弃；
+> - 边写业务代码，边写单元测试，而不是完成整个新功能后再写；
+> - 多思考如何改进、简化测试代码。
+> - 测试代码需要随着生产代码的演进而重构或者修改，如果测试不能保持整洁，只会越来越难修改。
+
+作为一名经验丰富的程序员，写单元测试更多的是**对自己的代码负责**。有测试用例的代码，别人更容易看懂，以后别人接手你的代码时，也可能放心做改动。
+
+**多敲代码实践，多跟有单元测试经验的工程师交流**，你会发现写单元测试获得的收益会更多。