0

0

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

碧海醫心

碧海醫心

发布时间:2025-09-25 12:02:57

|

620人浏览过

|

来源于php中文网

原创

解决 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 报告的路径。这将有助于保持配置的一致性。

ShopWe 网店系统
ShopWe 网店系统

1.修正会员卡升级会员级别的判定方式2.修正了订单换货状态用户管理中心订单不显示的问题3.完善后台积分设置数据格式验证方式4.优化前台分页程序5.解决综合模板找回密码提示错误问题6.优化商品支付模块程序7.重写优惠卷代码8.优惠卷使用方式改为1卡1号的方式9.优惠卷支持打印功能10.重新支付模块,所有支付方式支持自动对账11.去掉规格库存显示12.修正部分功能商品价格显示4个0的问题13.全新的支

下载

    1.8
    UTF-8

    
    ${project.build.directory}/jacoco.exec
    
    ${project.build.directory}/jacoco_report

    
    ${project.build.directory}/surefire-reports
    ${jacoco.report.dir}/jacoco.xml

2.2 Maven Surefire 插件配置

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


    
        
        
            org.apache.maven.plugins
            maven-surefire-plugin
            2.22.2 
            
                
                ${surefireArgLine}
                
                ${sonar.surefire.reportsPath}
            
        
        
    

2.3 JaCoCo Maven 插件配置

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

  • prepare-agent:在测试运行之前准备 JaCoCo 代理,并将其配置为 Surefire 插件的
  • report:在测试运行之后,根据 .exec 文件生成可供 SonarQube 使用的 XML 格式报告。

    
        

        
        
            org.jacoco
            jacoco-maven-plugin
            0.8.6 
            
                
                
                    prepare-agent
                    
                        prepare-agent
                    
                    
                        
                        ${jacoco.exec.file}
                        
                        surefireArgLine
                    
                
                
                
                    report
                    post-unit-test 
                    
                        report
                    
                    
                        
                        ${jacoco.exec.file}
                        
                        ${jacoco.report.dir}
                        
                        
                            XML
                        
                    
                
            
        
    

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 中  的值
                    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 报告路径
                }
            }
        }
    }
}

相关专题

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

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

98

2025.08.06

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

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

135

2023.09.05

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

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

384

2023.10.12

Java Spring Boot开发
Java Spring Boot开发

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

61

2025.08.19

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

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

11

2025.12.22

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

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

101

2025.12.24

Java Maven专题
Java Maven专题

本专题聚焦 Java 主流构建工具 Maven 的学习与应用,系统讲解项目结构、依赖管理、插件使用、生命周期与多模块项目配置。通过企业管理系统、Web 应用与微服务项目实战,帮助学员全面掌握 Maven 在 Java 项目构建与团队协作中的核心技能。

0

2025.09.15

软件测试常用工具
软件测试常用工具

软件测试常用工具有Selenium、JUnit、Appium、JMeter、LoadRunner、Postman、TestNG、LoadUI、SoapUI、Cucumber和Robot Framework等等。测试人员可以根据具体的测试需求和技术栈选择适合的工具,提高测试效率和准确性 。

428

2023.10.13

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

7

2025.12.31

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 2.1万人学习

C# 教程
C# 教程

共94课时 | 5.7万人学习

Java 教程
Java 教程

共578课时 | 40万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号