JaCoCo助您毁灭线上僵尸代码

京东技术

发布于 2023-10-31 15:35:46

3960

发布于 2023-10-31 15:35:46

文章被收录于专栏：京东技术

Tech 导读随着需求不断迭代，业务系统的业务代码突飞猛进，在你自豪于自己的代码量产出很高时，有没有回头看看线上真正的客户使用量又有多少呢🤔？赶快利用jacoco探针深入分析一行行代码，让您看到线上功能运行最真实的一面，参照代码覆盖情况针对性下线和删除僵尸代码，提升产研效能，降低维护成本！

01

现状·问题

在今年的敏捷团队建设中，我通过Suite执行器实现了一键自动化单元测试。Juint除了Suite执行器还有哪些执行器呢？由此我的Runner探索之旅开始了！

随着需求不断迭代，业务系统的业务代码突飞猛进，在你自豪于自己的代码量产出很高时，有没有回头看看线上真正的客户使用量又有多少呢？

~费事费力耗费大量人力成本~上线的功能，可能一年没人使用，如果不进行适当的下线，就会增加系统维护成本，此时就需要计划删除无用代码。但是我们怎么知道真实线上的一行行代码层面，是否真实在使用，或者真实没人用，怎么可以放心删除下线功能呢！

02

分析原因

理解，首先 MCube 会依据模板缓存状态判断是否需要网络获取最新模板，当获取到模板后进行模板加载，加载阶段会将产物转换为视图树的结构，转换完成后将通过表达式引擎解析表达式并取得正确的值，通过事件解析引擎解析用户自定义事件并完成事件的绑定，完成解析赋值以及事件绑定后进行视图的渲染，最终将目标页面展示到屏幕。

实际上多数业务系统都会存在这个通病：线上僵尸代码

•可能是前期产品对业务场景没有分析到位

•可能是研发期间需求功能偏离了正确方向

•可能是上线后因外界因素使客户业务量下降

•······

03

采取措施

理解，首先 MCube 会依据模板缓存状态判断是否需要网络获取最新模板，当获取到模板后进行模板加载，加载阶段会将产物转换为视图树的结构，转换完成后将通过表达式引擎解析表达式并取得正确的值，通过事件解析引擎解析用户自定义事件并完成事件的绑定，完成解析赋值以及事件绑定后进行视图的渲染，最终将目标页面展示到屏幕。

问产品经理哪些能下线？NO 没人敢承诺

观测 UMP接口是否有流量？NO 只知道接口维度，有流量的接口难道所有代码都有用么

使用jacoco（Java Code Coverage）进行线上代码分析，对系统做瘦身。

Jacoco本质上是一个测试覆盖率工具，通过ASM字节码增强技术在源代码中加入探针从而获取代码覆盖率。Jacoco主要是通过Jave agent在main函数执行之前通过指定方法在执行的代码中加入探针来记录代码是否被执行过。

Java agent是Java提供的一个启动参数，有别于代理方式的动态增强和annotation processor的编译时增强，该参数通过指定路径的jar包中的premain方法将在main方法执行之前被调用增强源代码，通过实现该方法我们可以对加载的Class文件进行修改源代码增强，使用此技术的还有大部分APM工具。

https://www.jacoco.org/jacoco/trunk/doc/index.html

04

实践步骤

理解，首先 MCube 会依据模板缓存状态判断是否需要网络获取最新模板，当获取到模板后进行模板加载，加载阶段会将产物转换为视图树的结构，转换完成后将通过表达式引擎解析表达式并取得正确的值，通过事件解析引擎解析用户自定义事件并完成事件的绑定，完成解析赋值以及事件绑定后进行视图的渲染，最终将目

4.1 依赖jacoco.ant

在工程内的pom中引入jar依赖

<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>

4.2 赋能Rest请求

添加一个url地址，通过ant执行dump task用于Dump Coverage文件，避免使用配置文件且同时需要运维同事帮忙操作的问题。

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

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

