Gradle插件怎么支持配置多个命名对象-java教程-PHP中文网

Gradle插件需用NamedDomainObjectContainer声明多命名对象Extension，因其支持按名注册/获取、类型安全及生命周期集成；普通Extension或ext无法实现flavor('name') { ... }合法DSL。

gradle插件怎么支持配置多个命名对象

Gradle插件中如何声明支持多个命名对象的Extension

Gradle插件要支持像 android { ... } 或 test { ... } 那样可配置多个同类型但不同名的块（例如 flavor { name = 'prod' } 和 flavor { name = 'dev' }），不能靠普通 Extension 直接实现——它默认只允许单例配置。必须用 NamedDomainObjectContainer。

NamedDomainObjectContainer 是 Gradle 提供的专用容器类型，专为“按名字注册、按名字获取”的对象集合设计，比如 sourceSets、configurations、tasks 内部都基于它
它要求每个对象实现 Named 接口（即提供 getName() 方法），且名称在容器内唯一
声明方式不是 extensions.create(...)，而是 extensions.create(..., NamedDomainObjectContainer.class, ...)

用户 DSL 写法会变成：

myPlugin {
  flavor('prod') {
    versionCode = 100
  }
  flavor('dev') {
    versionCode = 99
  }
}

为什么直接用 ext 或普通 Extension 不行

你可能会想：用 ext.flavors = [:] 或 ext { flavors = [] } 手动存 Map/List？这会导致三个硬伤：

DSL 不合法：Gradle 解析器不识别 flavor('prod') { ... } 这种调用，会报 Could not find method flavor() for arguments [...]
无类型安全：Map 里塞什么类型都行，IDE 无法补全，编译期不校验字段名或类型
无生命周期集成：无法自动触发 afterEvaluate 回调、无法参与 Gradle 的延迟配置（configuration avoidance）、不能被 tasks.withType(...) 动态绑定

实际编码时的关键步骤

以 Kotlin DSL 插件为例（Groovy 同理，只是语法略异）：

Gradle 9.8.0

下载

定义具体对象类，实现 Named：

abstract class Flavor : Named {
  abstract val name: String
  abstract val versionCode: Property<int>
  override fun getName(): String = name
}</int>

在插件 apply() 中注册容器：

project.extensions.create<nameddomainobjectcontainer>>(
  "flavor",
  project.objects.domainObjectContainer(Flavor::class.java)
)</nameddomainobjectcontainer>

确保容器支持 flavor('name') { ... } 语法：Gradle 会自动把字符串参数转为构造器调用，并注入闭包配置逻辑，前提是你的对象类有对应构造签名（如 Flavor(String name)）
后续读取时用 project.extensions.findByType(NamedDomainObjectContainer::class.java).named('prod')，而非硬编码 Map 查找

容易忽略的兼容性陷阱

多命名对象 Extension 看似灵活，但有几个边界情况常被跳过：

Gradle 7.0+ 强制要求容器中对象必须是 @CacheableTask 或 @Inject 构造的（否则构建缓存失效），所以 Flavor 类不能含非 final 字段或无参构造器
如果用户写了 flavor('prod') { ... } 又写了 flavor('prod') { ... } 两次，Gradle 默认会覆盖而非报错——需手动加 container.whenObjectAdded { ... } 检查重复
容器本身不参与序列化，若插件要导出配置给其他插件用，得显式暴露 container.getNames() 和 container.named(...) 调用结果，不能直接传 container 实例