如何创建带外部参数的Kotlin版Gradle自定义任务并注入参数？

问题1：能否创建基于外部参数执行其他任务的自定义任务？ #

完全可以。Gradle允许自定义任务根据外部传入的参数动态决定依赖的任务列表，通过任务依赖的方式关联其他任务更符合Gradle的增量构建机制，也能保证构建流程的规范性。

问题2：如何正确注入命令行参数？ #

你提供的原命令格式不符合Gradle规范，Gradle的项目属性参数需要通过-P前缀传递。正确的命令格式如下：

# Release版本带分发
./gradlew ci -Ptype=release -Pdistribution=true -Pversion=1.2.2
# Debug版本带分发
./gradlew ci -Ptype=debug -Pdistribution=true -Pversion=1.2.2

在Kotlin DSL中获取并使用参数 #

在build.gradle.kts中，你可以用Gradle的类型安全Property API定义参数，也可以直接通过project.properties读取，以下是完整实现示例：

// 定义类型安全的项目参数，同时设置默认值
val type by project.properties.creating(String::class) {
    convention("debug")
}
val distribution by project.properties.creating(Boolean::class) {
    convention(false)
}
val version by project.properties.creating(String::class) {
    convention(project.version.toString())
}

// 注册自定义ci任务
tasks.register("ci") {
    // 基础依赖：clean任务
    dependsOn(tasks.clean)

    // 根据type参数关联对应的assemble任务
    val assembleTaskName = if (type.get() == "release") "assembleRelease" else "assembleDebug"
    dependsOn(tasks.named(assembleTaskName))

    // 如果distribution为true，关联已有的分发任务（假设任务名为distribute）
    if (distribution.get()) {
        dependsOn(tasks.named("distribute"))
    }

    // 任务基础配置
    description = "CI流水线任务：执行clean、对应类型的assemble，按需执行分发"
    group = "CI"

    // 执行前的额外逻辑（比如设置项目版本）
    doFirst {
        project.version = version.get()
        println("启动CI流水线：版本=${version.get()}，构建类型=${type.get()}，是否分发=${distribution.get()}")
    }
}

关键说明 #

• 使用-P传递参数是Gradle的标准方式，能确保参数被项目正确识别
• 通过dependsOn关联任务比在任务逻辑中手动触发更合理，能保证Gradle的增量构建、任务执行顺序等特性正常工作
• 类型安全的Property API比直接读取project.properties更可靠，还能便捷设置默认值，避免参数未传递时的异常

内容的提问来源于stack exchange，提问作者Cosmin Mihu