Jacoco 代码覆盖率,监控WEB项目

时间:2024-06-27 13:35:50

转载:https://blog.****.net/u010469432/article/details/73283824

jacococ代码覆盖率,以客户端形式直接监控远程代码

使用理解

jacoco 提供的javaagent 监控是在启动服务或运行代码前,启动时修改 JVM 运行时配置信息,启动agent进行监控收集数据。
  • jacoco作为客户端进行使用:本文下方展开讲解使用,以Windows平台为例,linux平台的步骤思想是一致的。
  • jacoco作为项目插件进行使用:可参考官方文档http://www.jacoco.org/jacoco/trunk/doc/,提供了Maven plug-in 以及其他方式使用的示例。
  • jacoco与jenkins结合使用(后续补充)

WINDOWS

外部服务器(tomcat 等)
  1. ant 在本机下载安装ant ,不再赘述;
  2. jacoco jar 下载地址:http://www.eclemma.org/jacoco/ 
    下载jacoco.jar 后,解压到任意位置;
<?xml version="1.0" ?>
<project name="test" xmlns:jacoco="antlib:org.jacoco.ant" >
<!--Jacoco的安装路径-->
<property name="jacocoantPath" value="D:\Downloads\jacoco-0.7.9\lib/jacocoant.jar"/>
<!--最终生成.exec文件的路径,Jacoco就是根据这个文件生成最终的报告的-->
<property name="jacocoexecPath" value="D:\Downloads\jacoco-0.7.9/target/jacoco.exec"/>
<!--生成覆盖率报告的路径-->
<property name="reportfolderPath" value="D:\Downloads\jacoco-0.7.9/report/"/>
<!--远程tomcat服务的ip地址-->
<property name="server_ip" value="30.29.158.253"/>
<!--前面配置的远程tomcat服务打开的端口,要跟上面配置的一样-->
<property name="server_port" value="8080"/>
<!--源代码路径可以包含多个源代码
<property name="webSrcpath" value="/home/work/zj/adp-feed-access-web/src/main/java/" /> --> <!--.class文件路径可以包含多个-->
<property name="webClasspath" value="D:\develop tools\apache-tomcat-8.0.43\webapps\rulesPlatform\WEB-INF\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="false" destfile="${jacocoexecPath}" port="${server_port}" append="true"/>
</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="gbk">
<fileset dir="${webSrcpath}" />
</sourcefiles> -->
</group> </structure> <html destdir="${reportfolderPath}" encoding="utf-8" />
</jacoco:report>
</target>
</project>

3 . 修改tomcat 配置文件catalina.bat增加jacocagent配置 ,进行监控:

<!--配置 outfile =file 只有停止tomcat才能将监控数据输出到jacoco.exec中,
startup.bat 启动tomcat,会生成jacoco.exec文件,存放的是监控数据,Jacoco就是根据这个文件生成最终的报告;
进行测试,测试完成后,shutdowm.bat 停止tomcat;
-->
set "JAVA_OPTS=%JAVA_OPTS% -javaagent:D:/Downloads/jacoco-0.7.9/lib/jacocoagent.jar=includes=*,output=file,append=true,destfile=D:/Downloads/jacoco-0.7.9/target/jacoco.exec" <!--配置 output=tcpserver 此时监控数据可以使用ant dump进行实时导出不需要停止服务器
启动服务后,进行测试,测试完成,进入build.xml 文件所在目录,ant dump 导出监控数据文件jacoco.exec
-->
set "JAVA_OPTS=%JAVA_OPTS% -javaagent:D:/Downloads/jacoco-0.7.9/lib/jacocoagent.jar=includes=*,output=tcpserver,port=8081,address=30.29.158.253"

4 . 命令行执行,进入build.xml所在的目录,执行ant report; 
5 . 在指定文件生成report。 
Jacoco 代码覆盖率,监控WEB项目

java project 内置server启动(例如:NanoHttped)
  1. ant 、jacoco、build.xml配置信息与上述一致
  2. 启动方式为: 
    cmd–>进入命令行,以命令行方式启动 jar
 D:\>java -javaagent:D:/Downloads/jacoco-0.7.9/lib/jacocoagent.jar=includes=*,out
put=tcpserver,port=8081,address=30.29.158.253 -Xmx5G -cp productcheck-0.0.1.jar
com.amap.cmstest.run.ProductCheck
  • 1
  • 2
  • 3
  1. 启动服务后进行测试,测试完成后,使用 ant dump导出监控数据,ant report 生成可视化报告。