查看模塊依賴項(xiàng)

一些直接依賴項(xiàng)可能具有自己的依賴項(xiàng)。此類依賴項(xiàng)稱為“傳遞依賴項(xiàng)”。Gradle 將會(huì)自動(dòng)為您收集并添加這些傳遞依賴項(xiàng)，無需您手動(dòng)逐一加以聲明。Android Plugin for Gradle 提供了一項(xiàng)任務(wù)，用來列出 Gradle 為給定模塊解析的依賴項(xiàng)。

對(duì)于每個(gè)模塊，報(bào)告還會(huì)根據(jù)構(gòu)建變體、測(cè)試源代碼集和類路徑對(duì)依賴項(xiàng)進(jìn)行分組。下面是一個(gè)應(yīng)用模塊的依賴項(xiàng)示例報(bào)告，其中按該模塊的調(diào)試構(gòu)建變體的運(yùn)行時(shí)類路徑和該模塊的插樁測(cè)試源代碼集的編譯類路徑對(duì)依賴項(xiàng)進(jìn)行了分組。

debugRuntimeClasspath - Dependencies for runtime/packaging
+--- :mylibrary (variant: debug)
+--- com.google.android.material:material:1.0.0@aar
+--- androidx.appcompat:appcompat:1.0.2@aar
+--- androidx.constraintlayout:constraintlayout:1.1.3@aar
+--- androidx.fragment:fragment:1.0.0@aar
+--- androidx.vectordrawable:vectordrawable-animated:1.0.0@aar
+--- androidx.recyclerview:recyclerview:1.0.0@aar
+--- androidx.legacy:legacy-support-core-ui:1.0.0@aar
debugAndroidTest
debugAndroidTestCompileClasspath - Dependencies for compilation
+--- androidx.test.ext:junit:1.1.0@aar
+--- androidx.test.espresso:espresso-core:3.1.1@aar
+--- androidx.test:runner:1.1.1@aar
+--- junit:junit:4.12@jar

如需運(yùn)行該任務(wù)，請(qǐng)按以下步驟操作：
依次選擇 View > Tool Windows > Gradle（或點(diǎn)擊工具窗口欄中的 Gradle 圖標(biāo) ）。
依次展開 AppName > Tasks > android，然后雙擊 androidDependencies。Gradle 執(zhí)行該任務(wù)后，系統(tǒng)應(yīng)該會(huì)打開 Run 窗口以顯示輸出。
如需詳細(xì)了解如何管理 Gradle 中的依賴項(xiàng)，請(qǐng)參閱 Gradle 用戶指南中的依賴項(xiàng)管理基礎(chǔ)知識(shí)。

修復(fù)依賴項(xiàng)解析錯(cuò)誤

當(dāng)您向應(yīng)用項(xiàng)目添加多個(gè)依賴項(xiàng)時(shí)，這些直接和傳遞依賴項(xiàng)可能會(huì)相互沖突。Android Gradle 插件會(huì)嘗試妥善解決這些沖突，但有些沖突可能會(huì)導(dǎo)致編譯時(shí)或運(yùn)行時(shí)錯(cuò)誤。

為幫助您調(diào)查是哪些依賴項(xiàng)導(dǎo)致了錯(cuò)誤，請(qǐng)檢查您的應(yīng)用的依賴項(xiàng)樹，從中查找多次出現(xiàn)的依賴項(xiàng)或版本沖突的依賴項(xiàng)。

如果無法輕松識(shí)別重復(fù)的依賴項(xiàng)，請(qǐng)嘗試使用 Android Studio 的界面搜索包含重復(fù)類的依賴項(xiàng)，具體操作步驟如下：

1. 從菜單欄中依次選擇 Navigate > Class。
2. 在彈出式搜索對(duì)話框中，確保已勾選 Include non-project items 旁邊的框。
3. 輸入出現(xiàn)在構(gòu)建錯(cuò)誤中的類的名稱。
4. 檢查結(jié)果以查找包含該類的依賴項(xiàng)。

