如何使用Gradle的WriteProperties API编写Properties文件？

核心问题分析 #

你之前的尝试主要是对Gradle任务类型的调度、配置方式理解有误，以下是几种正确的实现方案：

方案1：直接定义WriteProperties类型任务（最推荐） #

这是Gradle官方推荐的方式，直接声明任务类型为WriteProperties，配置参数后执行任务即可生成文件：

// 定义一个专门的写入Properties任务
task writeProperties(type: WriteProperties) {
    // 明确指定输出文件路径（基于项目根目录）
    outputFile = layout.projectDirectory.file('prop.properties')
    // 设置文件编码
    encoding = 'UTF-8'
    // 单个添加键值对
    property('TEST', 42)
    // 批量添加键值对
    properties = [APP_NAME: 'Demo', ENV: 'development']
}

执行命令：./gradlew writeProperties，即可在项目根目录生成prop.properties文件。

你的第3、4种尝试本质上是正确的，但可能因为未执行对应任务或文件路径不明确导致失败：

• 第3种中writeProperty.dependsOn myTask意味着执行writeProperty会先跑myTask，但执行myTask不会触发写入；
• 第4种中myTask.finalizedBy writeProperty，执行myTask会在最后自动执行writeProperty，若未生成文件，建议把file('prop.properties')替换为layout.projectDirectory.file('prop.properties')明确路径。

方案2：在现有任务的doLast块中触发写入 #

如果需要在自定义任务的逻辑完成后执行写入，需通过注册临时任务并主动执行：

task myTask {
    doLast {
        // 注册临时的WriteProperties任务
        def tempWriteTask = tasks.register('tempWriteProps', WriteProperties) {
            outputFile = layout.projectDirectory.file('prop.properties')
            encoding = 'UTF-8'
            property('TEST', 42)
        }
        // 执行该临时任务
        tempWriteTask.get().execute()
    }
}

执行./gradlew myTask即可完成自定义逻辑+Properties写入。

方案3：在自定义插件中使用WriteProperties #

正确的插件写法需要明确指定任务类型为WriteProperties，而非嵌套闭包：

class MyPlugin implements Plugin<Project> {
    void apply(Project project) {
        // 注册WriteProperties类型任务
        def writeTask = project.tasks.register('writeProperty', WriteProperties) {
            outputFile = project.layout.projectDirectory.file('prop.properties')
            encoding = 'UTF-8'
            properties = [TEST: 42]
        }
        // 注册自定义任务
        def myTask = project.tasks.register('myTask') {
            doLast {
                println("执行自定义任务逻辑")
            }
        }
        // 配置依赖：执行writeProperty前先跑myTask
        writeTask.configure { dependsOn(myTask) }
    }
}
apply plugin: MyPlugin

执行./gradlew writeProperty即可触发任务链+写入操作。

你之前的错误点总结 #

1. 方案1：仅在doLast中配置WriteProperties闭包，但未触发执行逻辑，Gradle不会自动处理；
2. 方案2：语法错误，def writer by register不是Gradle任务注册的正确写法；
3. 方案5：在插件中创建任务时未指定类型为WriteProperties，仅嵌套闭包无法生成有效任务。

内容的提问来源于stack exchange，提问作者Alex Efron