jacoco使用示例与常用配置说明

最新推荐文章于 2024-10-11 07:42:05 发布
最新推荐文章于 2024-10-11 07:42:05 发布
阅读量4.5k 收藏 23
点赞数 18
文章标签： jacoco 单元测试报告覆盖率 jacoco配置
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/trayvontang/article/details/136970329
版权

基本概念

有时候，对于一些重要的项目或者重点类，我们希望重点测试，但是我们怎么评估测试质量呢？

这个时候，或许就需要jacoco了。

接下来，我们就来了解一下jacoco的基本概念与使用。

以及在某些条件不允许的情况下，我们如何跳过某些类，再结合mvn参数，让我们的单元测试报告看起来不那么乱。

jacoco会分析：指令(C0)、分支(C1)、行、方法、类型和循环复杂度的覆盖率

  1. 指令(Instructions,C0覆盖率,Java字节代码指令)
  2. 分支(Branches,C1覆盖率,分支覆盖率)
  3. 循环复杂度(Cyclomatic Complexity,cxty)
  4. 行(line)
  5. 方法(method)
  6. 类(class)

jacoco结果显示：

分支：

  • 无覆盖范围：该行没有分支执行(红色菱形)
  • 部分覆盖：仅执行了该行中的一部分分支(黄色菱形)
  • 全面覆盖：该行中的所有分支均已执行(绿色菱形)

行：

  • 无覆盖：该行中没有指令被执行(红色背景)
  • 部分覆盖：仅执行了该行中的一部分指令(黄色背景)
  • 全面覆盖：该行中的所有指令均已执行(绿色背景)

如果上面内容比较抽象，可以看看下面具体实例。

基本使用

maven配置

对于maven项目可以参考下面的配置

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>vip.meet</groupId>
    <artifactId>jacoco-test</artifactId>
    <version>1.0.0</version>
    <name>jacoco-test</name>
    <description>单元测试报告</description>
    <properties>
        <java.version>17</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.junit.jupiter</groupId>
            <artifactId>junit-jupiter</artifactId>
            <version>5.8.2</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.junit.platform</groupId>
            <artifactId>junit-platform-launcher</artifactId>
            <version>1.7.2</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>${java.version}</source>
                    <target>${java.version}</target>
                    <encoding>UTF8</encoding>
                </configuration>
                <version>3.8.1</version>
            </plugin>
           <plugin>
                <groupId>org.jacoco</groupId>
                <artifactId>jacoco-maven-plugin</artifactId>
                <version>0.8.11</version>
                <executions>
                    <execution>
                        <id>prepare-agent</id>
                        <goals>
                            <goal>prepare-agent</goal>
                        </goals>
                        <configuration>
                            <includes>
                                <!-- **/SayHi** -->
                            </includes>
                            <excludes>
                            </excludes>
                        </configuration>
                    </execution>
                    <execution>
                        <id>generate-code-coverage-report</id>
                        <phase>test</phase>
                        <goals>
                            <goal>report</goal>
                        </goals>
                        <configuration>
                            <formats>HTML</formats>
                            <includes>
<!--                                **/SayHi.class-->
                            </includes>
                            <excludes>
<!--                               **/SayHello.class-->
                            </excludes>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>2.22.2</version>
                <configuration>
                    <skipTests>false</skipTests>
                    <testFailureIgnore>true</testFailureIgnore>
                    <forkMode>once</forkMode>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

类与测试类

业务类：

public class SayHi {

    public static String hi(String name) {
        if (name == null) {
            return "名字不能为空";
        } else if (name.trim().isEmpty()) {
            return "名字不能为空字符串";
        } else {
            return "Hi " + name;
        }
    }
}

public class SayHello {

    public static String hello(String name) {
        if (name == null) {
            return "名字不能为空";
        } else if (name.trim().isEmpty()) {
            return "名字不能为空字符串";
        } else {
            return "Hello " + name;
        }
    }
}

测试类：

import org.junit.jupiter.api.Test;

import static org.junit.jupiter.api.Assertions.*;

class SayHiTest {

