本文旨在解决 Gradle 构建的多模块 Java 项目中，启用 JaCoCo 代码覆盖率报告时出现的“The value for this file collection is final and cannot be changed”错误。我们将分析问题原因，并提供有效的解决方案，帮助开发者成功生成 JaCoCo 报告。
在多模块的 Java 项目中使用 JaCoCo 生成代码覆盖率报告时，可能会遇到 The value for this file collection is final and cannot be changed 错误。 这通常发生在尝试在 jacocoTotalReport 任务中动态添加执行数据文件时。 这是因为 JaCoCo 任务的输入文件集合在配置阶段已经被确定，在执行阶段再尝试修改就会导致错误。
问题分析
该错误表明在任务执行期间，尝试修改已经被标记为“final”的文件集合。 在 JaCoCo 的上下文中，这通常意味着在配置阶段之后，试图向 executionData 属性添加新的执行数据文件。
立即学习“Java免费学习笔记（深入）”；
解决方案
解决此问题的关键在于在配置阶段正确地设置 executionData 属性，而不是在执行阶段动态修改它。以下是一种推荐的解决方案：
- 在根项目的 build.gradle 文件中配置 JaCoCo 报告任务：
plugins {
id 'jacoco'
}
subprojects {
apply plugin: 'java'
apply plugin: 'jacoco'
jacoco {
toolVersion = "0.8.8"
}
dependencies {
testImplementation 'org.junit.jupiter:junit-jupiter-api:5.8.1'
testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.8.1'
}
test {
useJUnitPlatform()
}
jacocoTestReport {
reports {
html.enabled = true
xml.enabled = true
csv.enabled = false
}
}
}
task jacocoRootReport(type: JacocoReport) {
dependsOn = subprojects.jacocoTestReport
reports {
html.enabled = true
xml.enabled = true
csv.enabled = false
}
sourceSets = files(subprojects.sourceSets.main.allSource)
classDirectories = files(subprojects.sourceSets.main.output)
executionData = files(subprojects.jacocoTestReport.executionData)
}-
解释：
- jacocoRootReport 任务的类型是 JacocoReport，它依赖于所有子项目的 jacocoTestReport 任务。
- sourceSets 配置包含所有子项目的源代码集。
- classDirectories 配置包含所有子项目的类文件目录。
- 关键部分： executionData 配置包含所有子项目的 jacocoTestReport 任务的 executionData 输出。 这确保了在配置阶段，JaCoCo 报告任务已经知道所有需要包含的执行数据文件。
-
运行报告：
运行 gradle jacocoRootReport 命令来生成整个项目的 JaCoCo 报告。
注意事项
- 确保所有子项目都应用了 jacoco 插件，并且配置了 jacocoTestReport 任务。
- toolVersion 属性应与您使用的 JaCoCo 版本匹配。
- 根据您的项目结构和测试框架，可能需要调整 sourceSets 和 classDirectories 的配置。
- 如果子项目没有测试，可以考虑有条件地应用 JaCoCo 插件或跳过该子项目的报告生成。
总结
通过在配置阶段正确地设置 executionData 属性，可以避免 The value for this file collection is final and cannot be changed 错误，并成功生成多模块 Java 项目的 JaCoCo 代码覆盖率报告。 关键在于理解 JaCoCo 任务的生命周期，并在正确的阶段配置输入文件集合。 使用 files(subprojects.jacocoTestReport.executionData) 能够在配置阶段收集所有子项目的执行数据，从而避免动态修改文件集合的问题。
