Spring Boot - JaCoCo Code Coverage

news2025/3/3 18:41:49

文章目录

  • 概述
  • 如何集成
  • pom添加插件
  • Code Demo
  • 排除不相关的类
  • CI/CD中使用
  • 完整POM

在这里插入图片描述

概述

JaCoCo（Java Code Coverage）是一个开源的Java代码覆盖率工具，它主要用于评估Java程序的测试完整性。通过跟踪测试过程中执行的代码，JaCoCo能够提供多种覆盖率指标，帮助开发者确保代码的测试质量。这些指标包括指令覆盖、分支覆盖、圈复杂度、行覆盖、方法覆盖和类覆盖。

在实际应用中，JaCoCo可以嵌入到构建工具如Maven和Ant中，也可以作为Eclipse插件使用。此外，它还支持JavaAgent技术，能够监控Java程序的执行并收集覆盖率数据。JaCoCo生成的覆盖率报告可以帮助开发者识别未被测试到的代码部分，从而指导他们完善测试用例。

JaCoCo的设计旨在提供灵活的集成方式，可以与其他开发和测试工具如Sonar和Jenkins集成，以增强代码质量和测试流程的管理。它的原理是通过在测试运行时，对程序的代码执行情况进行监控，并通过一系列的规则和限制来确保代码的测试覆盖程度。这样的工具对于提升软件测试的全面性和深度具有重要作用。

如何集成

集成JaCoCo到你的Java项目中通常涉及以下几个步骤：

  1. 添加JaCoCo依赖：
    • 对于Maven项目，你需要在pom.xml文件中添加JaCoCo的依赖。例如：
      <dependencies>
  <!-- 其他依赖 -->
  <dependency>
    <groupId>org.jacoco</groupId>
    <artifactId>jacoco-maven-plugin</artifactId>
    <version>0.8.3</version> <!-- 使用最新的版本 -->
    <scope>test</scope>
  </dependency>
</dependencies>
    • 对于Gradle项目，你需要在build.gradle文件中添加JaCoCo的插件和依赖。例如：
      plugins {
  id 'jacoco' version '0.8.3' // 使用最新的版本
  // 其他插件
}
  2. 配置JaCoCo插件：
    • 在pom.xml或build.gradle文件中，需要配置JaCoCo插件的行为。这包括设置覆盖率目标、输出报告的格式和路径等。
    • 例如，在Maven的pom.xml中，可能需要配置prepare-agent、report和check等生命周期任务：
      <build>
  <plugins>
    <plugin>
      <groupId>org.jacoco</groupId>
      <artifactId>jacoco-maven-plugin</artifactId>
      <version>0.8.3</version>
      <executions>
        <execution>
          <id>prepare-agent</id>
          <goals>
            <goal>prepare-agent</goal>
          </goals>
        </execution>
        <execution>
          <id>report</id>
          <phase>test</phase>
          <goals>
            <goal>report</goal>
          </goals>
        </execution>
        <!-- 强制要求覆盖率 -->
        <execution>
          <id>check-code-coverage</id>
          <phase>test</phase>
          <goals>
            <goal>check</goal>
          </goals>
          <configuration>
            <rules>
              <rule>
                <element>BUNDLE</element>
                <limits>
                  <limit>
                    <counter>INSTRUCTION</counter>
                    <value>COVEREDRATIO</value>
                    <minimum>0.80</minimum> <!-- 至少80%的代码被执行 -->
                  </limit>
                  <!-- 可以添加更多的规则 -->
                </limits>
              </rule>
            </rules>
          </configuration>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>
  3. 运行测试并生成覆盖率报告：
    • 使用Maven的mvn test命令或者Gradle的gradle test命令运行你的测试。
    • 测试完成后，JaCoCo会生成覆盖率报告，通常在target/site/jacoco目录下（对于Maven项目）。
  4. 分析覆盖率报告：
    • 打开生成的HTML报告，分析覆盖率数据。
    • 识别未覆盖到的代码区域，并补充相应的测试用例。
  5. 集成到持续集成/持续部署（CI/CD）流程（可选）：
    • 将JaCoCo集成到你的CI/CD工具链中，比如Jenkins、Travis CI、GitLab CI等。
    • 在CI/CD配置中添加步骤来运行测试并生成覆盖率报告。
  6. 使用JaCoCo的命令行工具（可选）：
    • 使用JaCoCo提供的命令行工具来生成报告，如jacoco coverage report。
    • 可以配置命令行工具来与IDE或构建工具集成。

