1. 将Springboot项目打包
将需要做代码覆盖率测试的模块打成jar包
本例的打包位置D:\Java\IDEA_WorkSpace\gitee\myweb\target\web.jar
2. 访问jacoco官网下载并解压最新包
本例以jacoco-0.8.7版本为例,存放路径D:\jacoco-0.8.7\
3. 下载并配置ant
下载完解压缩即可使用。
- 配置环境变量
加上D:\apache-ant-1.10.10\bin
,具体路径根据你自己的ant文件夹位置来定。
4. 进入ant/bin目录,新建build.xml文件
本文以apache-ant-1.10.10为例,位置放在D:\apache-ant-1.10.10\
,在win10系统做的测试。
build.xml
<?xml version="1.0" encoding="UTF-8"?>
<project name="test" xmlns:jacoco="antlib:org.jacoco.ant" >
<!--Jacoco的安装路径-->
<property name="jacocoantPath" value="D:\jacoco-0.8.7\lib\jacocoant.jar"/>
<!--最终生成.exec文件的路径,Jacoco就是根据这个文件生成最终的报告的-->
<property name="jacocoexecPath" value="D:\jacoco-0.8.7\target\jacoco.exec"/>
<!--生成覆盖率报告的路径-->
<property name="reportfolderPath" value="D:\jacoco-0.8.7\report"/>
<!--远程tomcat服务的ip地址-->
<property name="server_ip" value="127.0.0.1"/>
<!--前面配置的远程tomcat服务打开的端口,要跟上面配置的一样-->
<property name="server_port" value="6300"/>
<!--源代码路径可以包含多个源代码-->
<property name="webSrcpath" value="D:\Java\IDEA_WorkSpace\gitee\myweb\src\main\java" />
<!--.class文件路径可以包含多个-->
<property name="webClasspath" value="D:\Java\IDEA_WorkSpace\gitee\myweb\target\classes"/>
<!--让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="true" destfile="${jacocoexecPath}" port="${server_port}" append="false"/>
</target>
<!--jacoco任务:
根据前面配置的源代码路径和.class文件路径,
根据dump后,生成的.exec文件,生成最终的html覆盖率报告。-->
<target name="report">
<delete dir="${reportfolderPath}" />
<mkdir dir="${reportfolderPath}" />
<jacoco:report>
<executiondata>
<file file="${jacocoexecPath}" />
</executiondata>
<structure name="JaCoCo Report">
<group name="Launch related">
<!--此处配置classes文件地址 -->
<classfiles>
<fileset dir="${webClasspath}" />
</classfiles>
<!--此处配置源码地址-->
<sourcefiles encoding="utf-8">
<fileset dir="${webSrcpath}" />
</sourcefiles>
</group>
</structure>
<html destdir="${reportfolderPath}" encoding="utf-8" />
</jacoco:report>
</target>
</project>
配置解释
注意:其中几个重要配置
jacocoexecPath:Jacoco的安装路径,这个很好理解就是Jacoco的包解压缩的位置,注意文档写的是window路径如果linux则要相应修改;
jacocoexecPath:最终生成.exec文件的路径,之后Jacoco就是根据这个文件生成最终的报告;
reportfolderPath:生成报告的路径,html格式报告;
server_ip:远程tomcat服务的ip地址或spring boot启动的服务器地址;
server_port:服务器端口,跟启动tomcat或jar时的端口号相同即可;
webSrcpath:源代码路径,这里就是demo的java文件地址;
webClasspath:class文件路径,这里就是demo编译后的classes目录。
5. 启动Springboot jar包
java -javaagent:D:\jacoco-0.8.7\lib\jacocoagent.jar=includes=*,output=tcpserver,port=6300,address=127.0.0.1 -jar D:\Java\IDEA_WorkSpace\gitee\myweb\target\web.jar
6. 执行相应的测试用例
通过POSTMAN或页面进行第五步启动的项目的测试。
7. dump信息
打开cmd控制台,执行
cd D:\apache-ant-1.10.10\bin\
ant dump
8. 生成报告
再执行
cd D:\apache-ant-1.10.10\bin
ant report
9. 查看报告内容
进入目录 D:\jacoco-0.8.7\report
打开index.html,如下图:Missed是未覆盖的数量
注:如果出现乱码可能因为build.xml配置文件中字符集设置有问题,检查 sourcefiles encoding 和 destdir="${reportfolderPath}" encoding,建议全部为utf-8
点击进入可以查看详情
一路点击,进入代码,可以看到哪些代码使用了那些没有使用