解决 SonarQube 中 JaCoCo 代码覆盖率显示为 0% 的问题

酷宇同学_6024

酷宇同学_6024

2025-09-25

700人浏览

原创

解决 sonarqube 中 jacoco 代码覆盖率显示为 0% 的问题

本文旨在解决 Maven 项目在 SonarQube 中代码覆盖率显示为 0% 的常见问题。核心原因通常是 JaCoCo 和 Surefire 插件配置不一致,导致 JaCoCo 覆盖率数据文件未正确生成或 SonarQube 无法找到生成的 XML 报告。我们将详细指导如何正确配置 pom.xml 和 Jenkins Pipeline,确保 JaCoCo 数据生成、XML 报告输出以及 SonarQube 正确读取。

1. 问题背景与根源分析

当您在 Jenkins Pipeline 中为 Spring Boot 应用执行 JUnit 测试并通过 SonarQube 进行代码质量分析时,可能会遇到 SonarQube 中代码覆盖率始终显示为 0% 的情况。这通常伴随着 JaCoCo 插件在构建日志中发出类似 Skipping JaCoCo execution due to missing execution data file 的警告。

此问题的根本原因在于 JaCoCo Maven 插件、Maven Surefire 插件以及 SonarQube 配置之间存在不一致。具体来说,主要有以下几点:

  • JaCoCo .exec 数据文件未生成或路径错误: JaCoCo 通过在 JVM 启动时注入代理来收集代码覆盖率数据,并将数据写入 .exec 文件。如果 Surefire 插件(负责运行测试)未能正确集成 JaCoCo 代理,或 .exec 文件生成路径与后续报告生成或 SonarQube 查找的路径不符,就会导致数据丢失。
  • JaCoCo XML 报告未生成或路径错误: SonarQube 通常需要 JaCoCo 生成的 XML 格式报告来导入覆盖率数据。如果 JaCoCo 报告生成阶段未正确配置,或者生成的 XML 报告路径与 SonarQube 配置中指定的路径不一致,SonarQube 将无法找到并解析覆盖率数据。
  • SonarQube 参数配置不正确: 在 Jenkins Pipeline 中调用 mvn sonar:sonar 命令时,传递给 SonarQube 的 JaCoCo 报告路径参数可能与实际生成的报告路径不匹配,或者使用了错误的参数名称。

为了解决这些问题,我们需要确保 JaCoCo、Surefire 和 SonarQube 之间的配置保持高度一致性。

2. Maven pom.xml 配置详解

pom.xml 是配置 JaCoCo 和 Surefire 插件的关键。以下是推荐的配置方式,确保 JaCoCo 代理正确注入测试 JVM,并生成 SonarQube 可识别的 XML 报告。

2.1 项目属性定义

在 块中,定义 JaCoCo .exec 文件和 XML 报告的路径,以及 Surefire 报告的路径。这将有助于保持配置的一致性。

Java Development Man
Java Development Man

Java开发手册规约集合,基于阿里巴巴Java开发手册(嵩山版)。 涵盖7大维度:编程规约、异常日志、单元测试、安全规约、MySQL数据库、工程结构、设计规约。

下载
<properties><java.version>1.8</java.version><project.build.sourceencoding>UTF-8</project.build.sourceencoding><!-- JaCoCo .exec 文件路径,用于存储运行时覆盖率数据 --><jacoco.exec.file>${project.build.directory}/jacoco.exec</jacoco.exec.file><!-- JaCoCo XML 报告输出目录 --><jacoco.report.dir>${project.build.directory}/jacoco_report</jacoco.report.dir><!-- SonarQube 相关的报告路径配置 --><sonar.surefire.reportspath>${project.build.directory}/surefire-reports</sonar.surefire.reportspath><sonar.coverage.jacoco.xmlreportpaths>${jacoco.report.dir}/jacoco.xml</sonar.coverage.jacoco.xmlreportpaths></properties>

2.2 Maven Surefire 插件配置

Surefire 插件负责运行单元测试。它需要使用 JaCoCo 代理来收集覆盖率数据。这通过 配置实现,该配置会从 JaCoCo 的 prepare-agent 目标中获取 JVM 参数。

<build><plugins><!-- Maven Surefire Plugin --><plugin><groupid>org.apache.maven.plugins</groupid><artifactid>maven-surefire-plugin</artifactid><version>2.22.2</version><!-- 建议使用较新且稳定的版本 --><configuration><!-- 关键:使用 JaCoCo prepare-agent 目标设置的 JVM 参数 --><argline>${surefireArgLine}</argline><!-- Surefire 报告输出目录 --><reportsdirectory>${sonar.surefire.reportsPath}</reportsdirectory></configuration></plugin><!-- ... 其他插件 ... --></plugins></build>

2.3 JaCoCo Maven 插件配置

JaCoCo 插件有两个主要目标需要配置:prepare-agent 和 report。

  • prepare-agent:在测试运行之前准备 JaCoCo 代理,并将其配置为 Surefire 插件的 。
  • report:在测试运行之后,根据 .exec 文件生成可供 SonarQube 使用的 XML 格式报告。
