近期因工作需要,需要统计一个javaweb项目的代码覆盖率,虽然整体来说jacoco用起来很简单,但是到具体的项目时,还是各有不同,因此把一次实践的经验总结下来,希望能对学习jacoco的同学有所帮助。

首先需要统计的是一个javaweb项目,通过maven打包成war包,然后里面有一些子项目,打包程jar包,需要要统计这jar包的覆盖率。

至于工具,网上大多介绍的是jacoco+ant,开始也尝试了一下,但是有个问题是,ant通过execl文件生成report的时候,需要制定源码路径和class路径。

由于上面提到统计jar包的覆盖率,所以class文件解压出来可以得到,源文件从svn拉出来也可以拿到,但是有个问题时由于是maven的子项目,路径都是独立的,build.xml写起来比较麻烦,看了网上有人说需要在structure下面建立多个group,对应的源文件和类文件也要新增进去,而且每次更新代码,我们都需要重新上传,太麻烦了。所以呢,我最后采用的是jacoco+eclemma,感兴趣的同学请往下看。

额外提一句,本文的目标是:通过jacoco统计出jar包中的代码覆盖率,并生成html报告。

【第一步】

将jacoco-0.7.9.zip拷贝到目标tomcat所在的机器上,并解压,比如解压后放在/home/ jacoco-0.7.9下面,目录如下:

java map 覆盖更新 java代码覆盖率_tomcat

【第二步】

停掉tomcat,在 {tomcat所在目录}/bin/catalina.sh 中添加jacoco插件,修改JAVA_OPTS的值,如下:

java map 覆盖更新 java代码覆盖率_java map 覆盖更新_02

其实主要是添加

java map 覆盖更新 java代码覆盖率_java map 覆盖更新_03

这一段参数,将里面的jacocoagent.jar的路径换成上面解压的路径,include是为了筛选要收集覆盖率的类,后面的output那一段是覆盖率文件的输出,改成所在服务器的ip,端口写一个没用到的都行,但要记住,后面会用到。

【第三步】

完成第一二步骤之后,就可以将tomcat启动了,启动之后,执行一下ps -ef |grep jacocoagent 命令,结果如下:

java map 覆盖更新 java代码覆盖率_java map 覆盖更新_04

到此,配置已经ok了。接下来就是执行用例。

【第四步】

执行完一些用例之后,现在需要通过eclipse来收集覆盖率信息了,首先将eclipse安装eclemma插件,安装方法这里就不详细说了,可以问度娘。笔者装的是eclemma-2.3.3,安装好之后,打开eclipse,按下面的路径打开。

java map 覆盖更新 java代码覆盖率_tomcat_05

然后在里面输入coverage ,如果看到下面这个,表示安装已成功。

java map 覆盖更新 java代码覆盖率_java map 覆盖更新_06

【第五步】

我们说过不用ant的原因是由于源码和class文件的路径写build.xml不好写,那么我们用eclipse怎么做呢?

首先,从svn将源码down下来,是maven项目,然后通过eclipse导入,这样我们就有源码了。

然而还需要class文件,这个也很简单,最方便的是直接从pkg取到集成好的jar,或者也可以直接通过上面的maven项目生成jar,都可以。

问题来了,svn上down下来的工程只有源码,没有jar包,怎么办呢?

接下来本文的做法就是,新建一个java工程,然后将上面得到jar包都导入,接着,将源码关联到jar包上。到此,需要的源码有了,class也妥了,接下来就该eclemma上场了。

【第六步】

首先打开上面的java- coverage的view,如下:

java map 覆盖更新 java代码覆盖率_eclipse_07

然后在这个view里面右键,导入,选择coverage session,接着选择agent address,回到output配置,输入tomcat所在的ip,还有之前敲的端口,然后next。

java map 覆盖更新 java代码覆盖率_jar包_08

接着,勾选include binary library,然后选择刚才建的工程,以及里面的jar包,如下:

java map 覆盖更新 java代码覆盖率_jar包_09

然后finish,接着等一等,等导入完成,界面就出现覆盖率信息了,可以多次导入,支持合并覆盖率,以及查看详细的代码覆盖率,还可以右键导出html格式的报告。

java map 覆盖更新 java代码覆盖率_jar包_10

到此,已经完成了开篇提的目标了。