请注意，具体的集成步骤和配置可能会根据所使用的构建工具、IDE和项目设置有所不同。因此，建议查阅最新的JaCoCo官方文档 。

接下来我们以以Spring Boot 为例 看看如何完成集成

pom添加插件

pom.xml中增加如下配置

<build>
    <pluginManagement>
        <plugins>
            <plugin>
                <groupId>org.jacoco</groupId>
                <artifactId>jacoco-maven-plugin</artifactId>
                <version>0.8.8</version>
            </plugin>
        </plugins>
    </pluginManagement>
    <plugins>
        <plugin>
            <groupId>org.jacoco</groupId>
            <artifactId>jacoco-maven-plugin</artifactId>
            <executions>
                <execution>
                    <goals>
                        <goal>prepare-agent</goal>
                    </goals>
                </execution>
                <execution>
                    <id>report</id>
                    <phase>test</phase>
                    <goals>
                        <goal>report</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

https://www.jacoco.org/jacoco/trunk/doc/maven.html

Code Demo

在这里插入图片描述

package com.artisan.service;

/**
 * @author 小工匠
 * @version 1.0
 * @mark: show me the code , change the world
 */
public class ShippingService {

    public int calculateShippingFee(int weight) {
        if (weight <= 0) {
            throw new IllegalStateException("Please provide correct weight");
        }
        if (weight <= 2) {
            return 5;
        } else if (weight <= 5) {
            return 10;
        }
        return 15;
    }
}
    

package com.artisan.service;

import org.junit.jupiter.api.Test;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;

/**
 * @author 小工匠
 * @version 1.0 
 * @mark: show me the code , change the world
 */
public class TestShippingService {

    @Test
    public void incorrectWeight() {
        ShippingService shippingService = new ShippingService();
        assertThrows(IllegalStateException.class, () -> shippingService.calculateShippingFee(-1));
    }

    @Test
    public void firstRangeWeight() {
        ShippingService shippingService = new ShippingService();
        assertEquals(5, shippingService.calculateShippingFee(1));
    }
}

转到 Maven，选择 clean 和 test 命令，然后选择 Run Maven Build

在这里插入图片描述

在这里插入图片描述

测试完成后， target/site/jacoco/index.html 包含所有输出。

在这里插入图片描述
在图像中看到，boot-jarcoo是项目名称，com.artisan.service 是包。显示代码已覆盖 68%，分支已覆盖 50%。

点击com.artisan.service ，进入详情

在这里插入图片描述

ShippingService ，里面代码已经覆盖了 68%，分支已经覆盖了 50% 。

进入 ShippingService 类

在这里插入图片描述

打开 calculateShippingfee(int) 方法

在这里插入图片描述

Jacoco 在这里非常清楚地展示了不同级别的覆盖范围。它使用不同颜色的菱形图标来表示分支的代码覆盖率。并使用背景颜色来表示行的代码覆盖率。

  • 绿色菱形表示所有分支均已被覆盖。
  • 黄色菱形意味着代码已被部分覆盖 ， 一些未经测试的分支。
  • 红色菱形表示测试期间没有使用任何分支。

接下来添加更多代码来覆盖部分覆盖的分支。

  @Test
    public void secondRangeWeight() {
        ShippingService shippingService = new ShippingService();
        assertEquals(10, shippingService.calculateShippingFee(4));
    }

Run Maven Build 再次使用 clean 和 test 命令，再次在浏览器中打开 calculateShippingfee(int) 方法的测试覆盖率。

在这里插入图片描述

可以看到黄色钻石仍然在那里。这意味着我们还没有涵盖权重大于 5 的场景。让我们再添加一个测试用例

   @Test
    public void lastRangeWeight() {
        ShippingService shippingService = new ShippingService();
        assertEquals(15, shippingService.calculateShippingFee(10));
    }

在这里插入图片描述

可以看到所有的场景都已经被完全覆盖了。

排除不相关的类

在这里插入图片描述

意到 App类对于覆盖率报告并不是非常重要。在某些情况下，此类的覆盖率可能会扭曲整体代码覆盖率报告。为了避免此类不相关的类影响代码覆盖率，我们可以使用Jacoco插件将其排除。

<plugins>
    <plugin>
        <groupId>org.jacoco</groupId>
        <artifactId>jacoco-maven-plugin</artifactId>
        <configuration>
                 <excludes>
                     <exclude>com/artisan/App.class</exclude>
                 </excludes>
         </configuration>
        ...
    </plugin>
</plugins>

