如何为Gradle依赖应用instrument任务并替换编译源文件？

一、无需硬编码到每个依赖的插桩实现方式 #

要实现对所有项目依赖的自动插桩，不需要逐个模块配置，可通过以下两种简便方式全局统一管理：

1. 用subprojects块全局配置插桩任务 #

直接在根项目的build.gradle中使用subprojects块，为所有子项目自动创建插桩任务，无需逐个模块编写：

// 根项目build.gradle
subprojects {
    apply plugin: 'java'

    tasks.create('instrument') {
        group = 'instrumentation'
        description = 'Instrument Java source files'

        def srcDir = sourceSets.main.java.srcDirs.first()
        def destDir = layout.buildDirectory.dir('instrumented/java').get().asFile
        destDir.mkdirs()

        doLast {
            // 遍历原源码目录，调用插桩工具处理每个.java文件
            fileTree(srcDir).include('**/*.java').each { javaFile ->
                // 保持原目录结构，避免包路径错乱
                def relativePath = srcDir.toPath().relativize(javaFile.toPath())
                def destFile = new File(destDir, relativePath.toString())
                destFile.parentFile.mkdirs()
                
                // 替换为你的插桩工具调用逻辑
                // exec {
                //     commandLine 'your-instrument-tool', javaFile.absolutePath, destFile.absolutePath
                // }
            }
        }
    }

    // 让编译任务依赖插桩任务，确保先插桩再编译
    tasks.named('compileJava').configure {
        dependsOn tasks.named('instrument')
    }
}

这样所有子项目（包括你依赖的:common模块）都会自动生成instrument任务，无需手动逐个配置。

2. 自定义插件统一管理（适合复杂场景） #

如果后续需要扩展插桩逻辑，可创建自定义Gradle插件，把插桩任务的定义封装到插件中，再在根项目全局应用：

// 自定义插件代码（放在项目根目录的buildSrc/src/main/groovy下）
class InstrumentPlugin implements Plugin<Project> {
    void apply(Project project) {
        project.apply plugin: 'java'
        
        // 创建插桩任务
        def instrumentTask = project.tasks.create('instrument') {
            def srcDir = project.sourceSets.main.java.srcDirs.first()
            def destDir = project.layout.buildDirectory.dir('instrumented/java').get().asFile
            destDir.mkdirs()

            doLast {
                // 插桩逻辑同上
                fileTree(srcDir).include('**/*.java').each { javaFile ->
                    def relativePath = srcDir.toPath().relativize(javaFile.toPath())
                    def destFile = new File(destDir, relativePath.toString())
                    destFile.parentFile.mkdirs()
                    // 调用插桩工具
                }
            }
        }

        // 关联编译任务与插桩任务
        project.tasks.named('compileJava').configure {
            dependsOn instrumentTask
        }
    }
}

// 注册插件（在buildSrc/src/main/resources/META-INF/gradle-plugins/xxx.properties中配置）
// implementation-class=your.package.InstrumentPlugin

然后在根项目build.gradle中应用插件到所有子项目：

// 根项目build.gradle
subprojects {
    apply plugin: 'your.custom.instrument.plugin'
}

二、用插桩后的文件替代原文件编译 #

通过修改Gradle的sourceSets配置，让插桩后的目录优先级高于原源码目录，即可实现编译时自动使用插桩文件：

// 在根项目的subprojects块或自定义插件中添加
subprojects {
    // 调整源码集顺序，让插桩目录优先被读取
    sourceSets.main.java.srcDirs = [
        layout.buildDirectory.dir('instrumented/java'),
        sourceSets.main.java.srcDirs
    ]

    // 清理任务同时删除插桩目录
    tasks.named('clean').configure {
        delete layout.buildDirectory.dir('instrumented')
    }
}

这样Gradle编译时会先从build/instrumented/java查找文件，找不到的才会去原src/main/java目录，完美实现替代效果。

关键注意事项 #

• 插桩任务必须保证输出目录的文件结构与原源码目录完全一致，否则会出现包路径错误
• 确保插桩任务在compileJava之前执行（通过dependsOn关联），避免编译未插桩的原文件

内容的提问来源于stack exchange，提问作者Jonas L