如何为Gradle插件新增的项目属性提供类型安全访问器？

问题背景 #

开发的Gradle插件通过project.extra定义了项目属性：

// Common插件代码
var copyrightDate: String? by project.extra

但在构建脚本中直接访问该属性时：

plugins {
    `lifecycle-base`
    id("acme.common")
}

copyrightDate = "2022"

会触发编译错误：

e: path\to\build.gradle.kts:7:1: Unresolved reference: copyrightDate

目前只能通过在构建脚本中重复声明属性临时解决，但多项目场景下这种方式冗余繁琐，希望实现类似Java插件java {}的类型安全访问机制，无需重复声明。

解决方案 #

1. 定义类型安全的扩展类 #

创建扩展类封装属性，替代直接使用project.extra：

// 插件代码中的扩展类
open class CommonPluginExtension(project: Project) {
    var copyrightDate: String? by project.extra
}

2. 在插件中注册扩展 #

在插件的apply方法中，将扩展类注册到项目并指定扩展名称（例如common）：

// Common插件实现类
class CommonPlugin : Plugin<Project> {
    override fun apply(project: Project) {
        // 注册扩展到项目
        project.extensions.create("common", CommonPluginExtension::class.java, project)
    }
}

3. 构建脚本中通过扩展块访问属性 #

现在在构建脚本里，就可以像Java插件的java {}一样，通过类型安全的扩展块访问属性：

plugins {
    `lifecycle-base`
    id("acme.common")
}

common {
    copyrightDate = "2022"
}

可选：实现顶级属性直接访问 #

如果希望直接使用顶级属性名（如copyrightDate）而非扩展块，可以为Project类添加扩展属性：

// 插件代码中添加Project扩展属性
val Project.copyrightDate: String?
    get() = extensions.getByType(CommonPluginExtension::class.java).copyrightDate

var Project.copyrightDate: String?
    set(value) {
        extensions.getByType(CommonPluginExtension::class.java).copyrightDate = value
    }

注意：这种方式可能存在属性命名冲突风险，推荐优先使用扩展块的方式。

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