小试牛刀：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，可以直接拿来用）

成功启动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

[转帖]spring boot项目集成jacoco的更多相关文章

  1. Spring Boot 项目集成 Alibaba Druid

    Druid 是一个非常好用的数据库连接池,但是他的好并不止体现在作为一个连接池加快数据访问性能上和连接管理上,他带有一个强大的监控工具:Druid Monitor.不仅可以监控数据源和慢查询,还可以监 ...

  2. 【Spring Boot&&Spring Cloud系列】Spring Boot项目集成Swagger UI

    前言 Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端和文件系统作为服务器以同样的速度来更新.文件的方法,参数和模型紧密集 ...

  3. Spring boot项目集成Neo4j

    第一步,创建Springboot工程 使用Eclipse 创建Maven项目,并修改pom.xml文件为: <?xml version="1.0" encoding=&quo ...

  4. Spring boot项目集成Sharding Jdbc

    环境 jdk:1.8 framework: spring boot, sharding jdbc database: MySQL 搭建步骤 在pom 中加入sharding 依赖 <depend ...

  5. Spring Boot 项目集成Redis

    目录 集成方式 使用Jedis 使用spring-data-redis Redis的安装 绑定配置 获取Redis客户端 Redis工具的编写 使用 集成方式 使用Jedis Jedis是Redis官 ...

  6. spring boot项目集成zuul网关

    1 zuul简介 Zuul 的官方介绍是 “Zuul is the front door for all requests from devices and web sites to the back ...

  7. Spring Boot项目集成flyway

    一.为什么要使用flyway Flyway的定位:数据库的版本控制.   用一种简单.干净的方案,帮助用户完成数据库迁移的工作.使用Flyway,用户可以从任意一个数据库版本迁移到最新版本,简单而且有 ...

  8. Spring Boot 项目实战（五）集成 Dubbo

    一.前言 上篇介绍了 Redis 的集成过程,可用于解决热点数据访问的性能问题.随着业务复杂度的提高,单体应用越来越庞大,就好比一个类的代码行数越来越多,分而治之,切成多个类应该是更好的解决方法,所以 ...

  9. Spring Boot 项目实战（四）集成 Redis

    一.前言 上篇介绍了接口文档工具 Swagger 及项目监控工具 JavaMelody 的集成过程,使项目更加健壮.在 JAVA Web 项目某些场景中,我们需要用缓存解决如热点数据访问的性能问题,业 ...

随机推荐

  1. 【夯实基础】-浅谈"单点登录"的几种实现方式

    单点登录 一.Session跨域 所谓Session跨域就是摒弃了系统提供的Session,而使用自定义的类似Session的机制来保存客户端数据的一种解决方案. 如:通过设置cookie的domai ...

  2. eclipse对Java项目进行单元测试

    一.右键项目名->buildpath->configure buildpath->add library->junit->选择版本(以4为例)->apply-> ...

  3. 关于html的相关讲解

    浏览器chrome Chrome它内部有一个解析器,这个解析器就是解析我们的代码,各个浏览器的内核不一样,所以存在浏览器的兼容.这个内核是一个引擎. 谷歌的内核是webkit 引擎是v8. 客户端的请 ...

  4. Python3报错：ModuleNotFoundError: No module named '_bz2'

    系统信息 系统:CentOS Linux release 7.6.1810 (Core) python版本:python3.7   报错信息 from _bz2 import BZ2Compresso ...

  5. Centos7下安装redis并能使得外网访问

    一.安装脚本 #!/bin/bash #FileName: install_redis_centos7.sh #Date: #Author: LiLe #Contact: @qq.com #Versi ...

  6. 【爬虫】网页抓包工具--Fiddler--Request和Response

    [爬虫]网页抓包工具--Fiddler Fiddler基础知识 Fiddler是强大的抓包工具,它的原理是以web代理服务器的形式进行工作的,使用的代理地址是:127.0.0.1,端口默认为8888, ...

  7. js 字符串 有没有 像C# @ 那种 换行也可以显示的方法 \

  8. SpringCloud学习第三章-springcloud 父项目创建

    父项目 pom.xml <?xml version="1.0" encoding="UTF-8"?> <project xmlns=" ...

  9. php访问者模式(visitor design)

    终于搞定,累成一滩,今晚不想说话. <?php /* The visitor design pattern is a way of separating an algorithm from an ...

  10. @TableField

    @TableField 描述:字段注解(非主键) 属性 类型 必须指定 默认值 描述 value String 否 "" 字段名 el String 否 "" ...