Java多模块JaCoCo报告生成教程

文章小白一枚，正在不断学习积累知识，现将学习到的知识记录一下，也是将我的所得分享给大家！而今天这篇文章《Java多模块项目JaCoCo报告生成指南》带大家来了解一下##content_title##，希望对大家的知识积累有所帮助，从而弥补自己的不足，助力实战开发！

本文旨在解决 Java Spring Boot 多模块项目中使用 Gradle 和 JaCoCo 生成代码覆盖率报告时遇到的“The value for this file collection is final and cannot be changed”错误。我们将深入分析问题原因，并提供详细的解决方案，帮助开发者成功生成 JaCoCo 报告。

问题分析

在 Java Spring Boot 多模块项目中，尝试使用 JaCoCo 生成代码覆盖率报告时，可能会遇到以下错误：

The value for this file collection is final and cannot be changed

这个错误通常发生在配置 jacocoTestReport 任务时，试图在 doFirst 块中动态修改 executionData 集合。executionData 是一个文件集合，用于指定 JaCoCo 覆盖率数据的来源。Gradle 在配置阶段会确定这个集合，并且不允许在执行阶段修改它。

解决方案

要解决这个问题，我们需要避免在 doFirst 块中直接修改 executionData 集合。一种常用的解决方案是使用 executionData(files(...)) 方法来配置 executionData，而不是使用 executionData.setFrom(...)。

以下是一个可行的解决方案示例：

1. 在根项目的 build.gradle 文件中配置 JaCoCo 插件：

   plugins {
       id 'jacoco'
   }
   
   jacoco {
       toolVersion = "0.8.8" // 建议使用最新版本
   }

2. 在每个子项目的 build.gradle 文件中配置 jacocoTestReport 任务：

   tasks.register('jacocoTestReport', JacocoReport) {
       dependsOn test // 依赖于测试任务
   
       reports {
           html.enabled = true
           xml.enabled = true
           csv.enabled = false
       }
   
       // 指定 JaCoCo 覆盖率数据的来源
       executionData(files("${buildDir}/jacoco/test.exec"))
   
       sourceSets sourceSets.main.allSource
   
       classDirectories.setFrom(files(classDirectories.files.collect {
           fileTree(dir: it, exclude: ['**/model/**', '**/config/**']) //根据需要排除特定目录
       }))
   }

   说明：

   • dependsOn test: 确保在生成报告之前，测试任务已经执行完毕。
   • executionData(files("${buildDir}/jacoco/test.exec")): 指定 JaCoCo 覆盖率数据文件的位置。需要根据实际情况修改路径，通常是 buildDir/jacoco/test.exec。
   • sourceSets sourceSets.main.allSource: 指定源代码目录，JaCoCo 会根据这些目录生成覆盖率报告。
   • classDirectories.setFrom(...): 指定 class 文件目录，可用于排除特定的 package，提高报告的可读性。

3. 在根项目的 build.gradle 中创建聚合报告的任务：

   task jacocoRootReport(type: JacocoReport) {
       group = "Reporting"
       description = "Generates an aggregate report from all the subprojects"
   
       subprojects.each {
           executionData fileTree(dir: it.buildDir, includes: ['jacoco/test.exec'])
           sourceSets it.sourceSets.main.allSource
           classDirectories.from = files(it.classDirectories.files.collect {
               fileTree(dir: it, exclude: ['**/model/**', '**/config/**']) //根据需要排除特定目录
           })
       }
   
       reports {
           html.enabled = true
           xml.enabled = true
           csv.enabled = false
       }
   }

   说明：

   • subprojects.each: 遍历所有子项目，将每个子项目的覆盖率数据、源代码和 class 文件添加到聚合报告中。
   • executionData fileTree(...): 使用 fileTree 查找每个子项目的 test.exec 文件。
   • sourceSets it.sourceSets.main.allSource: 获取每个子项目的源代码。
   • classDirectories.from = files(...): 获取每个子项目的class文件目录，可用于排除特定的 package，提高报告的可读性。

4. 运行任务：

   在命令行中运行 gradle jacocoRootReport 命令，即可生成聚合的代码覆盖率报告。 报告将会在根项目的 build/reports/jacoco/jacocoRootReport/html 目录下生成。

注意事项

• JaCoCo 版本： 建议使用最新版本的 JaCoCo 插件，以获得更好的性能和功能。
• Gradle 版本： 确保 Gradle 版本与 JaCoCo 插件兼容。
• 测试任务依赖： jacocoTestReport 任务必须依赖于测试任务，以确保在生成报告之前，测试已经执行完毕。
• 文件路径： executionData 中指定的文件路径必须正确，否则 JaCoCo 无法找到覆盖率数据。
• 模块依赖： 确保模块之间的依赖关系正确配置，以便 JaCoCo 能够正确分析代码覆盖率。
• 排除特定目录: 可以通过 exclude 配置项排除特定的目录，例如 model 和 config 目录，以提高报告的可读性。
• JDK 版本: 推荐使用 JDK 8 或更高版本。

总结

通过上述步骤，我们可以成功地在 Java Spring Boot 多模块项目中使用 Gradle 和 JaCoCo 生成代码覆盖率报告，避免“The value for this file collection is final and cannot be changed”错误。 关键在于正确配置 executionData，避免在 doFirst 块中动态修改它。 使用 executionData(files(...)) 方法，并确保文件路径正确，即可解决问题。同时，合理配置 sourceSets 和 classDirectories 可以提高报告的准确性和可读性。

以上就是《Java多模块JaCoCo报告生成教程》的详细内容，更多关于的资料请关注golang学习网公众号！