使用 Jacoco 在 Java 多模块项目中生成代码覆盖率报告(覆盖率,生成,多模,代码,报告.......)

本文旨在解决在使用 Gradle 构建的 Java Spring Boot 多模块项目中，集成 Jacoco 代码覆盖率报告时遇到的 "The value for this file collection is final and cannot be changed" 错误。我们将分析问题原因，并提供有效的解决方案，帮助开发者顺利生成代码覆盖率报告。

问题分析

在 Gradle 多模块项目中，当尝试配置 Jacoco 插件以生成代码覆盖率报告时，可能会遇到 "The value for this file collection is final and cannot be changed" 错误。 这个错误通常发生在尝试在 jacocoTestReport 任务中动态地添加或修改 executionData 文件集合时。 根本原因是 Gradle 的任务配置在配置阶段完成后，某些属性会被认为是不可变的，尝试修改这些属性会导致此错误。

解决方案

解决此问题的关键在于避免在任务执行阶段修改被认为是“final”的文件集合。以下提供几种解决方案：

1. 延迟配置 executionData：

不要在 doFirst 块中动态设置 executionData，而是在配置阶段就确定所有需要包含的执行数据文件。可以通过遍历子项目并在配置时构建一个包含所有执行数据文件的集合来实现。

jacocoTestReport {
    reports {
        html.enabled = true
        xml.enabled = true
        csv.enabled = false
    }

    executionData(files: project.rootProject.allprojects.collect {
        it.fileTree(dir: "${it.buildDir}", includes: ['jacoco/testDebugUnitTest.exec', 'jacoco/test.exec'])
    })
}

此方法在配置阶段就确定了所有需要包含的 .exec 文件，避免了在任务执行阶段修改文件集合。

2. 使用 project.evaluationDependsOnChildren() 确保子项目配置完成：

在根项目的 build.gradle 文件中，添加 project.evaluationDependsOnChildren() 确保在评估根项目之前，所有子项目都已配置完成。这可以确保在配置 jacocoTestReport 任务时，子项目的 test 任务已经存在，并且可以正确地收集执行数据。

// 根项目的 build.gradle
project.evaluationDependsOnChildren()

subprojects {
    apply plugin: 'java' // or 'org.springframework.boot'
    apply plugin: 'jacoco'

    jacocoTestReport {
        reports {
            html.enabled = true
            xml.enabled = true
            csv.enabled = false
        }
    }
}

3. 自定义 JacocoReport 任务类型：

燕雀光年

一站式AI品牌设计平台，支持AI Logo设计、品牌VI设计、高端样机设计、AI营销设计等众多种功能

68 查看详情

创建一个自定义的 JacocoReport 任务类型，并在其中处理执行数据的收集。

import org.gradle.testing.jacoco.tasks.JacocoReport

task jacocoTotalReport(type: JacocoReport) {
    dependsOn = subprojects.test

    reports {
        html.enabled = true
        xml.enabled = true
        csv.enabled = false
    }

    sourceSets = files(subprojects.sourceSets.main.allSource.files)
    classDirectories = files(subprojects.sourceSets.main.output.classesDirs)
    executionData = files(project.rootProject.allprojects.collect {
        it.fileTree(dir: "${it.buildDir}", includes: ['jacoco/testDebugUnitTest.exec', 'jacoco/test.exec'])
    })
}

这种方法将执行数据收集的逻辑封装在自定义任务中，使配置更加清晰。

4. 确保 Jacoco 插件版本一致：

确保所有模块和根项目都使用相同版本的 Jacoco 插件。版本不一致可能导致兼容性问题，从而引发各种错误。

plugins {
    id 'jacoco' version '0.8.8' // 使用最新稳定版本
}

allprojects {
    apply plugin: 'jacoco'

    jacoco {
        toolVersion = "0.8.8"
    }
}

示例代码（推荐）：

以下是一个结合了延迟配置和确保子项目配置完成的示例，该示例通常能解决 "The value for this file collection is final and cannot be changed" 错误。

// 根项目的 build.gradle
project.evaluationDependsOnChildren()

subprojects {
    apply plugin: 'java' // or 'org.springframework.boot'
    apply plugin: 'jacoco'

    jacoco {
        toolVersion = "0.8.8"
    }

    jacocoTestReport {
        reports {
            html.enabled = true
            xml.enabled = true
            csv.enabled = false
        }
        executionData(files: fileTree(dir: "$buildDir", includes: ['jacoco/testDebugUnitTest.exec', 'jacoco/test.exec']))
    }
}

注意事项

• 确保 test 任务已经成功执行，并且生成了 .exec 文件。
• 检查 build.gradle 文件中是否存在其他可能修改 executionData 的配置。
• 使用 Gradle 的 --stacktrace 或 --info 选项运行构建，以获取更详细的错误信息。

总结

在 Gradle 多模块项目中集成 Jacoco 代码覆盖率报告时，需要注意 Gradle 的任务配置机制，避免在任务执行阶段修改被认为是“final”的文件集合。 通过延迟配置 executionData，确保子项目配置完成，使用自定义任务类型，以及确保 Jacoco 插件版本一致等方法，可以有效地解决 "The value for this file collection is final and cannot be changed" 错误，并成功生成代码覆盖率报告。 希望本文能够帮助你顺利地在 Java 多模块项目中集成 Jacoco 代码覆盖率报告。

以上就是使用 Jacoco 在 Java 多模块项目中生成代码覆盖率报告的详细内容，更多请关注资源网其它相关文章！

相关标签： java html app csv ai Java spring spring boot for 封装 Collection this gradle 大家都在看： 如何用Java开发简单的问卷调查系统 生成多模块 Java 项目中 JaCoCo 报告失败的解决方案 Java中对象比较的核心原则是什么 Java安装过程中遇到路径过长怎么办 如何用Java实现简单的计算器程序