在这里插入图片描述

https://www.eclemma.org/jacoco/trunk/doc/report-mojo.html#excludes

重新编译测试，得到报告

在这里插入图片描述

CI/CD中使用

现在假设我们使用 CI/CD 来部署代码，我们可能想验证已经完成了多少行代码覆盖率或代码覆盖率百分比等。为此，我们需要在Jacoco 插件配置

<execution>
    <id>jacoco-check</id>
    <goals>
        <goal>check</goal>
    </goals>
    <configuration>
        <rules>
            <rule>
                <element>PACKAGE</element>
                <limits>
                    <limit>
                        <counter>LINE</counter>
                        <value>COVEREDRATIO</value>
                        <minimum>90%</minimum>
                    </limit>
                </limits>
            </rule>
        </rules>
    </configuration>
</execution>

在此执行中，我们添加了一条规则。规则是，对于 PACKAGE，计数应为 LINE，并且 LINE 覆盖率最小应为 90%.

转到 Maven，选择 clean 和 verify 命令，然后选择 Run Maven Build 进行检查。

在这里插入图片描述

为了验证这个功能，我们先去掉

    @Test
    public void secondRangeWeight() {
        ShippingService shippingService = new ShippingService();
        assertEquals(10, shippingService.calculateShippingFee(4));
    }


    @Test
    public void lastRangeWeight() {
        ShippingService shippingService = new ShippingService();
        assertEquals(15, shippingService.calculateShippingFee(10));
    }

再 选择 clean 和 verify 命令，然后选择 Run Maven Build 进行检查。
在这里插入图片描述

可以看到它失败了。原因清楚地表明违反了规则“线路覆盖率为0.62，但预期最小值为0.90”。

现在让我们更新 LINE 覆盖率最小值为 60%，然后再次运行。

在这里插入图片描述

完整POM

<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">
    <parent>
        <artifactId>boot2</artifactId>
        <groupId>com.artisan</groupId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>boot-jarcoo</artifactId>
    <packaging>jar</packaging>

    <name>boot-jarcoo</name>
    <url>http://maven.apache.org</url>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13.2</version>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.jacoco</groupId>
                    <artifactId>jacoco-maven-plugin</artifactId>
                    <version>0.8.8</version>
                </plugin>
            </plugins>
        </pluginManagement>
        <plugins>
            <plugin>
                <groupId>org.jacoco</groupId>
                <artifactId>jacoco-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>com/artisan/App.class</exclude>
                    </excludes>
                </configuration>
                <executions>
                    <execution>
                        <goals>
                            <goal>prepare-agent</goal>
                        </goals>
                    </execution>

                    <execution>
                        <id>jacoco-check</id>
                        <goals>
                            <goal>check</goal>
                        </goals>
                        <configuration>
                            <rules>
                                <rule>
                                    <element>PACKAGE</element>
                                    <limits>
                                        <limit>
                                            <counter>LINE</counter>
                                            <value>COVEREDRATIO</value>
                                            <minimum>60%</minimum>
                                        </limit>
                                    </limits>
                                </rule>
                            </rules>
                        </configuration>
                    </execution>

                    <execution>
                        <id>report</id>
                        <phase>test</phase>
                        <goals>
                            <goal>report</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

在这里插入图片描述

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1382131.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

【Python数据可视化】matplotlib之绘制常用图形：折线图、柱状图（条形图）、饼图和直方图

【Python数据可视化】matplotlib之绘制常用图形：折线图、柱状图（条形图）、饼图和直方图

文章传送门 Python 数据可视化matplotlib之绘制常用图形&#xff1a;折线图、柱状图&#xff08;条形图&#xff09;、饼图和直方图matplotlib之设置坐标&#xff1a;添加坐标轴名字、设置坐标范围、设置主次刻度、坐标轴文字旋转并标出坐标值matplotlib之增加图形内容&#x…
阅读更多...
读元宇宙改变一切笔记07_硬件与互操作性（上）

读元宇宙改变一切笔记07_硬件与互操作性（上）

1. 元宇宙的头号入口 1.1. 元宇宙最令人兴奋的地方在于&#xff0c;我们可以借此开发用来访问、渲染和操纵它的新设备 1.1.1. App Newton于1993年发布&#xff0c;是世界上第一款掌上电脑 1.2. 功能超强大又轻巧的AR和沉浸式VR头显 1.2.1.…
阅读更多...
AI智能创作软件，颠覆你的写作体验

AI智能创作软件，颠覆你的写作体验

