jacoco+ant 构建java覆盖率

所需工具：

Jacoco Ant

2020.5.26： 踩坑报错Unable to dump coverage data，经过查证修改后发现为tomcat需用tomcat自带startup.bat启动，用eclipse启动仿佛插件无效。

Tomcat修改

 set JAVA_OPTS="-javaagent:[yourPath/]jacocoagent.jar=includes=com.companyName.*,output=tcpserver,port=8044,address=100.44.44.144,append=true -Xverify:none"
 修改文件说明：
 1.windows平修改catalina.bat，linux平台修改catalina.sh（去除set）
 2.启动Tomcat，Windows下使用startup.bat，Linux下使用startup.sh

参数说明：
   1. yourPath 是放 jacocoagent.jar 文件的目录路径；那么 `jacocoagent.jar` 这个 `jar` 包的路径就是在准备工作里下载下来的 `zip` 包，解压之后的 `lib` 目录下，如：'/jacoco-0.7.9/lib/jacocoagent.jar'
   2. includes 是指要收集哪些类（注意不要光写包名，最后要写.*)，不写的话默认是*，会收集应用服务上所有的类，包括服务器和其他中间件的类，一般要过滤（当然如果你愿意写*也完全没有问题，如：`includes=com.*` or `includes=*`）；
   3. output 有 4 个值，分别是 file、tcpserver、tcpclient、mbean，默认是 file。使用 file 的方式只有在停掉应用服务的时候才能产生覆盖率文件，而使用 tcpserver 的方式可以在不停止应用服务的情况下下载覆盖率文件，后面会介绍如何使用 dump 方法来得到覆盖率文件。
   4. address 是 IP 地址，IP 就是 Tomcat 服务器的机器的 IP，至于是写 `服务器本机的 IP` 还是写 `127.0.0.1` 要看情况
       1) 如果是在 Tomcat 服务器上执行 `ant dump` 的话，就直接写 `address=127.0.0.1`
       2) 如果执行 `ant dump` 不是在 Tomcat 服务器上执行的，就得写服务器本机的IP（切记）
   5. port 是端口（端口比较随便，找个能用的端口就行，直接我为什么将端口写成 `8044`，我的想法是 `BUG 死死` 与 `8044` 挺配的，所以就用它作为端口号了）
（`address` 和 `port` 是使用 tcpserver 方式需要的 2 个参数，也是执行 ant dump 方法必须要用到的。）
   6. append 表示覆盖率数据的追加方式，默认为 true。客户端在执行 dump 操作时，如果该 exec 覆盖率文件已存在，那么该轮的覆盖率数据会直接在文本末尾进行追加，因此会导致覆盖率数据文件越来越大。如果改为 false，则客户端执行 dump 操作时会直接清空原覆盖率文件的内容，保证该覆盖率文件只有该轮的覆盖率数据。
   7. `-Xverify:none`：这个参数是防止启动主程序异常才加的（非强制，可以不加）

jacoco启动验证

windows查询方法：
1.Windows下在cmd窗口使用WMIC命令，回车，回显：wmic:root\cli>
2.在>后面输入：process where name="java.exe"  命令
3.查看打印信息

linux查询方法：
1.ps -ef | grep tomcat
2.ps -ef | grep jacocoagent.jar

--------------查询有jacoco进程则配置ant-------------------

Ant覆盖率 build.xml配置

<?xml version="1.0" encoding="UTF-8"?>
<project name="Jacoco" xmlns:jacoco="antlib:org.jacoco.ant" default="jacoco">   
    <property name="jacocoantPath" value="[yourPath/]jacocoant.jar"/>
    <property name="integrationJacocoexecPath" value="./jacoco-integration.exec"/>
    
    <taskdef uri="antlib:org.jacoco.ant" resource="org/jacoco/ant/antlib.xml">
      <classpath path="${jacocoantPath}" />
    </taskdef>
    
    <target name="dump">
        <jacoco:dump address="100.44.44.144" port="8044" reset="true" destfile="${integrationJacocoexecPath}" append="false"/>
    </target>
</project>

参数说明：
`.exec`：二进制文件，Jacoco 就是根据这个文件生成最终的报告
`destfile`：是指生成的覆盖率文件路径

Tip:
build.xml 只需修改三个点，就可以直接拿去用
第一个修改点：补全 `jacocoant.jar` 路径。（那么 `jacocoant.jar` 在哪？对于这个问题，或许会有疑问，当然，如果细心的小伙伴就会很轻易的发现 `jacocoant.jar` 的位置，其实也就在准备工作中所下载的 `zip` 包里面，与 `jacocoagent.jar` 在同级目录 `lib` 文件夹下）
第二个修改点：修改 IP 地址（IP 须与 `catalina.sh` 中添加的一致）
第三个修改点：修改端口号（与IP一样，端口号须与 `catalina.sh` 中添加的一致）

Frequently Asked Questions：
虽然得到了集成测试的覆盖率文件，但是需要应用服务器上的类文件才能产出相应的覆盖率报告，如果类文件是其他 JVM 编译的，产出的报告覆盖率是 0%。
有 2 种方法可以得到覆盖率文件所需的 class 文件：
1. 将应用服务部署的包（ear 或 war 或 jar）包下载下来之后解压，即可得到对应的 class 文件；
2. 在前面做单元测试之后，可以将 class 文件打成一个 zip 包，然后上传到服务器，最后在需要的时候去服务器上取。

修改好了，那么我们来测试一下，终端进入 build.xml 所在的目录，执行：ant dump 或者 ant dump -buildfile [yourPath/]build.xml

参考文档：https://www.cnblogs.com/wozijisun/p/9667849.html https://www.jianshu.com/p/16a8ce689d60