jacoco+springboot代码覆盖率实践

1,128 阅读2分钟

这是我参与8月更文挑战的第7天,活动详情查看:8月更文挑战

前言

虽说检测代码的质量问题有专门的测试同学负责,但是作为后端开发也要做适当的单测,由此今天学习了一套测试代码覆盖率的开源工具-JaCoCo。它的覆盖粒度可以到行、类、方法、指令、分支等等,速度较快,可使用在jenkins集成,适合二次开发。下面简单介绍一下它的实际应用。

JaCoCo官方网址:www.eclemma.org/jacoco/

一、准备

我是直接在本地项目上使用的,当然大家也可以在远程服务器上实践。

1、准备一个springboot+maven+java的本地项目。

2、ant

直接下载最新版的apache-ant,解压后,放在常用文件路径下,配置环境变量。

下载地址:ant.apache.org/bindownload…

配置环境:

export ANT_HOME=/Users/xxx/apache-ant-1.10.8
export PATH=${PATH}:${ANT_HOME}/bin

3、jacoco

下载地址:www.eclemma.org/jacoco/

也是下载后,解压在常用路径下即可。

二、配置项目的启动项

这里有很多种方式,我是直接在idea的启动设置中jvm option添加下面这行命令,直接在idea中启动项目。port随便取,不要冲突就可以。如果是在本地启动项目,address就写127.0.0.1,远程的就用ip。

-javaagent:/Users/xxxxxx/jacoco-0.8.7/lib/jacocoagent.jar=includes=com.grgbanking.*,output=tcpserver,address=127.0.0.1,port=6300,append=true

或者

用下面的命令本地启动项目。

java -javaagent:/Users/xxxxxx/jacoco-0.8.7/lib/jacocoagent.jar=includes=xxx.*,output=tcpserver,port=6300,address=127.0.0.1  -jar /Users/xxxxxx/java-project/xxx.jar  -Xverify:none 
三、配置build.xml文件

重点来了,上面的启动项是为了在项目启动时用加载jacoco的服务,通过ant来监控代码覆盖并生成报告。

新建一个build.xml文件,放在ant的bin目录下,很详细的注解都在里面了。

文件内容如下: 在常用文件路径下新建一个目录为 covercode。

<?xml version="1.0" ?>
<project name="wftestReport" xmlns:jacoco="antlib:org.jacoco.ant" default="jacoco">
    <!--Jacoco的安装路径-->
    <property name="jacocoantPath" value="/Users/xxxxxx/jacoco-0.8.7/lib/jacocoant.jar"/>
​
    <!--最终生成.exec文件的路径,Jacoco就是根据这个文件生成最终的报告的-->
    <property name="jacocoexecPath" value="/Users/xxxxxx/covercode/mergedwftest.exec"/>
​
    <!--生成覆盖率报告的路径,直接放在tomct下面,外界直接访问-->
    <property name="reportfolderPath" value="/Users/xxxxxx/covercode/report"/>
​
    <!--远程tomcat服务的ip地址-->
    <property name="server_ip" value="127.0.0.1"/>
​
    <!--前面配置的远程tomcat服务打开的端口,要跟上面配置的一样-->
    <!--这个端口有别于tomcat的端口,相当于是嵌在tomcat里的监视器-->
    <property name="server_port" value="6300"/>
​
​
    <!--源代码路径-->
    <!--可以配置多个源代码-->
    <property name="express_src" value="/Users/xxxxxx/src/main/java"/>
​
​
    <!--.class文件路径-->

    <property name="express_class" value="/Users/xxxxxx/target/classes"/>
​
    <!--合并报告路径-->
    <property name="mergePath" value="/Users/xxxxxx/covercode" />
​
​
​
    <!--让ant知道去哪儿找Jacoco-->
    <taskdef uri="antlib:org.jacoco.ant" resource="org/jacoco/ant/antlib.xml">
        <classpath path="${jacocoantPath}" />
    </taskdef>
​
    <!--dump任务:
        根据前面配置的ip地址,和端口号,
        访问目标tomcat服务,并生成.exec文件。-->
    <target name="dump">
        <jacoco:dump address="${server_ip}" reset="false" destfile="${jacocoexecPath}" port="${server_port}" append="true"/>
    </target>
    <target name="merge">
        <!--将路径下的exec文件全部合并,并存放到destfile中-->
        <jacoco:merge destfile="/Users/xxxxxx/covercode/merged.exec">
            <fileset dir="${mergePath}" includes="*.exec"/>
        </jacoco:merge>
    </target>
​
​
​
  <!--jacoco任务:
      根据前面配置的源代码路径和.class文件路径,
      根据dump后,生成的.exec文件,生成最终的html覆盖率报告。-->
  <target name="report">
    <!--暂时不删除,一旦删除,其他两个的报告也没了--> 
      <delete dir="${reportfolderPath}" />
      <mkdir dir="${reportfolderPath}" /> 
        <jacoco:report>
            <executiondata>
                <file file="${jacocoexecPath}" />
            </executiondata>             
            <structure name="ucf report">          
                <group name="express related">           
                    <classfiles>
                        <fileset dir="${express_class}" />
                    </classfiles>
                    <sourcefiles encoding="utf-8">
                        <fileset dir="${express_src}" />
                    </sourcefiles>
                </group>              
            </structure>
          <html destdir="${reportfolderPath}" encoding="utf-8" />    
          <csv destfile="/Users/xxxxxx/covercode/report.csv" />         
        </jacoco:report>
  </target>
</project>
四、启动服务,执行ant命令

启动springboot项目,在cmd中依次输入命令

ant dump
ant merge
ant report

这就得到了项目的代码覆盖率报告了。