使用Jacoco统计服务端代码覆盖情况实践

一、背景

随着需求的迭代，需求增加的同时，有可能会伴随着一些功能的下线。如果不对系统已经不用的代码进行梳理并删除不需要的代码，那么就会增加系统维护成本以及理解成本。但经历比较长的迭代以及系统交接，可能有些代码并不确定是否能够删除，因此基于此困境基于Jacoco对代码进行分析，对系统做“瘦身”。

二、原理

Jacoco本质上是一个测试覆盖率工具，通过ASM字节码增强技术在源代码中加入探针从而获取代码覆盖率，有两个主要功能一是单测覆盖率二是接口覆盖率。大部分情况下我们只用于生成单测覆盖率，而为了实现对服务端代码使用情况进行统计，需要使用Jacoco生成服务端的接口测试覆盖率，即对线上对接口的每一次请求作为接口测试。此外还使用到jacoco ant，用于直接调用执行command line命令。

三、最佳实践

在项目上添加Maven依赖

<dependency>
    <groupId>org.jacoco</groupId>
    <artifactId>org.jacoco.ant</artifactId>
    <version>0.8.3</version>
</dependency>
<dependency>
     <groupId>org.apache.ant</groupId>
     <artifactId>ant</artifactId>
     <version>1.9.9</version>
 </dependency>

添加一个url地址，用于Dump Coverage文件即exec文件，请求时间产生的exec文件代表的是从启动到dump时的所有请求覆盖的代码。

@RestController
@RequestMapping("coverage")
public class CoverageController {


    @PostMapping("dump")
    public Result<Boolean> dumpCoverageFile() {
        DumpTask dumpTask = new DumpTask();
		// dump文件存储地址,确保有写的权限
        dumpTask.setDestfile(new File("/export/code-cover.exec"));
		// 多次dump追加形式
        dumpTask.setAppend(true);
		// 选一个空闲接口即可
        dumpTask.setPort(8840);
		// 默认本机tomcat
        dumpTask.setAddress("127.0.0.1");
        dumpTask.execute();
        return Result.succeed(true);
    }
}

以上为代码需要进行的修改。

此外包部署的环境中（服务器）需要有jacoco的java agent包，名称jacocoagent.jar，可以如果不好联系运维进行包上传，可以直接解压缩maven依赖中下载的包org.jacoco.agent-0.8.3.jar包含有jacocoagent.jar。解压缩命令参考：${jarPath}为占位符，代表org.jacoco.agent-0.8.3.jar包所在路径

#decompress file 解压依赖，获得jacocoagent.jar包，避免需要联系运维上传包
jar -xvf ${jarPath}

java启动参数添加,即指定JVM相关的那个启动参数：存在多个javaagent时，比如可能还有性能监控等等，按顺序添加agent参数即可即 -javaagent:${agent1} -javaagent:...。

• ${agentJarPath}为占位符代表jacocoagent.jar所在路径。

• ${packagePath}为占位符，代表需要统计的包路径，可使用*进行匹配。

-javaagent:${agentJarPath}=includes=${packagePath},output=tcpserver,port=8840,address=127.0.0.1 -Xverify:none

通过url请求后可以在指定文件夹下找到对应的exec文件然后通过运维工具或scp等进行文件下载。

下载文件成功后，打开ｉｄｅａ－＞ｒｕｎ－＞ｓｈｏｗ　ｃｏｖｅｒａｇｅ　ｄａｔａ选择对应的ｅｘｅｃ文件即可获取服务端的代码覆盖情况。通过代码覆盖情况可对已经不需要的代码进行删除，降低维护成本。