4.3 嵌入jacocoagent

由于jacoco需要在服务端由jacocoagent增强的jar包，为了避免需要麻烦运维同事，通过maven依赖可以发现org.jacoco.agent这个jar包中包含由jacocoagent这个包，所以通过在部署的启动脚本添加以下命令即可通过解压的方式获得该jar包！

java启动参数添加如下：存在多个javaagent时比如pfinder之类在其后添加即可。

#decompress file 解压依赖，获得jacocoagent.jar包，避免需要联系运维上传包
jar -xvf $BASEDIR/lib/org.jacoco.agent-0.8.3.jar

-javaagent:$BASEDIR/bin/jacocoagent.jar=includes=com.jdwl.*,output=tcpserver,port=8840,address=127.0.0.1 -Xverify:none

图1.

premain方法中可以通过Instrumention的addTransformer添加ClassFileTransformer接口的实现类，该接口中仅有一个方法如下，通过实现ClassTransformer我们可以定义自己的代码增强方法。可以使用ASM，亦可以使用javasist等高级类库。

相关实践：Diving Into Bytecode Manipulation: Creating an Audit Log With ASM and Javassist | New Reli（https://newrelic.com/blog/best-practices/java-performance-monitoring）

4.4 JDOS资源预留

资源预留/export目录自定义处理（http://help.jcd.jd.com/help/jdos_jdd/novice/）

图2.

增加配置脚本 /home/admin/clean_export.sh（脚本默认内容上增加了 && $9 != "coverage"）

输出的文件路径为/export/Data/coverage/code-cover.exec

#! /bin/bash

ls -lh /export | awk 'NR >1 {print}' | awk '{if ($9 != "Data") print $9}' | xargs -i /bin/rm -rf /export/{} > /dev/null 2>&1
ls -lh /export/Data | awk 'NR >1 {print}' | awk '{if ($9 != "jdos.jd.com" && $9 != "coverage") print $9}' | xargs -i /bin/rm -rf /export/Data/{} > /dev/null 2>&1

图3.

4.5 下载cover文件

/export/Data/coverage/code-cover.exec

图4.

登录堡垒机终端

 cd /export/Data/coverage

jdos下载文件（http://help.jcd.jd.com/help/jdos_jdd/operation_tools/terminal.html#%E7%BB%88%E7%AB%AF%E4%BE%BF%E6%8D%B7%E4%B8%8B%E8%BD%BD-%E4%B8%8A%E4%BC%A0%E6%96%87%E4%BB%B6）

 curl -s up.bastion.jd.com/file/up | bash

4.6 分析代码

打开idea -> run -> show coverage data选择对应的exec文件即可获取服务端的代码覆盖情况。

绿色覆盖（活跃代码）

图5.

红色未覆盖（僵尸代码）

图6.

Reference

1.JaCoCo - Documentatio（https://www.jacoco.org/jacoco/trunk/doc/index.html）

2.javaagent使用指南 - rickiyang - 博客园 (cnblogs.com）（https://www.cnblogs.com/rickiyang/p/11368932.html）

3.使用Jacoco统计服务端代码覆盖情况实践 - M104 - 博客园 (cnblogs.com）（https://www.cnblogs.com/ccoder/p/15369719.html#4946710）

4.Diving Into Bytecode Manipulation: Creating an Audit Log With ASM and Javassist | New Reli（https://newrelic.com/blog/best-practices/java-performance-monitoring）

05

效能提升

理解，首先 MCube 会依据模板缓存状态判断是否需要网络获取最新模板，当获取到模板后进行模板加载，加载阶段会将产物转换为视图树的结构，转换完成后将通过表达式引擎解析表达式并取得正确的值，通过事件解析引擎解析用户自定义事件并完成事件的绑定，完成解析赋值以及事件绑定后进行视图的渲染，最终将目

5.1 需求交付效率提升