你是否想过&#xff0c;有一天&#xff0c;文字创作不再受限于人的思维和表达能力&#xff1f;AI智能文章创作就是这样一个神奇的存在。它运用先进的自然语言处理技术&#xff0c;通过对大量数据的深度学习&#xff0c;根据需要自动生成文章。你只需输入关键词或主题&#xff0…
阅读更多...
【天龙八部】攻略day6

【天龙八部】攻略day6

关键字&#xff1a; 灵武、寻宝要求、雁门 1】灵武选择 西凉枫林&#xff0c;锦带&#xff0c;短匕 白溪湖&#xff0c;明镜&#xff0c;双刺 竹海&#xff0c;玉钩&#xff0c;锁甲 2】楼兰寻宝需求 等级80级&#xff0c;40级前6本心法 3】雁门奖励 简单35*4元佑碎金 普…
阅读更多...
机器学习扩散模型简介

机器学习扩散模型简介

一、说明 扩散模型的迅速崛起是过去几年机器学习领域最大的发展之一。在这本易于理解的指南中了解您需要了解的有关扩散模型的所有信息。 扩散模型是生成模型&#xff0c;在过去几年中越来越受欢迎&#xff0c;这是有充分理由的。仅在 2020 年代发布的几篇开创性论文就向世界…
阅读更多...
强化学习应用（二）：基于Q-learning的物流配送路径规划研究（提供Python代码）

强化学习应用（二）：基于Q-learning的物流配送路径规划研究（提供Python代码）

一、Q-learning算法简介 Q-learning是一种强化学习算法&#xff0c;用于解决基于马尔可夫决策过程&#xff08;MDP&#xff09;的问题。它通过学习一个值函数来指导智能体在环境中做出决策&#xff0c;以最大化累积奖励。 Q-learning算法的核心思想是使用一个Q值函数来估计每…
阅读更多...
Docker实战10｜实现volum数据卷

Docker实战10｜实现volum数据卷

上一篇文章中&#xff0c;仔细讲解了Docker是如何改变当前的root文件系统以及mount等操作。 本文继续讲解Docker是如何实现Volum数据卷的。 实现Volume数据卷 获取代码 git clone https://gitee.com/mjreams/docker.git 上一小节介绍了如何使用AUFS包装busybox&#xff0c…
阅读更多...
【Python】使用tkinter设计开发Windows桌面程序记事本（5）

【Python】使用tkinter设计开发Windows桌面程序记事本（5）

上一篇&#xff1a;【Python】使用tkinter设计开发Windows桌面程序记事本&#xff08;4&#xff09;-CSDN博客 下一篇&#xff1a;待羽翼丰满之时&#xff0c;必将是文章更新之日&#xff01; 作者发炎 本篇文章继承了前面四篇文章&#xff0c;并且实现了新建、保存、另存、打…
阅读更多...
Open3D 计算点云质心和中心（18）

Open3D 计算点云质心和中心（18）

Open3D 计算点云质心和中心（18） 一、算法介绍二、算法实现1.代码2.结果一、算法介绍 质心和中心是有所区别的，点云质心可以看作每个点的坐标均值，点云中心可以看作点云所在包围盒的中心，这也是上一章坐标最值的常用方法，下面就两种方法进行实现（图例，大概就是这个意思…
阅读更多...
JVM工作原理与实战(十五)：运行时数据区-程序计数器

JVM工作原理与实战(十五)：运行时数据区-程序计数器

专栏导航 JVM工作原理与实战 RabbitMQ入门指南 从零开始了解大数据 目录 专栏导航 前言 一、运行时数据区 二、程序计数器 总结 前言 JVM作为Java程序的运行环境&#xff0c;其负责解释和执行字节码&#xff0c;管理内存&#xff0c;确保安全&#xff0c;支持多线程和提供…
阅读更多...
电子学会C/C++编程等级考试2023年09月（四级）真题解析

电子学会C/C++编程等级考试2023年09月（四级）真题解析

C/C++编程（1~8级）全部真题・点这里 第1题：酒鬼 Santo刚刚与房东打赌赢得了一间在New Clondike 的大客厅。今天，他来到这个大客厅欣赏他的奖品。房东摆出了一行瓶子在酒吧上。瓶子里都装有不同体积的酒。令Santo高兴的是，瓶子中的酒都有不同的味道。房东说道：“你可以喝尽…
阅读更多...
用ChatGPT写论文的重要指令

用ChatGPT写论文的重要指令