    @Test
    void getMessage() {
        assertEquals("Hi allen", SayHi.hi("allen"));
        SayHi.hi("");
        SayHi.hi(null);
    }
}

import org.junit.jupiter.api.Test;

class SayHelloTest {

    @Test
    void hello() {
        SayHello.hello("allen");
    }
}

执行mvn命令，执行单元测试：

mvn clean test

输出的目录默认在项目目录下的target/site/jacoco目录下。

结果如下：

jacoco基本信息

其中1是指令覆盖率，2是分支覆盖率，后面是没有被覆盖到的复杂度(行、方法、类)与总复杂度(行、方法、类)

Total部分是汇总信息。

我们可以接着往下点，可以看到具体的类、方法、行的覆盖信息。

【具体方法行覆盖信息】
具体方法覆盖信息

jacoco常用配置

prepare-agent

jacoco.exec在这个阶段生成。

<plugin>
    <groupId>org.jacoco</groupId>
    <artifactId>jacoco-maven-plugin</artifactId>
    <version>0.8.11</version>
    <executions>
        <execution>
            <id>prepare-agent</id>
            <goals>
                <goal>prepare-agent</goal>
            </goals>
            <configuration>
                <classDumpDir>target/site/jacoco/med-class</classDumpDir>
                <excludes>
                    <exclude>vip.meet.SayHello</exclude>
                </excludes>
                <includes>
                    <include>vip.meet.SayHi</include>
                </includes>
            </configuration>
        </execution>
    </executions>
</plugin>

report阶段

最常用的就是生成报告的时候，我们可能不想报告太乱，我们可以跳过某些类的，或者只为某些类生成报告。

<execution>
    <id>generate-code-coverage-report</id>
    <phase>test</phase>
    <goals>
        <goal>report</goal>
    </goals>
    <configuration>
         <!--定义输出的文件夹-->
        <outputDirectory>target/jacoco</outputDirectory>
        <!--执行数据的文件-->
        <dataFile>${project.build.directory}/jacoco.exec</dataFile>
        <!--要从报告中排除的类文件列表，支持通配符(*和?)-->
        <excludes>**/api/**/SayHello*.class</excludes>
        <!--包含生成报告的文件列表，支持通配符(*和?)-->
        <includes>**/SayHi.class</includes>
        <!--HTML 报告页面中使用的页脚文本-->
        <footer></footer>
        <!--生成报告的文件类型，HTML(默认)、XML、CSV-->
        <formats>HTML</formats>
        <!--生成报告的编码格式，默认UTF-8-->
        <outputEncoding>UTF-8</outputEncoding>
        <!--跳过执行的标签-->
        <skip></skip>
        <!--源文件编码-->
        <sourceEncoding>UTF-8</sourceEncoding>
        <!--HTML报告的标题-->
        <title>${project.name}-单元测试报告</title>
    </configuration>
</execution>

例如，我只想看SayHi的覆盖测试情况，就可以在report阶段配置includes为 **/SayHi.class

rule-规则检查

<plugin>
    <groupId>org.jacoco</groupId>
    <artifactId>jacoco-maven-plugin</artifactId>
    <version>0.8.11</version>
    <configuration>
    <rules>
        <rule implementation="org.jacoco.maven.RuleConfiguration">
            <element>BUNDLE</element>
            <limits>　　
                <!-- 方法覆盖率最小值为80% -->
                <limit implementation="org.jacoco.report.check.Limit">
                    <counter>METHOD</counter>
                    <value>COVEREDRATIO</value>
                    <minimum>0.8</minimum>
                </limit>
                <!-- 分支覆盖最小值为50% -->
                <limit implementation="org.jacoco.report.check.Limit">
                    <counter>BRANCH</counter>
                    <value>COVEREDRATIO</value>
                    <minimum>0.5</minimum>
                </limit>
                <!-- 类必须全部被覆盖 -->
                <limit implementation="org.jacoco.report.check.Limit">
                    <counter>CLASS</counter>
                    <value>MISSEDCOUNT</value>
                    <maximum>0</maximum>
                </limit>
            </limits>
        </rule>
    </rules>
</configuration>
</plugin>

