如何在Gradle中为主源码集添加OpenClover插桩预处理任务？

这里有一套更贴合你需求的方案，直接复用主源码集的编译流程，不需要额外维护单独的clover源码集，同时支持通过开关一键开启/关闭插桩功能，完美适配「插桩→编译→打包」的主流程：

1. 核心配置思路 #

• 用一个可配置的开关变量控制插桩逻辑是否生效
• 将插桩任务整合到compileJava的前置流程中，直接修改主源码集的编译源为插桩后的代码
• 自动处理Clover的依赖和类路径配置，不影响常规编译逻辑

2. 完整Gradle配置片段 #

// 定义插桩开关，可通过gradle.properties或命令行参数覆盖（例如：./gradlew build -PenableClover=true）
ext.enableClover = project.hasProperty('enableClover') ? project.property('enableClover').toBoolean() : false

// 引入OpenClover依赖（如果还没配置的话）
configurations {
    cloverRuntime
}
dependencies {
    cloverRuntime 'com.atlassian.clover:clover:4.4.1' // 替换为你使用的版本
}

// 定义插桩任务：只在开关开启时生效
task cloverInstr(type: JavaExec, enabled: enableClover) {
    // 输入：主源码集的所有Java文件
    inputs.files sourceSets.main.allJava
    // 输出：插桩后的临时源码目录
    outputs.dir "$buildDir/clover-instr-sources"

    // 配置Clover插桩参数
    mainClass = 'com.atlassian.clover.CloverInstr'
    classpath = configurations.cloverRuntime
    args = [
        '--source', sourceSets.main.java.srcDirs.first().absolutePath,
        '--dest', outputs.files.singleFile.absolutePath,
        '--initstring', "$buildDir/clover.db" // Clover覆盖率数据存储文件
    ]
}

// 修改主编译任务的源码目录：开关开启时使用插桩后的代码，否则用原始源码
compileJava {
    if (enableClover) {
        dependsOn cloverInstr
        source = cloverInstr.outputs.files
    }
    // 确保Clover runtime依赖被加入编译类路径
    classpath += configurations.cloverRuntime
}

// 配置测试任务：开关开启时加入Clover类路径，用于生成覆盖率报告
test {
    if (enableClover) {
        classpath += configurations.cloverRuntime
        // 测试结束后生成覆盖率报告（可选，按需开启）
        doLast {
            JavaExec.execute {
                mainClass = 'com.atlassian.clover.reporters.html.HtmlReporter'
                classpath = configurations.cloverRuntime
                args = [
                    '--initstring', "$buildDir/clover.db",
                    '--output', "$buildDir/reports/clover"
                ]
            }
        }
    }
}

// 打包任务：开关开启时，打包的是插桩后的编译产物（和常规打包流程一致）
jar {
    if (enableClover) {
        dependsOn compileJava // 确保先完成插桩编译
    }
}

3. 关键细节说明 #

• 开关控制：默认关闭插桩，可通过./gradlew build -PenableClover=true命令开启，也可以在gradle.properties里添加enableClover=true永久开启
• 插桩逻辑：cloverInstr任务只在开关开启时执行，将主源码插桩后输出到临时目录，compileJava直接使用这个临时目录的代码编译，完全替代原始源码的编译流程
• 类路径处理：自动将Clover runtime依赖加入编译和测试类路径，确保插桩后的代码能正常运行并收集覆盖率数据
• 打包流程：开启插桩时，jar任务会打包插桩后的编译产物，和常规打包流程完全一致，不需要额外处理

4. 使用场景适配 #

• 运行Selenium测试收集覆盖率：开启开关后执行./gradlew test -PenableClover=true，测试结束后会在build/reports/clover生成HTML格式的覆盖率报告
• 常规编译打包：直接执行./gradlew build，完全走原始源码的编译流程，不受插桩逻辑影响

内容的提问来源于stack exchange，提问作者thi gg