使用Kotlin编写Gradle脚本

说明

Android应用开发中,离不开Gradle脚本的构建,它的重要性不言而喻,它是使用一种基于Groovy的特定领域语言(DSL)来声明项目设置,抛弃了基于XML的各种繁琐配置。很多人可能知道Gradle脚本使用Groovy语言来编写,但是可能并不会Groovy语言,只是记住固定的配置,比如:我们要依赖三方库,只需要这样配置即可:implementation 'androidx.appcompat:appcompat:1.0.2'

不懂Groovy语言不影响正常的使用,但是有时候我们想通过Gradle脚本来实现一些特殊的功能,比如:打包后自动上传到蒲公英,方便测试团队测试,以及使用Gradle来记录每个版本的更新信息并上传到服务器等等,这时候需要我们自己来实现了,这就需要我们了解Groovy语言。当然因为Groovy语言它是对Java代码进行了扩展,我们完全可以使用Java代码来编写,但是语法就显得有些啰嗦。而学习Groovy语言是需要一定成本的,并且在Android Studio是没有语法提示的。

Kotlin Meets Gradle

Gradle团队为Gradle开发了一种新的基于Kotlin的构建语言,称之为Gradle Script Kotlin,从Gradle 3.0开始支持。也就是说我们可以使用Kotlin来编写Gradle脚本了,当使用Kotlin来编写Gradle脚本的时候一切都变得美好了:

  • 脚本代码可以自动补全了
  • 源码之间可以互相跳转了
  • 插件源码更容易看懂了
  • 支持重构了

官方说明

使用Kotlin编写Gradle

下面我们就用kotlin来改造项目中的Gradle脚本Gradle Script Kotlin脚本以.gradle.kts后缀结尾。所以,我们需要将工程根目录gradle文件更名.gradle.kts

1.更改settings.gradle

将工程根目录settings.gradle更名为settings.gradle.kts


更改后文件报错了,我们需要改成Kotlin语法,这里就是一个方法调用。修改后如下所示:

可以看到,参数含义自动提示了。

2.更改根目录下的build.gradle

同理,先修改扩展名,再改成Kotlin语法,修改后的文件如下所示:

由于我们修改了build.gradle的文件名,为了保证工程可以使用这个脚本,需要在settings.gradle.kts中添加一行代码,让Gradle知道使用build.gradle.kts脚本构建。

include(":app")
rootProject.buildFileName = "build.gradle.kts"

3.修改app模块中的build.gradle

操作跟上面的步骤一样,修改后的文件内容如下所示:

从上面的示例中我们可以看到修改成gradle.kts后,语法有了提示,并且点击可以直接跳转到源码。并且更加容易理解每一步的配置。

使用Gradle Script Kotlin后,我们可以用Kotlin来开发插件或者编写脚本,如果开发插件,可以改成下面的写法了:

class MyPlugin : Plugin<Project> {

    override fun apply(project: Project) {
        project.run {
            tasks {
                register("myCopyTask", Copy::class) {
                    group = "sample"
                    from("build.gradle.kts")
                    into("build/copy")
                }
            }
        }
    }
}

有没有感觉很亲切。更多示例请查看官方Demo

Kotlin实战