Gradle Kotlin DSL 的 accessors 生成问题

朱雀 2022-04-25 07:40 301阅读 0赞

### 概要 ###

如果你想用 gradle kotlin DSL，那么请注意，accessors 的支持从 0.8.0 开始（gradle 3.5），后续也做了一些完善和更新，目前已经默认开启了这一项功能。使用时由于 accessors 是动态生成的，因此要注意使用 `plugins{ ...}` 可以直接触发 accessors 的动态生成，其他情况下就比较麻烦了。

### 正文 ###

昨天也是手欠，非要用 Gradle Kotlin DSL 构建工程，还看到现在连 settings.gradle 也支持用 kts 了，于是乎：

![640?wx\_fmt=jpeg][640_wx_fmt_jpeg]

不过这个需要 Gradle 的版本在 4.4 以上，gradle-wrapper.properties 的版本修改为：

1.  `...`
2.  `distributionUrl=https\://services.gradle.org/distributions/gradle-4.4-all.zip`

看上去也没啥毛病啊，我的 build.gradle.kts 是这个样子：

1.  `buildscript {`
2.  `   var kotlin_version: String by extra`
3.  `   kotlin_version = "1.2.10"`
4.  ``
5.  `   repositories {`
6.  `       mavenCentral()`
7.  `   }`
8.  ``
9.  `   dependencies {`
10. `       classpath(kotlin("gradle-plugin", kotlin_version))`
11. `   }`
12. `}`
13. ``
14. `apply {`
15. `   plugin("java")`
16. `   plugin("kotlin")`
17. `}`
18. ``
19. `val kotlin_version: String by extra`
20. ``
21. `repositories {`
22. `   mavenCentral()`
23. `}`
24. ``
25. `dependencies {`
26. `   compile(kotlin("stdlib"))`
27. `}`

然而一运行，出事儿了，compile 不识别。。

1.  `e: .../kotlinspecificsJvm/app/build.gradle.kts:42:5: Unresolved reference: compile`

![640?wx\_fmt=jpeg][640_wx_fmt_jpeg 1]

额，这就尴尬了，哪儿说理去。。由于 Kotlin 是静态语言，能够在这个地方写出来 compile 那么一定是定义了这个方法，就像：

1.  `   dependencies {`
2.  `       classpath(kotlin("gradle-plugin", kotlin_version))`
3.  `   }`

这里的 classpath 就是一个方法：

1.  `class ScriptHandlerScope(scriptHandler: ScriptHandler) : ScriptHandler by scriptHandler {`
2.  `   ...`
3.  `   fun DependencyHandler.classpath(dependencyNotation: Any): Dependency =`
4.  `       add(CLASSPATH_CONFIGURATION, dependencyNotation)`
5.  `}`

那么 compile 的定义哪儿去了？其实，compile 和 classpath 不一样，前者是构建插件的 configuration，而 classpath 则是 gradle 本身的一个方法。

那么 compile 到底是什么，gradle 自己没有定义就不能用了吗？那倒也不是，gradle kotlin DSL 会帮我们根据插件的 configuration 定义生成这样的代码。这在 gradle kotlin dsl 0.8.0 中就做了支持，官方把他们称作：**Type-safe accessors**，这个版本也跟随 gradle 3.5 发版。

我本来用 4.0 用得好好的，非要因为 settings.gradle.kts 改用了 4.4 的版本，导致出现了这个问题，我就想难道新版本做了调整？于是我又换了 4.5、4.5.1，果然问题还是有。

后来查了一下官方 demo "hello-kotlin"：

1.  `plugins {`
2.  `   application`
3.  `   kotlin("jvm") version "1.2.0"`
4.  `}`
5.  ``
6.  `application {`
7.  `   mainClassName = "samples.HelloWorldKt"`
8.  `}`
9.  ``
10. `dependencies {`
11. `   compile(kotlin("stdlib"))`
12. `}`
13. ``
14. `repositories {`
15. `   jcenter()`
16. `}`

对比了一下才发现，原来人家用的 是 `plugins{}` 这种写法，而我的工程仍然用的是 `apply plugin` 的写法，就这么点儿区别。。难道真的是因为这个？

果然，我把我的配置修改了一下：

1.  `- apply {`
2.  `-    plugin("java")`
3.  `-    plugin("kotlin")`
4.  `- }`
5.  ``
6.  `+ plugins {`
7.  `+    java`
8.  `+    kotlin("jvm") version "1.2.10"`
9.  `+ }`

这时候果然没问题了：

![640?wx\_fmt=jpeg][640_wx_fmt_jpeg 2]

而且我们也能找到 compile 的定义：

1.  ``fun DependencyHandler.`compile`(dependencyNotation: Any): Dependency =``
2.  `   add("compile", dependencyNotation)`

原来，这些 gradle 帮我们动态生成的 accessors，生成的时机就是 `plugins{}` 调用之后。也就是说我们需要使用这种方式来应用插件才会生成上述的方法。

> 详细说明在 gradle kotlin DSL 0.8.0 的更新说明当中：https://github.com/gradle/kotlin-dsl/releases/tag/v0.8.0 ，不过其中提到的 gskGenerateAccessors 我在 gradle 4.5 当中已经找不到了。

### 小结 ###

kotlin 和 groovy 也算是各有所长，如果我们对于 gradle 的语法非常熟悉，那么我个人认为用 groovy 写 DSL 倒也灵活，kotlin 的约束毕竟多一些——而这也正是 Kotlin DSL 的优点，静态类型安全有保障。。

--------------------

欢迎关注微信公众号 Kotlin

![640?wx\_fmt=jpeg][640_wx_fmt_jpeg 3]

[640_wx_fmt_jpeg]: /images/20220125/5ec6035f58424b4b91495ee414be7c33.png
[640_wx_fmt_jpeg 1]: /images/20220125/8b2354ae863549cf8fda54fefca7ca7b.png
[640_wx_fmt_jpeg 2]: /images/20220125/cdad2608e84c4da5b0721607b1697b86.png
[640_wx_fmt_jpeg 3]: /images/20220125/abd74ac62d074a0b909028ce2310434f.png