插件开发进阶：Extension扩展配置、NamedDomainObjectContainer、插件与Task的交互、插件参数化配置

说实话，很多同学写Gradle插件，写到能跑就停了。但真正让插件变得好用、可复用、能给别人用的，恰恰是今天要聊的这些进阶能力。我个人习惯把插件开发分成两个阶段：第一阶段是“能用”，第二阶段是“好用”。今天的内容，就是帮你从“能用”跨到“好用”。

1. Extension扩展配置：让用户能配置你的插件

你想想看，一个插件如果所有行为都写死在代码里，那跟写死逻辑有什么区别？Extension就是给用户开的一个“后门”，让用户能在build.gradle里调整插件行为。

先看一个最简单的例子：

// 定义一个Extension类
open class MyPluginExtension {
    var version: String = "1.0.0"
    var enableLog: Boolean = false
    var outputDir: String = "build/output"
}

然后在插件里注册它：

class MyPlugin : Plugin<Project> {
    override fun apply(project: Project) {
        // 注册Extension，名字叫"myConfig"
        val extension = project.extensions.create(
            "myConfig", 
            MyPluginExtension::class.java
        )
        
        // 后续可以通过extension对象读取配置
        project.afterEvaluate {
            println("版本号: ${extension.version}")
            println("是否开启日志: ${extension.enableLog}")
        }
    }
}

用户在build.gradle里就可以这样用：

myConfig {
    version = "2.0.0"
    enableLog = true
}

2. NamedDomainObjectContainer：管理一组配置对象

这个玩意儿，说白了就是Gradle版的“对象集合管理器”。当你的插件需要让用户配置多个同类型的东西时——比如多个构建变体、多个签名配置、多个渠道——NamedDomainObjectContainer就是最佳选择。

为什么会用到它？举个例子：

// 假设你要让用户配置多个"渠道"
open class Channel(val name: String) {
    var apiKey: String = ""
    var enableFeature: Boolean = false
}

// 在Extension里声明Container
open class MyPluginExtension(project: Project) {
    val channels: NamedDomainObjectContainer<Channel> = 
        project.container(Channel::class.java) { name ->
            Channel(name)
        }
}

用户使用时：

myConfig {
    channels {
        huawei {
            apiKey = "abc123"
            enableFeature = true
        }
        xiaomi {
            apiKey = "def456"
            enableFeature = false
        }
    }
}

在插件里遍历这些配置：

project.afterEvaluate {
    extension.channels.all { channel ->
        println("渠道: ${channel.name}, API Key: ${channel.apiKey}")
    }
}

3. 插件与Task的交互：数据怎么传？

Extension只是配置，真正干活的是Task。那怎么把Extension里的数据传给Task呢？

我常用的方式有两种：

方式	适用场景	代码示例
构造函数注入	Task创建时就知道所有参数	project.tasks.register("myTask", MyTask::class.java, extension.version)
属性赋值	参数需要在配置阶段动态变化	task.version.set(extension.version)

看一个完整的例子：

abstract class MyTask : DefaultTask() {
    @get:Input
    abstract val version: Property<String>
    
    @get:Input
    abstract val enableLog: Property<Boolean>
    
    @TaskAction
    fun run() {
        println("执行任务，版本: ${version.get()}, 日志: ${enableLog.get()}")
    }
}

class MyPlugin : Plugin<Project> {
    override fun apply(project: Project) {
        val extension = project.extensions.create(
            "myConfig", 
            MyPluginExtension::class.java
        )
        
        project.tasks.register("myTask", MyTask::class.java) { task ->
            // 把Extension的值绑定到Task的属性上
            task.version.set(extension.version)
            task.enableLog.set(extension.enableLog)
        }
    }
}

4. 插件参数化配置：让插件更灵活

参数化配置，说白了就是让插件能根据不同的项目环境自动调整行为。我一般会从三个维度来设计：

• 项目级参数：通过Extension暴露给用户配置
• 环境级参数：通过系统属性或环境变量读取（比如debug/release）
• 默认值参数：插件内部定义的合理默认值

举个例子：

class MyPlugin : Plugin<Project> {
    override fun apply(project: Project) {
        val extension = project.extensions.create(
            "myConfig", 
            MyPluginExtension::class.java
        )
        
        // 读取系统属性作为覆盖
        val systemDebug = System.getProperty("myPlugin.debug")?.toBoolean()
        
        project.tasks.register("myTask", MyTask::class.java) { task ->
            // 优先级：系统属性 > Extension配置 > 默认值
            task.debug.set(systemDebug ?: extension.debug ?: false)
        }
    }
}

用户可以通过命令行覆盖：

./gradlew myTask -DmyPlugin.debug=true

知识体系结构图

总结一下

今天聊的这几个点，其实是一个递进关系：

• Extension让用户能配置你的插件
• NamedDomainObjectContainer让配置能管理多个对象
• 插件与Task的交互让配置真正生效
• 参数化配置让插件适应不同环境

嗯，这里要注意一点：不要一上来就把所有功能都做成可配置的。我个人的习惯是先写死，等发现确实需要灵活调整时，再逐步暴露成Extension。过度设计在插件开发里同样是个坑。

---

公众号:蓝海资料掘金营，微信deep3321