[譯]Kotlin + buildSrc：更好的管理Gadle依賴

• 原文地址：Kotlin + buildSrc for Better Gradle Dependency Management
• 原文做者：Sam Edwards，Lead Android Engineer at Google Developer Expert for Android

爲了充分利用Android Plugin for Gradle 3.0+的優勢，將Android項目拆分紅多個module的作法愈來愈常見。然而，隨着module數量的增多，咱們很快就會遇到依賴管理的混亂問題。

管理Gradle依賴的三種不一樣方法：

1. 手動管理
2. 使用Google推薦的「ext」
3. Kotlin + buildSrc

1) 手動管理

這是一種大多數人在採用的管理依賴的方法，但每次升級依賴庫時都須要作大量的手動更改。

module_a/build.gradle

implementation "com.android.support:support-annotations:27.0.2"
implementation "com.android.support:appcompat-v7:27.0.2"
implementation "com.squareup.retrofit2:retrofit:2.3.0"
implementation "com.squareup.retrofit2:adapter-rxjava2:2.3.0"
implementation "io.reactivex.rxjava2:rxjava:2.1.9"
複製代碼

module_b/build.gradle

implementation "com.android.support:support-annotations:27.0.2"
implementation "com.android.support:appcompat-v7:27.0.2"
implementation "com.squareup.retrofit2:retrofit:2.3.0"
implementation "com.squareup.retrofit2:adapter-rxjava2:2.3.0"
implementation "io.reactivex.rxjava2:rxjava:2.1.9"
複製代碼

這裏存在許多重複的配置，並且當你的項目有不少module時很難管理依賴庫的版本更新。

Google推薦：使用gradle的extra屬性

Google在Android官方文檔中推薦這種管理依賴的方法。許多項目例如ButterKnife、Picasso等都在使用這種方法。

此方法很是適用於更新support library的版本，由於每一個support library都具備相同的版本號，你只須要在一個地方更改它就好了。 Retrofit等其它第三方庫也是如此。

Root-level build.gradle

ext {
  versions = [
    support_lib: "27.0.2",
    retrofit: "2.3.0",
    rxjava: "2.1.9"
  ]
  libs = [
    support_annotations: "com.android.support:support-annotations:${versions.support_lib}",
    support_appcompat_v7: "com.android.support:appcompat-v7:${versions.support_lib}",
    retrofit :"com.squareup.retrofit2:retrofit:${versions.retrofit}",
    retrofit_rxjava_adapter: "com.squareup.retrofit2:adapter-rxjava2:${versions.retrofit}",
    rxjava: "io.reactivex.rxjava2:rxjava:${versions.rxjava}"
  ]
}
複製代碼

module_a/build.gradle

implementation libs.support_annotations
implementation libs.support_appcompat_v7
implementation libs.retrofit
implementation libs.retrofit_rxjava_adapter
implementation libs.rxjava
複製代碼

module_b/build.gradle

implementation libs.support_annotations
implementation libs.support_appcompat_v7
implementation libs.retrofit
implementation libs.retrofit_rxjava_adapter
implementation libs.rxjava
複製代碼

這種方法是手動管理的一大進步，可是缺乏IDE的支持，更準確的說是在更新依賴庫的時候IDE不能自動補全。

Kotlin + buildSrc == Android Studio Autocomplete 😎 🎉

您須要在您的項目裏建立一個buildSrc模塊，而後編寫kotlin代碼來管理依賴庫，使得IDE支持自動補全。

Gradle文檔中有這樣一段話:

當你運行Gradle時，它會檢查項目中是否存在一個名爲buildSrc的目錄。而後Gradle會自動編譯並測試這段代碼，並將其放入構建腳本的類路徑中。您不須要提供任何進一步的操做提示。

你只須要在buildSrc module中新建兩個文件:

1. build.gradle.kts
2. 編寫Kotlin代碼的文件 (本文中是指Dependencies.kt)

buildSrc/build.gradle.kts:

plugins {
    `kotlin-dsl`
}
複製代碼

buildSrc/src/main/java/Dependencies.kt

object Versions {
    val support_lib = "27.0.2"
    val retrofit = "2.3.0"
    val rxjava = "2.1.9"
}

object Libs {
 val support_annotations = "com.android.support:support-annotations:${Versions.support_lib}"
 val support_appcompat_v7 = "com.android.support:appcompat-v7:${Versions.support_lib}"
 val retrofit = "com.squareup.retrofit2:retrofit:${Versions.retrofit}"
 val retrofit_rxjava_adapter = "com.squareup.retrofit2:adapter-rxjava2:${Versions.retrofit}"
 val rxjava = "io.reactivex.rxjava2:rxjava:${Versions.rxjava}"
}
複製代碼

通過上面兩個步驟後，執行一次Gradle Sync任務，如今咱們能夠在Android Studio中訪問Dependencies.kt中任何值了。

看起來結果與「ext」很是類似，可是它支持自動補全和單擊跳轉。

module_a/build.gradle

implementation Libs.support_annotations
implementation Libs.support_appcompat_v7
implementation Libs.retrofit
implementation Libs.retrofit_rxjava_adapter
implementation Libs.rxjava
複製代碼

module_a/build.gradle

implementation Libs.support_annotations
implementation Libs.support_appcompat_v7
implementation Libs.retrofit
implementation Libs.retrofit_rxjava_adapter
implementation Libs.rxjava
複製代碼

結束語

我強烈推薦您使用「Kotlin + buildSrc」的方法。它支持自動補全和單擊跳轉，使得您無需在文件之間手動來回切換，方便你更好的管理Gradle依賴。

動手實踐：

新建的module名稱必須爲buildSrc

一開始我按照做者原文的描述，在Android Studio裏右鍵單擊項目，New 出一個名爲buildSrc的Android Library，試了好幾遍都提示「Gradle sync failed: Plugin with id 'com.android.library' not found」的錯誤。

後來我參考這裏的作法，手動建立了buildSrc這個模塊。步驟以下：

1. 在項目根目錄下新建一個名爲buildSrc的文件夾(與項目裏的app文件夾同級)。
2. 在buildSrc文件夾裏建立名爲build.gradle.kts的文件，文件內容參考以前的描述。
3. 在buildSrc文件夾裏建立src/main/java文件夾，以下圖所示。並在該文件夾下建立Dependencies.kt文件，文件內容參考以前的描述。

4. build一遍你的項目，而後重啓你的Android Studio，項目裏就會多出一個名爲buildSrc的module。