rule参数：

  1. element：范围，bundle、package、class、sourcefile、method
  2. includes：需要检查的元素集合名
  3. excludes：不需要被检查的元素
  4. imits：用于检查的limits

limit参数：

  1. counter：INSTRUCTION(指令)、LINE(行)、BRANCH(分支)、COMPLEXITY(复杂度)、METHOD(方法)、CLASS(类)
  2. value：TOTALCOUNT(总数量)、MISSEDCOUNT(未覆盖数量)、COVEREDCOUNT(覆盖数量)、MISSEDRATIO(未覆盖率)、COVEREDRATIO(覆盖率)
  3. minimum：最小值
  4. maximum：最大值

rule检查不满足条件的时候，mvn test阶段直接报错。

rule是在check阶段执行的

 <execution>
    <id>check</id>
    <goals>
        <goal>check</goal>
    </goals>
</execution>

聚合项目配置

聚合项目

聚合项目可以单独添加一个子项目，来做聚合操作，只需配置：report-aggregate

<execution>
    <id>jacoco-report-aggregate</id>
    <phase>test</phase>
    <goals>
        <goal>report-aggregate</goal>
    </goals>
</execution>

具体pom配置可以参考下面

父项目pom配置

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>vip.meet</groupId>
    <artifactId>jacoco-aggregate-test</artifactId>
    <version>1.0.0</version>
    <packaging>pom</packaging>
    <name>jacoco-test</name>
    <description>单元测试覆盖率集合报告</description>

    <modules>
        <module>jacoco-one</module>
        <module>jacoco-two</module>
        <module>jacoco-aggregate</module>
    </modules>

    <properties>
        <java.version>17</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.junit.jupiter</groupId>
            <artifactId>junit-jupiter</artifactId>
            <version>5.8.2</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.junit.platform</groupId>
            <artifactId>junit-platform-launcher</artifactId>
            <version>1.7.2</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>${java.version}</source>
                    <target>${java.version}</target>
                    <encoding>UTF8</encoding>
                </configuration>
                <version>3.8.1</version>
            </plugin>
            <plugin>
                <groupId>org.jacoco</groupId>
                <artifactId>jacoco-maven-plugin</artifactId>
                <version>0.8.11</version>
                <executions>
                    <execution>
                        <id>prepare-agent</id>
                        <goals>
                            <goal>prepare-agent</goal>
                        </goals>
                        <configuration>
                        </configuration>
                    </execution>
                    <execution>
                        <id>generate-code-coverage-report</id>
                        <phase>test</phase>
                        <goals>
                            <goal>report</goal>
                        </goals>
                        <configuration>
                            <formats>HTML</formats>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>2.22.2</version>
                <configuration>
                    <skipTests>false</skipTests>
                    <testFailureIgnore>true</testFailureIgnore>
                    <forkMode>once</forkMode>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

配置聚合项目jacoco-maven-plugin其实最好放到子项目，按需配置，这里为了直观直接配置到了父项目的pom中，就意味着所有的子项目都继承了jacoco-maven-plugin。

我们可以看到配置了3个子项目：

<modules>
    <module>jacoco-one</module>
    <module>jacoco-two</module>
    <module>jacoco-aggregate</module>
</modules>

jacoco-one和jacoco-two是正常的子项目，jacoco-aggregate是用来做聚合报告的。

主要需要看一下jacoco-aggregate的pom配置：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>vip.meet</groupId>
        <artifactId>jacoco-aggregate-test</artifactId>
        <version>1.0.0</version>
    </parent>

    <artifactId>jacoco-aggregate</artifactId>
    <packaging>jar</packaging>

    <dependencies>
		<dependency>
			<groupId>vip.meet</groupId>
			<artifactId>jacoco-one</artifactId>
            <version>1.0.0</version>
		</dependency>
        <dependency>
			<groupId>vip.meet</groupId>
			<artifactId>jacoco-two</artifactId>
            <version>1.0.0</version>
		</dependency>
        </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.jacoco</groupId>
                <artifactId>jacoco-maven-plugin</artifactId>
                <version>0.8.11</version>
                <executions>
                    <execution>
                        <id>default-prepare-agent</id>
                        <goals>
                            <goal>prepare-agent</goal>
                        </goals>
                        <configuration>

                        </configuration>
                    </execution>
                    <execution>
                        <id>default-report</id>
                        <phase>test</phase>
                        <goals>
                            <goal>report</goal>
                        </goals>
                    </execution>
                    <execution>
                        <id>jacoco-report-aggregate</id>
                        <phase>test</phase>
                        <goals>
                            <goal>report-aggregate</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

