Gradle指南之从Groovy迁移到Kotlin

前言

最近写 Kotlin 写的有些着魔了，正好看到 Gradle 4.10 版本支持使用 Kotlin DSL 构建脚本，而后心血来潮的尝鲜了下，由于刚出来，相关的资料实在太少，实际在迁移过程遇到很多问题，因此本文多是第一篇非官方迁移指导文档，但愿能够 save your time !

好了，话很少说，立刻开始迁移（踩坑）之旅

准备工做

1. 确认你的 IDE 是否最新版本，如不是，请升级到最新版本，本文是基于 Android Studio 3.1.4 版本进行的迁移

2. 迁移过程可能会出现一些意想不到的坑，建议找个空闲时间，买杯咖啡，而后作好......和丫死磕的准备 :)

不建议在实际项目中直接迁移，毕竟对于 Kotlin 的支持刚出来，还不太稳定，能够拉个分支或者弄个Demo工程体验一下。

开始迁移

步骤一. 升级 Gradle 4.10，建议经过如下命令进行升级：

./gradlew wrapper --gradle-version=4.10

须要等待一段下载时间，更新完成后，点击 sync 按钮，好了，不出意外，这里会遇到第一个问题，以下图：

咱们看下异常描述

Configuration on demand is not supported by the current version of the Android Gradle plugin since you are using Gradle version 4.6 or above. Suggestion: disable configuration on demand by setting org.gradle.configureondemand=false in your gradle.properties file or use a Gradle version less than 4.6.
复制代码

简单来说，Android Gradle 插件不支持基于新版本的 Gradle 的按需配置，异常描述里也提供两个解决办法：

1. 在 gradle.properties 增长 org.gradle.configureondemand=false 设置
2. 使用低于 Gradle 4.6 如下的版本

ok，首先降版本的方案确定被 pass 了，那就在咱们项目的 gradle.properties 加上一段配置貌似就能够了，大功告成，so easy ～

too navie，当你加上这段配置后，你会发现仍旧没法经过编译，错误依旧，为此，我专门检查了好几遍是否是少了个字母之类的，显然和这个没有一毛钱关系，这里不该该质疑本身做为一名 CV 战士的专业性。

实际上是被异常描述里给误导了，至少我直觉上是直接去修改工程里的 gradle.properties ，实际上，你须要修改的是 ${HOME}/.gradle/gradle.properties，固然也有更简单的方式，如图：

更多信息能够看这个回答：configuration-on-demand-is-not-supported

确认 sync 成功后，接下来就能够正式进行 Kotlin DSL 迁移了

步骤二. 使用 Kotlin 重写 Groovy

须要注意的地方是：

• Groovy DSL script files use the .gradle file name extension.
• Kotlin DSL script files use the .gradle.kts file name extension.

这里，我直接对原有的 build.gradle 脚本经过重命名的方式，修改成 build.gradle.kts 的后缀名，可能会提示有冲突，这里不用管，直接点击 continu，而后你会发现脚本里一片飙红，不用担忧，以前的 Groovy 语法在 Kotlin 报错了而已，推荐所有删掉，而后对照着用 Kotlin 从新写一遍，这样，会印象深入一些。

这里以一个比较简单的示例工程说明一下：

咱们分别对根目录的 settting.gradle 和 build.gradle 以及 app 目录下的 build.gradle 进行重写，以个人操做路径为例（不一样操做路径，可能遇到的问题不同）：

app/build.gradle -> setting.gradle -> build.gradle

说下几个须要注意的地方：

须要说明的一点，目前 Gradle 官方是支持 Groovy 脚本和 Kotlin 并存的，虽然我感受支持的并不太好

1. android 配置项没法自动被识别出来，如图所示：

解决办法：不用管，直接写一个配置项出来，而后 sync 同步一下就能够了，如图：

2. signconfig release 配置变动

signingConfigs {
    create("release") {
        storeFile = file("your keystore path")
        storePassword = "your password"
        keyAlias = "your alias"
        keyPassword = "your password"
    }
    getByName("debug") {
        storeFile = file("your keystore path")
        storePassword = "your password"
        keyAlias = "your alias"
        keyPassword = "your password"
    }
}
复制代码

3. 重命名生成的 apk 文件名

大部分开发当中应该都会有对输出的 apk 有重命名的需求，原来我在 Groovy 中是经过：

applicationVariants.all { variant ->
    variant.outputs.all {
        outputFileName = "${flavors}@app_$versionName}.apk"
    }
}
复制代码

迁移到 Kotlin 发现没法直接使用 outputFileName 的属性了

解决办法：显式转为具体实现类

android.applicationVariants.all {
    outputs.all {
        if (this is ApkVariantOutputImpl) {
            this.outputFileName = "$flavors@app_$versionName.apk"
        }
    }
}
复制代码

4. setting.gradle 配置指定 build.gradle.kts

rootProject.buildFileName = "build.gradle.kts"

    include("app")
复制代码

好了，若是你没遇到其余问题的话，到这里基本就已经大功告成了！

另外，本文的示例工程我已经放到 GitHub 上了，各位感兴趣的能够去看下～

总结

首先对于 Gradle 这么快就支持 Kotlin DSL，我仍是感到很惊喜的，其实，费了很多时间这么折腾了一下，实际上，若是必定要说做用的话，可能确实没有什么做用。

可是，我以为好处仍是要说一说的，对于使用 Kotlin 开发的小伙伴来讲，首先开发语言和构建语言统一了，以前想写构建脚本，还须要去学习 Groovy。如今直接能够愉快的用 Kotlin 去写 Gradle 构建脚本了。

示例 Demo

本文示例 Demo

参考资料：

官方迁移文档

其余参考一

其余参考二

关于我