Gradle原地处理文件缓存任务问题：输入输出文件注解冲突

核心问题分析 #

你需要编写Gradle插件原地修改package.json补全缺失键，同时希望启用构建缓存，但Gradle不允许同一文件同时标记@InputFile和@OutputFile，分开标记又会触发“重叠输出”导致缓存失效。

可行解决方案 #

1. 用增量任务处理（推荐） #

通过IncrementalTaskInputs实现增量构建，规避输入输出重叠问题，同时让Gradle基于输入文件哈希判断是否命中缓存。

示例代码：

abstract class ProcessPackageJsonTask extends DefaultTask {
    @InputFile
    final RegularFileProperty packageJson = project.objects.fileProperty()

    @TaskAction
    void execute(IncrementalTaskInputs inputs) {
        def file = packageJson.get().asFile
        // 增量构建且文件未变更时直接跳过
        if (inputs.incremental && !inputs.outOfDateFiles.contains(file)) {
            return
        }
        // 读取并修改package.json
        def json = new JsonSlurper().parse(file)
        // 补全缺失键示例：添加默认scripts
        if (!json.scripts) {
            json.scripts = [build: "npm run build"]
        }
        // 写回文件
        new JsonBuilder(json).writeTo(file)
    }
}

关键逻辑：

• 仅标记@InputFile，通过IncrementalTaskInputs判断文件是否需要更新
• 文件修改后哈希稳定时，后续构建会直接命中缓存，无需重复执行

2. 复制-修改-替换的迂回方案 #

严格遵循Gradle输入输出模型，先复制原文件到临时位置修改，再替换原文件，彻底避免重叠问题：

abstract class ProcessPackageJsonTask extends DefaultTask {
    @InputFile
    final RegularFileProperty inputPackageJson = project.objects.fileProperty()

    @OutputFile
    final RegularFileProperty outputPackageJson = project.objects.fileProperty()

    @TaskAction
    void execute() {
        def inputFile = inputPackageJson.get().asFile
        def outputFile = outputPackageJson.get().asFile
        // 复制原文件到输出位置
        project.copy {
            from inputFile
            into outputFile.parentFile
            rename { outputFile.name }
        }
        // 修改输出文件
        def json = new JsonSlurper().parse(outputFile)
        // 补全缺失键示例：添加默认devDependencies
        if (!json.devDependencies) {
            json.devDependencies = ["typescript": "^5.0.0"]
        }
        new JsonBuilder(json).writeTo(outputFile)
    }
}

配置任务时，让outputPackageJson指向原package.json即可，此方式虽多一步复制，但完美适配构建缓存规则。

关于@Incremental的说明 #

@Incremental是用来标记任务支持增量构建的注解（Gradle 5.0+），需配合IncrementalTaskInputs参数使用。它的核心作用是让任务只处理变化的文件，对于单个文件原地修改的场景，主要用来判断文件是否变更，从而决定是否执行修改逻辑，无需额外标记@OutputFile即可利用构建缓存。

内容的提问来源于stack exchange，提问作者Martin Vysny