下面幾部分介紹您可能會(huì)遇到的不同類型的依賴項(xiàng)解析錯(cuò)誤及其修復(fù)方法。

修復(fù)重復(fù)類錯(cuò)誤

如果某個(gè)類多次出現(xiàn)在運(yùn)行時(shí)類路徑上，您會(huì)收到一條與以下內(nèi)容類似的錯(cuò)誤：

Program type already present com.example.MyClass

二進(jìn)制文件依賴項(xiàng)包含一個(gè)庫，該庫也作為直接依賴項(xiàng)包含在您的應(yīng)用中。例如，您的應(yīng)用聲明直接依賴于庫 A 和庫 B，但庫 A 已在其二進(jìn)制文件中包含庫 B。
如需解決此問題，請(qǐng)取消將庫 B 作為直接依賴項(xiàng)。
您的應(yīng)用的本地二進(jìn)制文件依賴項(xiàng)和遠(yuǎn)程二進(jìn)制文件依賴項(xiàng)是同一個(gè)庫。
如需解決此問題，請(qǐng)移除其中一個(gè)二進(jìn)制文件依賴項(xiàng)。

解決類路徑之間的沖突

當(dāng) Gradle 解析編譯類路徑時(shí)，會(huì)先解析運(yùn)行時(shí)類路徑，然后使用所得結(jié)果確定應(yīng)添加到編譯類路徑的依賴項(xiàng)版本。換句話說，運(yùn)行時(shí)類路徑?jīng)Q定了下游類路徑上完全相同的依賴項(xiàng)所需的版本號(hào)。

應(yīng)用的運(yùn)行時(shí)類路徑還決定了 Gradle 需要對(duì)應(yīng)用的測(cè)試 APK 的運(yùn)行時(shí)類路徑中的匹配依賴項(xiàng)使用的版本號(hào)。圖 1 說明了類路徑的層次結(jié)構(gòu)。

image.png

例如，當(dāng)應(yīng)用使用 implementation 依賴項(xiàng)配置加入某個(gè)依賴項(xiàng)的一個(gè)版本，而庫模塊使用 runtimeOnly 配置加入該依賴項(xiàng)的另一個(gè)版本時(shí)，就可能會(huì)發(fā)生多個(gè)類路徑中出現(xiàn)同一依賴項(xiàng)的不同版本的沖突。

在解析對(duì)運(yùn)行時(shí)和編譯時(shí)類路徑的依賴關(guān)系時(shí)，Android Gradle 插件 3.3.0 及更高版本會(huì)嘗試自動(dòng)解決某些下游版本沖突。例如，如果運(yùn)行時(shí)類路徑包含庫 A 版本 2.0，而編譯類路徑包含庫 A 版本 1.0，則插件會(huì)自動(dòng)將對(duì)編譯類路徑的依賴關(guān)系更新為庫 A 版本 2.0，以避免錯(cuò)誤。

不過，如果運(yùn)行時(shí)類路徑包含庫 A 版本 1.0，而編譯類路徑包含庫 A 版本 2.0，插件不會(huì)將對(duì)編譯類路徑的依賴關(guān)系降級(jí)為庫 A 版本 1.0，您仍會(huì)收到一條與以下內(nèi)容類似的錯(cuò)誤：

Conflict with dependency 'com.example.library:some-lib:2.0' in project 'my-library'.
Resolved versions for runtime classpath (1.0) and compile classpath (2.0) differ.
翻譯后：
與項(xiàng)目“ my-library”中的依賴項(xiàng)“ com.example.library：some-lib：2.0”沖突。 解決運(yùn)行時(shí)類路徑（1.0）和編譯類路徑（2.0）的版本不同

如需解決此問題，請(qǐng)執(zhí)行以下某項(xiàng)操作：

