更简化的 Kotlin DSL 属性赋值

Calendar
Anže Sodja
新功能

使 Kotlin DSL 成为新 Gradle 构建的默认值 的改进之一是使用 延迟属性 赋值的更简单方法。

在这篇博文中，我们将解释什么是延迟属性赋值以及如何在最新的 Gradle 版本中利用新的语法。

什么是延迟属性 API？

延迟属性 API 是 Gradle 的一项功能，它会延迟属性值的计算，直到需要它为止。这是为扩展和任务编写属性的推荐方法。

提供的一些好处包括

  • 解决配置顺序问题（不再需要 Project.afterEvaluate()）
  • 自动跟踪依赖项（无需 Task.dependsOn()）
  • 提供标准化访问（在 setter 或 getter 中没有自定义行为）
  • 减少属性声明的样板代码（没有字段和 setter，只有 getter）

要在自定义任务中使用延迟属性 API，请将原始类型替换为属性类型。例如：

abstract class MyTask : DefaultTask() {
    @get:Input
    var myProperty: String? = null

    @TaskAction
    fun run() {
        // Skipped for brevity
    }
}

变成

abstract class MyTask : DefaultTask() {
    @get:Input
    abstract val myProperty: Property<String>

    @TaskAction
    fun run() {
        // Skipped for brevity
    }
}

麻烦来了！

虽然延迟属性提供了很多好处，但它们可能会使使用 Kotlin DSL 配置属性变得有点冗长。

在 Groovy DSL 中，延迟属性可以使用简单的 = 赋值。

tasks.register("taskName", MyTask) {
    myProperty = "Constant string value"
}

然而，在 Kotlin DSL 中，为属性赋值需要使用冗长的 set(…) 方法。

tasks.register<MyTask>("taskName") {
    myProperty.set("Constant string value")
}

用户显然希望有一个更简单的语法，看起来更声明式。对 简洁且静态类型的 Property<T> 赋值 的请求是 GitHub 上投票最多的问题之一。由于 Kotlin 语言不支持重载赋值运算符，因此没有太多好的选择来改善这种情况。

由于冗长，一些插件作者发明了自定义 setter。这些 setter 以多种不同的方式实现，进一步降低了用户体验。

我们不想在使用延迟属性时强制使用更冗长的 DSL，也不想阻止在所有插件中使用延迟属性。

简单赋值的答案

对于使用延迟属性类型（例如 Property）的任务或扩展，Gradle 需要一种简单的方法来赋值。

从 Gradle 8.2 开始，现在可以使用 = 运算符为 Property 类型赋值，作为 Kotlin DSL 脚本中 set(T) 方法的直接替代方案。

冗长的选项

tasks.register<MyTask>("taskName") {
    // Using the set() method call
    myProperty.set("Constant string value")
}

变成

tasks.register<MyTask>("taskName") {
    // Using lazy property assignment
    myProperty = "Constant string value"
}

此语法还支持赋值延迟值，例如 set(Provider<T>) 方法。

tasks.register<MyTask>("taskName") {
    // otherTask.map() returns lazy value `Provider<T>`
    myProperty = otherTask.map { it.otherProperty }
}

Kotlin DSL 现在看起来好多了。作为奖励，这使得从 Groovy DSL 迁移到 Kotlin DSL 变得更容易，因为它减少了两种 DSL 之间的差异。

延迟属性赋值适用于类型为 Property 或 ConfigurableFileCollection 的仅 getter 属性。我们不建议插件作者为这些类型的属性实现自定义 setter。

与 JetBrains 的共同努力

如果没有与 Kotlin 团队的密切合作，实现延迟属性赋值是不可能的。

我们共同实现了一个 Kotlin 编译器插件，该插件提供了一个选项来重载最终属性的 = 赋值运算符。这类似于 Kotlin 语言对 其他运算符（如 +=）的支持。由于编写这样的插件需要更改 Kotlin 编译器，因此我们直到现在才能够实现此更改。

在内部，Gradle 使用新的编译器插件并提供重载 = 运算符以用于延迟类型的方法

fun <T> Property<T>.assign(value: T?) {
    this.set(value)
}

由于该功能是作为 Kotlin 编译器插件编写的，因此我们也获得了 Kotlin 语言的所有优势，包括静态类型、可发现性和出色的 IDE 集成。

我们还可以自豪地说，这是第一个外部贡献的 Kotlin 语言功能！新插件直接与 Kotlin 一起提供。

感谢 JetBrains 团队对该功能的支持和协作。

在 Gradle 8.2 中试用它

Gradle 在 Gradle 8.1 中添加了延迟属性赋值支持，作为 一项选择加入功能。Gradle 8.2 默认启用此功能，因此您可以在 *.gradle.kts 脚本中简单地使用它。

重要的是要注意，该功能仍被标记为孵化阶段。该功能可能会发生变化，尽管不太可能。我们不建议在发布的插件中使用此功能，直到它被标记为稳定（可能在 Gradle 8.3 中）。

延迟属性赋值在 IntelliJ 2022.3（推荐使用 2023.1.1 或更高版本）和 Android Studio Giraffe（或更高版本）中受支持。

IDE 集成存在三个已知问题

KT-56941 和 KT-56221 已在 IntelliJ 2023.1.1 中修复。

KTIJ-24390 将在未来的版本中修复。

结论

延迟属性赋值

  • 减少了 Kotlin DSL 的冗长性
  • 标准化任务和扩展属性访问
  • 简化了延迟属性 API 的使用
  • 帮助用户从 Groovy 迁移到 Kotlin

如果您想了解有关 Kotlin 延迟属性赋值的更多信息，请查看 Gradle Kotlin DSL 简介。

如果您正在将现有项目从 Groovy DSL 迁移到 Kotlin DSL，请务必阅读 迁移指南 并考虑使用延迟属性 API。

加入社区聊天（#kotlin-dsl 频道）和论坛，提出问题，分享经验，并为 Kotlin DSL 的开发做出贡献。您的反馈和贡献非常宝贵，对于塑造 Gradle 构建工具的未来至关重要。

讨论

相关帖子