Gradle指南之從Groovy遷移到Kotlin

汪海游龍發表於2018-08-30

前言

最近寫 Kotlin 寫的有些著魔了，正好看到 Gradle 4.10 版本支援使用 Kotlin DSL 構建指令碼，然後心血來潮的嚐鮮了下，因為剛出來，相關的資料實在太少，實際在遷移過程遇到不少問題，所以本文可能是第一篇非官方遷移指導文件，希望可以 save your time !

好了，話不多說，馬上開始遷移（踩坑）之旅

準備工作

確認你的 IDE 是否最新版本，如不是，請升級到最新版本，本文是基於 Android Studio 3.1.4 版本進行的遷移
遷移過程可能會出現一些意想不到的坑，建議找個空閒時間，買杯咖啡，然後做好......和丫死磕的準備 :)

不建議在實際專案中直接遷移，畢竟對於 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 的按需配置，異常描述裡也提供兩個解決辦法：

在 gradle.properties 增加 org.gradle.configureondemand=false 設定
使用低於 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 構建指令碼了。

Gradle指南之從Groovy遷移到Kotlin

前言

準備工作

開始遷移

總結

示例 Demo

參考資料：

關於我

相關文章