<build><plugins><!-- ... Surefire 插件配置 ... --><!-- JaCoCo Maven Plugin --><plugin><groupid>org.jacoco</groupid><artifactid>jacoco-maven-plugin</artifactid><version>0.8.6</version><!-- 确保版本与 SonarQube 兼容,或使用最新稳定版 --><executions><!-- 1. prepare-agent 目标:在测试运行前准备 JaCoCo 代理 --><execution><id>prepare-agent</id><goals><goal>prepare-agent</goal></goals><configuration><!-- 指定 .exec 文件的生成路径 --><destfile>${jacoco.exec.file}</destfile><!-- 定义一个属性,用于 Surefire 插件的 argLine --><propertyname>surefireArgLine</propertyname></configuration></execution><!-- 2. report 目标:在测试运行后生成 XML 报告 --><execution><id>report</id><phase>post-unit-test</phase><!-- 确保在单元测试完成后执行 --><goals><goal>report</goal></goals><configuration><!-- 指定输入 .exec 文件,即 prepare-agent 生成的文件 --><datafile>${jacoco.exec.file}</datafile><!-- 指定 XML 报告的输出目录 --><outputdirectory>${jacoco.report.dir}</outputdirectory><!-- 明确指定生成 XML 格式报告 --><formats><format>XML</format></formats></configuration></execution></executions></plugin></plugins></build>

3. Jenkins Pipeline 配置示例

在 Jenkins Pipeline 中,您需要执行 Maven 命令来构建、测试并触发 SonarQube 分析。关键在于确保 mvn sonar:sonar 命令能够正确地找到 JaCoCo 生成的 XML 报告。

pipeline {
    agent any
    stages {
        stage('Build and Test') {
            steps {
                script {
                    // 清理、编译、运行测试并生成 JaCoCo .exec 数据和 XML 报告。
                    // 'verify' 阶段会包含 'test' 阶段和 'post-unit-test' 阶段(JaCoCo report 目标绑定在此)。
                    // 确保所有测试都运行,并且 JaCoCo 报告被生成。
                    sh 'mvn clean verify'
                }
            }
        }
        stage('SonarQube Analysis') {
            steps {
                script {
                    // 确保此处的报告路径与 pom.xml 中 JaCoCo 插件实际生成 XML 报告的路径一致。
                    // 对应 pom.xml 中 <sonar.coverage.jacoco.xmlreportpaths> 的值
                    def jacocoXmlReportPath = "target/jacoco_report/jacoco.xml"

                    sh "mvn sonar:sonar " +
                       "-Dsonar.projectKey=your_project_key " + // 替换为您的 SonarQube 项目 Key
                       "-Dsonar.sources=src/main/java " +
                       "-Dsonar.java.binaries=target/classes " + // 明确指定 Java 字节码目录
                       "-Dsonar.host.url=http://192.168.2.2:9000/ " + // 您的 SonarQube 服务器地址
                       "-Dsonar.login=admin " + // SonarQube 认证令牌或用户名
                       "-Dsonar.password=sonar " + // SonarQube 认证密码 (生产环境建议使用令牌)
                       "-Dsonar.coverage.jacoco.xmlReportPaths=${jacocoXmlReportPath}" // 关键:指定 JaCoCo XML 报告路径
                }
            }
        }
    }
}</sonar.coverage.jacoco.xmlreportpaths>

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

2025.08.06

3031

22

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

2026.01.26

517

25

spring boot框架优点
spring boot框架优点

spring boot框架的优点有简化配置、快速开发、内嵌服务器、微服务支持、自动化测试和生态系统支持。本专题为大家提供spring boot相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.05

731

5

spring框架有哪些
spring框架有哪些

spring框架有Spring Core、Spring MVC、Spring Data、Spring Security、Spring AOP和Spring Boot。详细介绍:1、Spring Core,通过将对象的创建和依赖关系的管理交给容器来实现,从而降低了组件之间的耦合度;2、Spring MVC,提供基于模型-视图-控制器的架构,用于开发灵活和可扩展的Web应用程序等。

2023.10.12

1455

7

Java Spring Boot开发
Java Spring Boot开发

本专题围绕 Java 主流开发框架 Spring Boot 展开,系统讲解依赖注入、配置管理、数据访问、RESTful API、微服务架构与安全认证等核心知识,并通过电商平台、博客系统与企业管理系统等项目实战,帮助学员掌握使用 Spring Boot 快速开发高效、稳定的企业级应用。

2025.08.19

5926

10

Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性
Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性

Spring Boot 是一个基于 Spring 框架的 Java 开发框架,它通过 约定优于配置的原则,大幅简化了 Spring 应用的初始搭建、配置和开发过程,让开发者可以快速构建独立的、生产级别的 Spring 应用,无需繁琐的样板配置,通常集成嵌入式服务器(如 Tomcat),提供“开箱即用”的体验,是构建微服务和 Web 应用的流行工具。

2025.12.22

436

5

Java Spring Boot 微服务实战
Java Spring Boot 微服务实战

本专题深入讲解 Java Spring Boot 在微服务架构中的应用,内容涵盖服务注册与发现、REST API开发、配置中心、负载均衡、熔断与限流、日志与监控。通过实际项目案例(如电商订单系统),帮助开发者掌握 从单体应用迁移到高可用微服务系统的完整流程与实战能力。

2025.12.24

680

18

Spring Boot企业级开发与MyBatis Plus实战
Spring Boot企业级开发与MyBatis Plus实战

本专题面向 Java 后端开发者,系统讲解如何基于 Spring Boot 与 MyBatis Plus 构建高效、规范的企业级应用。内容涵盖项目架构设计、数据访问层封装、通用 CRUD 实现、分页与条件查询、代码生成器以及常见性能优化方案。通过完整实战案例,帮助开发者提升后端开发效率,减少重复代码,快速交付稳定可维护的业务系统。

2026.02.11

425

24

Kotlin协程编程与Spring Boot集成实践
Kotlin协程编程与Spring Boot集成实践

本专题围绕 Kotlin 协程机制展开,深入讲解挂起函数、协程作用域、结构化并发与异常处理机制,并结合 Spring Boot 展示协程在后端开发中的实际应用。内容涵盖异步接口设计、数据库调用优化、线程资源管理以及性能调优策略,帮助开发者构建更加简洁高效的 Kotlin 后端服务架构。

2026.02.12

391

18

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习