Java代码覆盖率

1. JaCoCo是一个开源的覆盖率工具,它针对的开发语言是Java,使用方法灵活,可以嵌入到Ant,Maven中,也可作为Eclipse,Idea的插件,可以使用其JavaAgent技术监控Java程序等。
2. JaCoCo包含了多种尺度的覆盖率计数器,包含指令级覆盖,分支覆盖,圈复杂度,行覆盖,方法覆盖,类覆盖。
3. 注入方式
注入方式.png
1)  Jacoco在字节码注入时使用的是ASM技术修改字节码方法,可以修改.jar文件,.class文件字节码文件
2)  Jacoco同时支持on-the-fly和offline两种插桩方式
3)  On-the-fly插装:
    JVM通过-javaagent参数指定特定的jar文件启动instrumentation的代理程序,代理程序通过class loader装载一个class前判断是否转换修改class文件,将统计代码插入class,测试覆盖率分析可在JVM执行测试代码的过程中完成
4)  Offline:
    在测试前先对文件进行插桩,然后生成插过桩的class或jar包,测试插过桩的class和jar包后,会生成动态覆盖信息到文件,最后统一对覆盖信息进行处理,并生成报告
4. 一些情况下不支持on-the-fly,需要使用offline提前对字节码进行插桩:
a)  运行环境不支持Java agent
b)  部署环境不允许设置JVM参数
c)  字节码需要被转换成其他的虚拟机如Android Dalvik VM
d)  动态修改字节码过程中和其他agent冲突
e)  无法自定义用户加载
5. 官网地址

一、 部署

1. 下载Jacoco,网址:https://www.eclemma.org/jacoco/
下载JaCoCo.png
2. Jacoco以压缩包的形式传到服务器然后解压,jacoco从网站上下载下来是zip格式,通过unzip 包名.zip进行解压
3. 解压后,打开文件夹,里面有如下的文件
JaCoCo文件.png
4. lib文件下是.jar,其中会用到的是jacocoagent.jar,jacococli.jar
image.png
5. 在启动jar的时候使用-javaagent作为一个选项来启动程序
  1. 当项目使用Tomcat的时候,在Tomcat下有一个bin文件夹,下面有Catalina.sh文件可以来使用-Javaagent,通过vim Catalina.sh来打开该文件,点击i(英文键盘下)进入编辑模式,加上如下图所示的JAVA_OPTS(JVM运行参数的变量),-javaagent参数接受的参数和参数的含义详解:https://www.eclemma.org/jacoco/trunk/doc/agent.html

    image.png

    a) –Javaagent:[yourpath/]jacocoagent.jar=[option1]=[value1],[option2]=[value2]
    option:支持的参数,如includes
    value:赋予参数的值
    b) includes:应包含在执行分析中的类名列表。列表条目由冒号(:)隔开,可以使用通配符(和?)。(所有课程)
    c) output:用于写入覆盖数据的输出方法,有4个选项file,tcpserver,tcpclient和none,默认是file。file:在VM终止时,执行数据将写入destfile属性中指定的文件;tcpserver:代理侦听由address和port属性指定的TCP端口上的传入连接,执行数据写入此TCP连接;tcpclient:启动时,代理连接到address和port属性指定的TCP端口,执行数据被写入TCP连接;none:不要任何输出。
    d) address:IP地址,是服务器的IP地址,如果是在此服务器上执行dump,report操作就写127.0.0.1,默认也是127.0.0.1
    e) port:端口,默认是6300。如果在本机使用端口不被占用(>1024)就可以;如果是别的机器访问需要是开放的端口。
    f) 在Catalina.sh文件配置JAVA_OPTS时,需要先关掉Tomcat,配置成功后重启Tomcat

  2. 没有使用Tomcat的机器,可以在通过命令启动程序时,将-javaagent作为一个参数使用。


    IDEA截图.png

a) 用到的参数同上

6. 项目就运行起来了,jacoco代理以tcpserver输出模式运行,需要执行dump命令来生成jacoco.exec文件(.exec文件的名字可以自己命名)
java -jar D:/CodeCoverageTest-Data/JaCoCo/lib/jacococli.jar dump --destfile D:/CodeCoverageTest-Data/JaCoCo/test0.exec --address 127.0.0.1 --port 8282

a) java –jar [yourpath/]jacococli.jar dump [--option1] values1 [--option2] values2
option是参数
value是参数值
a) --destfile:执行数据的输出文件路径
b) --address:需和上面-javaagent的一样
c) --port:需和上面-javaagent的一样

7. 需要看报告的时候,执行
java -jar D:/CodeCoverageTest-Data/JaCoCo/lib/jacococli.jar report D:/CodeCoverageTest-Data/JaCoCo/test111.exec --classfiles D:/CodeCoverageTest-Data/JaCoCo --html D:/CodeCoverageTest-Data/JaCoCo --name test2 --address 127.0.0.1 --port 8282

a) java –jar [yourpath/]jacococli.jar report [yourpath/]jacoco.exec [--option1] values1 [--option2] values2
jacoco.exec是dump时的位置
option是参数
value是参数值
b) --classfiles:是编译过后的.class文件的地址,目录地址写到classes文件夹下就可自动识别字节码文件
c) --sourcefiles:源文件的地址,目录地址写到java文件夹下就可自动识别源文件
d) --html:html报告的输出路径
e) --name:报告的名字

8. 按照html的路径可找到报告,名字为index.html
随机结果截图.png

三、注意事项:
1、 每次新的版本需要测试时,需要清理掉上次的记录,以免对本次测试产生影响,删掉对应的.exec文件,和report文件
2、 在版本测试周期中,可能遇到多次部署环境的情况,为了保证覆盖率的准确性,需要合并每一次的覆盖率报告
a) java –jar [yourpath/]jacococli.jar merge [yourpath/]jacoco1.exec [yourpath/]jacoco2.exec [option] value
需要合并的.exec文件的路径都写好
--destfile:用于将合并行数据写入的文件
b) 再通过report命令打出实体报告

//   在启动jar 的时候使用-javaAgent作为一个选项来启动程序。通过配置VM启动项,编辑Catalina.sh来打开该文件
JAVA_OPTS=“-Javaagent:/[jacocoagentPath]=includes=[报名/类名/通配符*和?],output=tcpserver,port=[端口号],address=[IPPath] -Xverify:none”

//    项目启动起来之后,jacoco代理以tcpServer输出模式运行,需要执行dump命令来生成.exec文件
java -jar D:/CodeCoverageTest-Data/JaCoCo/lib/jacococli.jar dump --destfile D:/CodeCoverageTest-Data/JaCoCo/test0.exec --address 127.0.0.1 --port 8282

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

推荐阅读更多精彩内容