观察Jacoco统计服务端代码覆盖情况

一、背景

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

二、原理

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

三、最佳实践

在项目上添加Maven依赖

org.jacocoorg.jacoco.ant0.8.3org.apache.antant1.9.9

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

@RestController@RequestMapping("coverage")publicclassCoverageController{@PostMapping("dump")publicResultdumpCoverageFile(){        DumpTask dumpTask =newDumpTask();// dump文件存储地址,确保有写的权限dumpTask.setDestfile(newFile("/export/code-cover.exec"));// 多次dump追加形式dumpTask.setAppend(true);// 选一个空闲接口即可dumpTask.setPort(8840);// 默认本机tomcatdumpTask.setAddress("127.0.0.1");        dumpTask.execute();returnResult.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等进行文件下载。

下载文件成功后,打开idea->run->show coverage data选择对应的exec文件即可获取服务端的代码覆盖情况。通过代码覆盖情况可对已经不需要的代码进行删除,降低维护成本。

参考资料:

https://xiaohaijing.lofter.com/

https://www.yidianzixun.com/article/0YXXo6Dg

http://www.77l.com/news/guide/244251.html

https://www.40407.com/zixun/42359.html

https://www.juxia.com/sjwy/zixun-34100.html

https://www.zcool.com.cn/article/ZMTMxMjY4NA==.html

https://m.ali213.net/news/yejie/172791.html

https://www.sohu.com/a/498531584_121024958

https://page.om.qq.com/page/OWY60IMBo1gL1OjG7rK9Gwwg0

https://www.sohu.com/a/498693629_121242107

https://xiaohaijing.lofter.com/post/4d262a03_2b3ea936c

https://zhuanlan.zhihu.com/p/428484447

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,734评论 6 505
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,931评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,133评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,532评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,585评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,462评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,262评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,153评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,587评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,792评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,919评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,635评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,237评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,855评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,983评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,048评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,864评论 2 354

推荐阅读更多精彩内容