代码覆盖率统计神器-jacoco工具实战

代码覆盖（英语：Code coverage）是软件测试中的一种度量，描述程序中源代码被测试的比例和程度，所得比例称为代码覆盖率。

测试覆盖率

测试覆盖率是对测试完全程度的评测。测试覆盖率是由测试需求和测试用例的覆盖或已执行代码的覆盖的表示结果。一方面可以衡量测试工作本身的有效性，提升测试效率，一方面可以提升代码质量，减少bug，提升产品的可靠性，稳定性。

代码覆盖率的意义

· 分析未覆盖部分的代码，从而反推3在前期测试设计是否充分，没有覆盖到的代码是否是测试设计的盲点，为什么没有考虑到？需求/设计不够清晰，测试设计的理解有误，工程方法应用后的造成的策略性放弃等等，之后进行补充测试用例设计。

· 检测出程序中的废代码，可以逆向反推在代码设计中思维混乱点，提醒设计/开发人员理清代码逻辑关系，提升代码质量。

· 代码覆盖率高不能说明代码质量高，但是反过来看，代码覆盖率低，代码质量不会高到哪里去，可以作为测试自我审视的重要工具之一。

JaCoCo是一个免费的Java代码覆盖率库工具，由EclEmma团队根据多年来使用和集成现有库的经验创建的，其官网地址为https://www.eclemma.org/jacoco/。不论开发和测试都会有针对自己写的单元测试用例，统计覆盖了多少业务代码这样的诉求，另外一个诉求就是统计结果能够自动生成HTML报告，下面我就通过maven、junit、jacoco来实现以上这两点诉求。

首先需要在maven的pom配置文件中增加如下3个插件：

maven-surefire-plugin、jacoco-maven-plugin、maven-compiler-plugin。

这3个插件分别对应的功能是：

maven-surefire-plugin这个插件是执行junit、testng框架单元测试用例时使用的；

jacoco-maven-plugin这个插件是统计单元测试用例覆盖业务代码率时使用的；

maven-compiler-plugin这个插件是按照其配置的jdk版本来编译java源码时使用的。

以下3张截图是具体的配置内容，大家也可以根据最近的版本更新替换版本号。

接下来需要对业务代码编写单元测试用例，分别对应如下两张截图，

需要注意的是，测试用例的包名要和业务代码的包名要保持一致，否则JaCoCo无法统计覆盖率。

然后执行如下3条maven命令进行清除、插件安装、测试

然后在target\site\jacoco目录下可见本轮次单元测试结果报告的HTML格式结果。

打开JaCoCo的html格式报告如下所示，统计整体的覆盖率信息，单击包名链接，可以看到统计的详情信息。

值得注意的是App这个业务代码类中只有1个main方法，但是统计的方法数是2个，

这个统计是不是不准确？统计是准确的，App这个类中还有一个默认构造函数，虽然没有展示出来，如何证明那另外1个方法是构造函数呢？我们可以在App的测试类AppTest中增加构造函数的测试用例，具体如下截图所示。

再次执行单元测试，生成的JaCoCo单测覆盖率报告如下所示，Missed错失数由之前的2个变成0个。证明JaCoCo统计的方法中涵盖自动生成的默认构造函数。Cov.这列是统计指定业务的单元测试用例整体覆盖率的；而Missed Branches Cov.这列是针对有分支情况下统计的单元测试用例覆盖业务代码分支的覆盖率，如果某个业务类的Missed Branches Cov.分支覆盖率为n/a则说明这个业务类中没有分支情况，才会出现n/a这样结果，如下截图中App、CoCo这两个业务类中就没有分支代码，因此Missed Branches Cov.覆盖率统计结果为n/a，可以理解为这两个业务类不需要统计分支覆盖率；其他各个列，在实际工作过程中不是重点关注的覆盖率统计项。