2点非常重要：

  1. 首先要通过dependency把需要统计覆盖率的项目依赖引入
  2. 单独配置jacoco-maven-plugin，因为需要report-aggregate

示例项目下载

trayvontang
关注
Maven测试覆盖率：JaCoCo插件配置指南
Java技术栈实战开发的博客
04-15 787
JaCoCo(Java Code Coverage)是一个广泛使用的Java代码覆盖率工具，它能够帮助开发团队衡量测试代码对产品代码的覆盖程度。本文旨在提供一份全面的指南，介绍如何在Maven项目中配置和使用JaCoCo插件，包括基本配置、高级技巧以及与持续集成系统的集成。介绍JaCoCo和测试覆盖率的基本概念详细讲解Maven中JaCoCo插件的配置方法展示覆盖率报告的生成和分析探讨高级配置和最佳实践介绍与持续集成系统的集成代码覆盖率(Code Coverage)
jacoco框架学习使用
最新发布
liushangzaibeijing的博客
04-02 944
（Java Code Coverage）是一个用于的。分析代码执行情况，评估测试用例对代码的覆盖程度，生成覆盖率报告。
JaCoCo：Java代码覆盖率的工具
zx893404890的博客
09-24 1391
JaCoCo（Java Code Coverage）是一个开源的Java代码覆盖率工具，它能够帮助开发者分析代码的测试覆盖情况。通过JaCoCo，我们可以清晰地看到哪些代码被测试覆盖，哪些没有，从而有针对性地进行改进。JaCoCo不仅支持多种测试框架（如JUnit、TestNG），还可以与构建工具（如Maven、Gradle）无缝集成，极大地方便了我们的开发流程。
Java单元覆盖率工具JaCoCo详细理解和使用(配置+示例)
热门推荐
skh2015java的博客
12-07 8万+
一、代码覆盖率理解 代码覆盖（Code coverage）是软件测试中的一种度量，描述程序中源代码被测试的比例和程度，所得比例称为代码覆盖率。 简单来理解，就是单元测试中代码执行量与代码总量之间的比率。 Java常用的单元测试覆盖率框架有：JaCoCo、EMMA和Cobertura，本篇文章主要介绍JaCoCo的使用。 二、JaCoCo理解 JaCoCo官方文档：https://www.eclemma.org/jacoco/trunk...
jacoco-example:JaCoCo使用示例
05-22
雅各布的例子 JaCoCo使用示例
代码覆盖率工具JaCoCo用法总结及示例
小蜜蜂1010的博客
05-18 1万+
Java代码覆盖率工具JaCoCo的用法及配置示例
jacoco的使用
码农崛起
11-04 1万+
一、概述 测试覆盖率，老生常谈的话题。因为我测试理论基础不是很好，就不提什么需求覆盖率啦这样那样的主题了，直奔主题，咱主要指 Java 后端的测试覆盖率。 由于历史原因，公司基本不做 UT，所以对测试来说，咱最关心的还是手工执行、接口执行 (人工 Postman 之类的)、接口自动化、WebUI 自动化对一个应用系统的覆盖度。 此文也是对另一篇文章关于 Java 端覆盖率探索的一个细化，当时主要是为了描述 App 端的踩坑，所以关于服务端一笔带过了，现得空详细补充一下。小记 Java 服务端和 And
JACOCO使用
meilidekcl的博客
04-06 2771
jacoco的使用记录
JaCoCo 项目使用教程
gitblog_01127的博客
10-11 1153
JaCoCo 项目使用教程 项目地址:https://gitcode.com/gh_mirrors/ja/jacoco 1. 项目目录结构及介绍 JaCoCo（Java Code Coverage）是一个用于测量和报告Java代码覆盖率的工具。以下是JaCoCo项目的目录结构及其主要文件的介绍： jacoco/ ├── agent/ │ ├── rt/ │ └── test/ ├── an...
【软将军-jacoco】执行jacoco进行单元测试，pom里应该配置什么依赖和插件，pom里面配置起的作用是什么？
weixin_46453070的博客
10-04 1424
提供代码覆盖率的实时收集功能，帮助开发者了解未测试的代码部分。自动生成详细的覆盖率报告，以便于检查代码质量和提高测试的全面性。可以集成到 CI/CD 流程中，确保在代码合并或发布之前满足特定的覆盖率标准。是必需的，以便在测试运行时收集覆盖率数据。report是必需的，以便在测试完成后生成覆盖率报告。check是可选的，用于在构建过程中验证覆盖率是否达到预期标准。通过这些配置，您可以确保在构建过程中正确收集和报告代码覆盖率信息。基本配置和report是最常用的配置，用于收集和生成覆盖率报告。
Java单元覆盖率工具JaCoCo使用指南
不积跬步，无以至千里；不积小流，无以成江海。
08-05 1193
JaCoCo（Java Code Coverage Library）是一款开源的Java代码覆盖率工具，它提供了详细的代码覆盖信息，帮助开发人员了解测试用例对代码的覆盖情况，从而发现潜在的问题和改进空间。
EclEmma和JaCoCo简介与使用说明
03-13
EclEmma是一个免费的用来测试Java代码覆盖率的Eclipse插件，可以用EclEmma直接在Eclipse工作区中测试Java程序，分析代码覆盖率，并且在Java编辑器中高亮显示源文件的代码覆盖情况。
Jacoco测试覆盖率实践教程与示例
资源摘要信息:"本文档为 jacoco 实践demo的详细说明。Jacoco 是一个用于Java代码覆盖度量的开源工具，它可以集成到多种构建和开发环境中。本文档旨在通过具体的demo实践，向读者展示如何使用Jacoco进行Java代码的...
代码覆盖率系列（一）：jacoco使用
u011250186的博客
10-09 1842
代码覆盖率系列（一）：jacoco使用
Jacoco 入门使用
dabaoting的博客
03-05 3595
Jacoco入门使用背景为什么需要代码覆盖率on the fly模式(运行时插桩)1. 原理2. 配置执行2.1 环境准备2.2 启动被测服务方式一：命令行方式二：maven插件启动方式三：tomcat启动2.3 生成有源码的报告offline模式(编译时插桩)1.适用场景命令行使用环境准备命令详解1 dump23 背景 为什么需要代码覆盖率 反推测试用例是否全面 研发代码本身设计是否冗余 on the fly模式(运行时插桩) 1. 原理 1.利用Jacocoagent.jar在内存中动态修改clas
jacoco 使用
weixin_44412864的博客
03-20 243
jacoco 使用 参考 jacoco表单 就是在pipeline中加一个 jacoco() 真的是太菜了
單元測試覆蓋率工具JaCoCo的使用介紹
漢家郎
02-28 7255
JaCoCo是基於ANT的單元測試覆蓋率報告自動生成工具，它可用來針對整個專案的單元測試用例生成覆蓋率報告。 JaCoCo的下載 至頁面下載最新版本的JaCoCo壓縮包，解壓縮後找到Lib資料夾下的jacocoant.jar文件備用。 JaCoCo工具是與ANT工具結合使用，用來完成自動化單元測試的覆蓋率報告生成工作。在ANT的腳本裡設置步驟如下所示： 1.        在根節點裡添加屬
JaCoCo 插件使用教程
gitblog_00747的博客
08-16 704
JaCoCo 插件使用教程 jacoco-pluginJenkins JaCoCo Plugin项目地址:https://gitcode.com/gh_mirrors/ja/jacoco-plugin 1. 项目的目录结构及介绍 JaCoCo 插件的目录结构如下： jacoco-plugin/ ├── src/ │ ├── main/ │ │ ├── java/ │ │ └─...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值