使用ChatGPT写论文&#xff0c;chatgpt3.5的普通版本与ChatGPTPLUS版本我都尝试过&#xff0c;这里我还是比较喜欢ChatGPTPLUS来写论文 快速订阅ChatGPTPLUS方法&#xff0c;0年费、0月费 具体步骤可参考 亲测&#xff0c;Chatgpt4.0充值&#xff08;虚拟卡充值&#xff09;-…
阅读更多...
网络安全B模块（笔记详解）- 网络渗透测试

网络安全B模块（笔记详解）- 网络渗透测试

LAND网络渗透测试 1.进入虚拟机操作系统：BT5中的/root目录，完善该目录下的land.py文件，填写该文件当中空缺的Flag1字符串，将该字符串作为Flag值（形式：Flag1字符串）提交；（land.py脚本功能见该任务第6题） 输入flag sendp(packet) Flag：sendp(packet) 2.进入虚拟机操作…
阅读更多...
QSpace：Mac上的简洁高效多窗格文件管理器

QSpace：Mac上的简洁高效多窗格文件管理器

在Mac用户中&#xff0c;寻找一款能够提升文件管理效率的工具是常见的需求。QSpace&#xff0c;一款专为Mac设计的文件管理器&#xff0c;以其简洁的界面、高效的多窗格布局和丰富的功能&#xff0c;为用户提供了一个全新的文件管理体验。 QSpace&#xff1a;灵活与功能丰富的结…
阅读更多...
CMake+QT+大漠插件的桌面应用开发

CMake+QT+大漠插件的桌面应用开发

文章目录 CMakeQT大漠插件的桌面应用开发说明环境项目结构配置编译环境代码 CMakeQT大漠插件的桌面应用开发 说明 在CMake大漠插件的应用开发——处理dm.dll&#xff0c;免注册调用大漠插件中已经说明了如何免注册调用大漠插件&#xff0c;以及做了几个简单的功能调用&#x…
阅读更多...
响应式Web开发项目教程（HTML5+CSS3+Bootstrap）第2版 第1章 HTML5+CSS3初体验 项目1-1 三栏布局页面

响应式Web开发项目教程（HTML5+CSS3+Bootstrap）第2版 第1章 HTML5+CSS3初体验 项目1-1 三栏布局页面

项目展示 三栏布局是一种常用的网页布局结构。 除了头部区域、底部区域外&#xff0c;中间的区域&#xff08;主体区域&#xff09;划分成了三个栏目&#xff0c;分别是左侧边栏、内容区域和右侧边栏&#xff0c;这三个栏目就构成了三栏布局。当浏览器的宽度发声变化时&#x…
阅读更多...
最全对象存储（云盘）挂载本地主机或服务器

最全对象存储（云盘）挂载本地主机或服务器

1.对象存储介绍 1.1 分类 分布式存储的应用场景相对于其存储接口&#xff0c;现在流行分为三种: 块存储: 这种接口通常以QEMU Driver或者Kernel Module的方式存在&#xff0c;这种接口需要实现Linux的Block Device的接口或者QEMU提供的Block Driver接口&#xff0c;块存储一般…
阅读更多...
androidkiller的两种异常情况

androidkiller的两种异常情况

第一种反编译时异常&#xff1a; Exception in thread “main” org.jf.dexlib2.dexbacked.DexBackedDexFile$NotADexFile: Not a valid dex magic value: cf 77 4c c7 9b 21 01 修改方法&#xff1a; 编辑 AndroidKiller 的 bin/apktool 目录下有一个 apktool.bat 文件 修改成…
阅读更多...
nmealib 库移植 - -编译报错不完全类型 error: field ‘st_atim’ has incomplete type

nmealib 库移植 - -编译报错不完全类型 error: field ‘st_atim’ has incomplete type

一、报错提示-不完全类型(has incomplete type) Compiling obj/main.o from main.c.. arm-linux-gcc -g -w -stdgnu99 -DLINUX -I./ -Inmealib/inc/ -c -o obj/main.o main.c In file included from /home/user/Desktop/nuc980-sdk/sdk/arm_linux_4.8/usr/include/sys/stat…
阅读更多...
豆包ai介绍

豆包ai介绍

豆包是字节跳动基于云雀模型开发的AI工具&#xff0c;具有强大的语言处理能力和广泛的应用场景&#xff0c;无论是在学习、工作、生活中&#xff0c;都能派上用场。 豆包可以帮助打工人和创作者提升效率&#xff0c;完成各种工作任务&#xff0c;又能扮演各类AI角色进行高情商…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023