[转帖]spring boot项目集成jacoco

时间：2023-03-08 22:59:04
[转帖]spring boot项目集成jacoco

小试牛刀：spring boot项目集成jacoco

2019-03-28 20:14:36 zyq23333 阅读数 509
版权声明：本文为博主原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接和本声明。

jacoco不必多说，代码覆盖率工具。相比于其他java web项目，spring boot项目本身集成了tomcat，所以集成方法稍微区别于其他项目。
直接进入正题，在本地建一个spring boot项目，并创建一个名为HelloController的class，写两个hello world（网上很多现成的demo，可以直接拿来用）
[转帖]spring boot项目集成jacoco[转帖]spring boot项目集成jacoco
成功启动main方法后浏览器访问127.0.0.1:8080/hello即可看到刚刚写的hello world。demo建好后使用maven install将项目打成jar包，jar包会在项目的target目录下。
此时就可以开始jacoco的集成了，需下载jacoco和ant到本地
jacoco官网：http://www.eclemma.org/jacoco/
ant官网：https://ant.apache.org/bindownload.cgi（ant需配合环境变量）
下载后在本地解压即可。
在ant所在目录的bin路径下新建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.3\lib\jacocoant.jar"/>
  <!--最终生成.exec文件的路径，Jacoco就是根据这个文件生成最终的报告的-->
  <property name="jacocoexecPath" value="D:\jacoco-0.8.3\target\jacoco.exec"/>
    <!--生成覆盖率报告的路径-->
  <property name="reportfolderPath" value="D:\jacoco-0.8.3\report"/>
  <!--远程tomcat服务的ip地址-->
  <property name="server_ip" value="127.0.0.1"/>
  <!--前面配置的远程tomcat服务打开的端口，要跟上面配置的一样-->
  <property name="server_port" value="6300"/>
  <!--源代码路径可以包含多个源代码-->
  <property name="webSrcpath" value="D:\springdemo\src\main\java" />   

  <!--.class文件路径可以包含多个-->
  <property name="webClasspath" value="D:\springdemo\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="gbk">
                      <fileset dir="${webSrcpath}" />
                  </sourcefiles>
              </group>

          </structure>

          <html destdir="${reportfolderPath}" encoding="utf-8" />
      </jacoco:report>
  </target>
</project>

配置完成后即可启动服务：
java -javaagent:D:\jacoco-0.8.3\lib\jacocoagent.jar=in
cludes=*,output=tcpserver,port=6300,address=127.0.0.1 -jar D:\s
pringdemo\target\demo-0.0.1-SNAPSHOT.jar
参数说明可参考官网介绍：https://www.eclemma.org/jacoco/trunk/doc/agent.html
其中output=tcpserver表示使用tcpserver代理侦听由address和port属性指定的TCP端口，并将执行的数据写入此TCP连接，从而实现不停止项目运行实时生成代码覆盖率报告。，includes配置包含在执行分析中的类名列表，*表示全部。

此时就可以执行相关操作，比如访问http://127.0.0.1:8080/hello。
然后再ant所在目录的bin路径下执行ant dump。提示成功后即表示报告数据成功生成，再执行ant report，提示成功后则在指定目录生成了报告（jacoco目录下的report路径），打开index.html即可看到报告内容。

踩坑记录：build.xml中的端口号是启动命令中的监听端口号，非项目端口号，如果写错则会报 Unable to dump coverage data。
查看源码可知是生成文件的问题：

try {
        // 1. Open socket connection
        socket = new Socket(address, port);
        logger.info("Connecting to {}", socket.getRemoteSocketAddress());
        RemoteControlWriter remoteWriter = new RemoteControlWriter(socket.getOutputStream());
        RemoteControlReader remoteReader = new RemoteControlReader(socket.getInputStream()); 

        output = new ByteArrayOutputStream();
        ExecutionDataWriter outputWriter = new ExecutionDataWriter(output);
        remoteReader.setSessionInfoVisitor(outputWriter);
        remoteReader.setExecutionDataVisitor(outputWriter); 

        // 2. Request dump
        remoteWriter.visitDumpCommand(true, resetAfterFetch);
        remoteReader.read(); 

        // 3. verify valid JaCoCo execution data
        byte[] outputBytes = output.toByteArray();
        if (outputBytes.length <= 5) {
            throw new JaCoCoToGoException("No JaCoCo execution data received.");
        } 

        // 4. Return data
        return outputBytes;
    } catch (final IOException e) {
        throw new JaCoCoToGoException("Unable to dump coverage data", e);

源码地址：https://www.programcreek.com/java-api-examples/index.php?source_dir=jacocotogo-master/jacocotogo-maven-plugin/src/main/java/org/helmetsrequired/jacocotogo/JaCoCoToGo.java

相关文章