• 將所需版本的依賴項(xiàng)作為 api 依賴項(xiàng)添加到庫模塊。也就是說，只有庫模塊聲明相應(yīng)依賴項(xiàng)，但應(yīng)用模塊也能以傳遞方式訪問其 API。
• 或者，您也可以同時(shí)在兩個(gè)模塊中聲明相應(yīng)依賴項(xiàng)，但應(yīng)確保每個(gè)模塊使用的版本相同。不妨考慮配置項(xiàng)目全局屬性，以確保每個(gè)依賴項(xiàng)的版本在整個(gè)項(xiàng)目中保持一致。

應(yīng)用自定義構(gòu)建邏輯

本部分介紹的高級(jí)主題在您要擴(kuò)展 Android Gradle 插件或編寫自己的插件時(shí)很有用。

向自定義邏輯發(fā)布變體依賴項(xiàng)

庫可以包含其他項(xiàng)目或子項(xiàng)目可能要使用的功能。發(fā)布庫是向其消費(fèi)者提供庫的過程。庫可以控制其消費(fèi)者在編譯時(shí)和運(yùn)行時(shí)可訪問的依賴項(xiàng)。

有兩種不同的配置，它們包含每個(gè)類路徑的傳遞依賴項(xiàng)，消費(fèi)者為了使用相應(yīng)庫而必須使用這些依賴項(xiàng)，具體說明如下：

variant_nameApiElements：此配置包含編譯時(shí)消費(fèi)者可使用的傳遞依賴項(xiàng)。
variant_nameRuntimeElements：此配置包含運(yùn)行時(shí)消費(fèi)者可使用的傳遞依賴項(xiàng)。

如需詳細(xì)了解不同配置之間的關(guān)系，請(qǐng)參閱 Java 庫插件配置。

自定義依賴項(xiàng)解析策略

一個(gè)項(xiàng)目可能會(huì)依賴于同一個(gè)庫的兩個(gè)不同版本，這樣會(huì)導(dǎo)致依賴項(xiàng)沖突。例如，如果您的項(xiàng)目依賴于模塊 A 的版本 1 和模塊 B 的版本 2，而模塊 A 以傳遞方式依賴于模塊 B 的版本 3，則會(huì)出現(xiàn)依賴項(xiàng)版本沖突。

為了解決此沖突，Android Gradle 插件使用以下依賴項(xiàng)解析策略：當(dāng)插件檢測(cè)到依賴項(xiàng)關(guān)系圖中存在同一模塊的不同版本時(shí)，默認(rèn)情況下，它會(huì)選擇版本號(hào)最高的一個(gè)。

不過，此策略可能并不總是如您所愿。如需自定義依賴項(xiàng)解析策略，請(qǐng)使用以下配置解析任務(wù)所需的特定變體依賴項(xiàng)：

variant_nameCompileClasspath：此配置包含適用于給定變體編譯類路徑的解析策略。
variant_nameRuntimeClasspath：此配置包含適用于給定變體運(yùn)行時(shí)類路徑的解析策略。
Android Gradle 插件包含可用于訪問每個(gè)變體的配置對(duì)象的 getter。因此，您可以使用變體 API 查詢依賴項(xiàng)解析，如以下示例所示：

resolutionStrategy :解析策略
android {
    applicationVariants.all { variant ->
        // Return compile configuration objects of a variant.
翻譯后：返回變體的編譯配置對(duì)象
        variant.getCompileConfiguration().resolutionStrategy {
        // Use Gradle's ResolutionStrategy API
        // to customize how this variant resolves dependencies.
翻譯后：使用Gradle的策略 API 來自定義此變體如何解決依賴關(guān)系
            ...
        }
        // Return runtime configuration objects of a variant.
翻譯后：返回變體的運(yùn)行時(shí)配置對(duì)象
        variant.getRuntimeConfiguration().resolutionStrategy {
            ...
        }
        // Return annotation processor configuration of a variant.
翻譯后：返回變體的注釋處理器配置
        variant.getAnnotationProcessorConfiguration().resolutionStrategy {
            ...
        }
    }
}