2. 程式人生 > >Android Gradle指令碼從Groovy遷移到Kotlin DSL

Android Gradle指令碼從Groovy遷移到Kotlin DSL

阿新 • • 發佈：2020-01-15

Android Gradle從Groovy遷移到Kotlin

Android專案用Gradle構建, 其指令碼語言之前是Groovy, 目前也提供了Kotlin的支援, 所以可以遷移到Kotlin.

官方的遷移文件: Migrating build logic from Groovy to Kotlin
說明的是更通用的步驟.

本文通過一個具體的Android專案來舉例如何遷移, 文後附有sample.

名詞概念解釋

  • Gradle: 自動化構建工具. 平行產品: Maven.
  • Groovy: 語言, 編譯後變為JVM byte code, 相容Java平臺.
  • DSL: Domain Specific Language, 領域特定語言.
  • Groovy DSL: Gradle的API是Java的, Groovy DSL是在其之上的指令碼語言. Groovy DSL指令碼檔案字尾: .gradle.
  • Kotlin DSL: 和前者類似, 同樣根據Gradle的Java API構建, 只是替換了語言: Groovy -> Kotlin. Kotlin DSL指令碼檔案字尾: .gradle.kts.

為什麼要遷移

優點:

  • 可以使用Kotlin, 開發者可能對這個語言更熟悉更喜歡.
  • IDE支援更好, 自動補全提示, 重構, imports等.
  • 型別安全: Kotlin是靜態型別.
  • 不用一次性遷移完: 兩種語言的指令碼可以共存, 也可以互相呼叫.

缺點:

  • 據說Kotlin DSL會比Groovy DSL稍微慢一點: https://github.com/gradle/kotlin-dsl-samples/issues/902.

遷移步驟

Step 0: 環境支援

Kotlin DSL在Android Studio上是全面支援的. 確保使用的IDE版本較新.

使用最新版的Gradle, 這樣會包含最新版的Kotlin DSL.

Step 1: 把單引號替換為雙引號

這一步利用IDE的檔案內搜尋替換功能, 在想要改的.gradle檔案中, 全域性替換'到"就行.

比如:

    dependencies {
        classpath 'com.android.tools.build:gradle:3.5.3'
    }

變成了:

    dependencies {
        classpath "com.android.tools.build:gradle:3.5.3"
    }

這一步的改動可見:
https://github.com/mengdd/KotlinDSLSample/commit/d3fc644e88fb461920a8b60a0430bb42f6a6053e

Step 2: 區分屬性賦值和方法呼叫

屬性賦值用=, 方法呼叫用().
有時候分不清是屬性賦值還是方法呼叫, 可以先用=試試, 如果報錯再改為方法呼叫.

比如settings.gradle在這一步, 由:

include ":app"
rootProject.name="KotlinDSLSample"

變成了:

include(":app")
rootProject.name = "KotlinDSLSample"

第一行是一個方法呼叫, 第二行是一個屬性賦值.

專案根目錄的build.gradle中發生了兩處變化, 變成了:

    dependencies {
        classpath("com.android.tools.build:gradle:3.5.3")

和:

task clean(type: Delete) {
    delete(rootProject.buildDir)
}

這一步的改動見:
https://github.com/mengdd/KotlinDSLSample/commit/b36a508e7d4f1d5d25c23a9772e1cfd9df363fad

Step 3: 檔案重新命名

上面兩步只是準備工作, 經過上面兩步, 你的指令碼仍然是Groovy的, 只不過現在更接近Kotlin了.

真正的改變發生在這一步: 把字尾為.gradle的檔案重新命名, 字尾改為.gradle.kts.
沒有必要全部改完, 這兩種指令碼是可以共存的.

改完之後各種報錯了, 不要慌, 手動解決一下.

專案根目錄的build.gradle.kts比較好修, 只有全域性變數和task的問題.
app/build.gradle.kts中要改plugins, build type和依賴部分.

不再支援ext的全域性變數定義.

這裡圖簡單, 刪掉ext.kotlin_version = "1.3.61"這句, 直接寫:

    dependencies {
        classpath("com.android.tools.build:gradle:3.5.3")
        classpath(kotlin("gradle-plugin", version = "1.3.61"))
    }

task

task本來是這:

task clean(type: Delete) {
    delete(rootProject.buildDir)
}

現在要改成這樣:

tasks.register("clean", Delete::class) {
    delete(rootProject.buildDir)
}

外掛

應用plugins: 應用外掛有apply和plugin兩種方式.
強烈建議使用plugins {} block.

所以app/build.gradle.kts裡面改成這樣:

plugins {
    id("com.android.application")
    kotlin("android")
    kotlin("android.extensions")
}

build type

build type原先是這樣寫的:

    buildTypes {
        release {
            minifyEnabled = false
            proguardFiles(getDefaultProguardFile("proguard-android-optimize.txt"),
                    "proguard-rules.pro")
        }
    }

現在改成這樣:

    buildTypes {
        getByName("release") {
            isMinifyEnabled = false
            proguardFiles(getDefaultProguardFile("proguard-android.txt"), "proguard-rules.pro")
        }
    }

依賴

libs檔案依賴原先是:

implementation(fileTree(dir: "libs", include: ["*.jar"]))

需要改為:

implementation(fileTree(mapOf("dir" to "libs", "include" to listOf("*.jar"))

另外kotlin的部分:

implementation(kotlin("stdlib-jdk7", org.jetbrains.kotlin.config.KotlinCompilerVersion.VERSION))

這一步的改動見:
https://github.com/mengdd/KotlinDSLSample/commit/e392028b128bc83f1d183b880c479687d28cdcc3

自動轉換的方法

有一個自動轉換的工具:
https://github.com/bernaferrari/GradleKotlinConverter

mac上首先安裝kscript: https://github.com/holgerbrandl/kscript

brew install holgerbrandl/tap/kscript

然後把gradlekotlinconverter.kts檔案儲存到根目錄.

再執行:

kscript gradlekotlinconverter.kts build.gradle

和

kscript gradlekotlinconverter.kts app/build.gradle

進行檔案的轉換.

我測試了一下轉換的結果並不是很完美, 還需要手動修改一下.

Toubleshooting

  • 檔案字尾改為kts之後, app/build.gradle中android關鍵字被標紅.
    我就遇到了這個問題, 開始以為沒改好, 找不到android關鍵字了, 各種困惑找原因.
    但是我發現build是可以過的.
    後來突然IDE彈出一個條: There is a new script context available.
    點選了Apply context就可以了.
  • 要是還有問題, 參考一下官方的android sample吧: kotlin-dsl-samples/samples/hello-android

參考