Gradle依賴項學習總結，dependencies、transitive、force、exclude的使用與依賴衝突解決

http://www.paincker.com/gradle-dependencies

https://docs.gradle.org/current/userguide/dependency_management.html

 

http://www.concretepage.com/build-tools/gradle/gradle-exclude-transitive-dependency-example

 

Gradle是一個很是好用的編譯工具，特別是繼承了maven的依賴項管理功能，須要的Library不須要像傳統IDE同樣手動下載複製到項目中，只須要簡單的寫一行gradle腳本，就能自動下載下來並編譯。

可是有時候會出現各類不明狀況的報錯，最多見的一種緣由就是依賴項版本衝突。

每一個模塊均可能依賴其餘模塊，這些模塊又會依賴別的模塊。而一個項目中的多個模塊，對同一個模塊的不一樣版本有依賴，就可能產生衝突。

經過gradle命令查看依賴樹，能夠比較直觀的看到衝突。具體方法是在模塊所在的目錄，也即build.gradle所在目錄下執行gradle dependencies（須要將gradle加入PATH環境變量），執行結果如圖。

Transitive

Transitive用於自動處理子依賴項。默認爲true，gradle自動添加子依賴項，造成一個多層樹形結構；設置爲false，則須要手動添加每一個依賴項。

案例

以安卓單元測試espresso的配置爲例，gradle依賴以下：

1. dependencies {
2. androidTestCompile('com.android.support.test:runner:0.2')
3. androidTestCompile('com.android.support.test:rules:0.2')
4. androidTestCompile('com.android.support.test.espresso:espresso-core:2.1')
5. }

運行gradle dependencies的結果以下。能夠看到每一個包的依賴項都被遞歸分析並添加進來。

1. +--- com.android.support.test:runner:0.2
2. | +--- junit:junit-dep:4.10
3. | | \--- org.hamcrest:hamcrest-core:1.1
4. | +--- com.android.support.test:exposed-instrumentation-api-publish:0.2
5. | \--- com.android.support:support-annotations:22.0.0
6. +--- com.android.support.test:rules:0.2
7. | \--- com.android.support.test:runner:0.2 (*)
8. \--- com.android.support.test.espresso:espresso-core:2.1
9. +--- com.android.support.test:rules:0.2 (*)
10. +--- com.squareup:javawriter:2.1.1
11. +--- org.hamcrest:hamcrest-integration:1.1
12. | \--- org.hamcrest:hamcrest-core:1.1
13. +--- com.android.support.test.espresso:espresso-idling-resource:2.1
14. +--- org.hamcrest:hamcrest-library:1.1
15. | \--- org.hamcrest:hamcrest-core:1.1
16. +--- javax.inject:javax.inject:1
17. +--- com.google.code.findbugs:jsr305:2.0.1
18. +--- com.android.support.test:runner:0.2 (*)
19. +--- javax.annotation:javax.annotation-api:1.2
20. \--- org.hamcrest:hamcrest-core:1.1

統一指定transitive

能夠給dependencies統一指定transitive爲false，再次執行dependencies能夠看到以下結果。

1. configurations.all {
2. transitive = false
3. }
5. dependencies {
6. androidTestCompile('com.android.support.test:runner:0.2')
7. androidTestCompile('com.android.support.test:rules:0.2')
8. androidTestCompile('com.android.support.test.espresso:espresso-core:2.1')
9. }

1. +--- com.android.support.test:runner:0.2
2. +--- com.android.support.test:rules:0.2
3. \--- com.android.support.test.espresso:espresso-core:2.1

單獨指定依賴項的transitive

1. dependencies {
2. androidTestCompile('com.android.support.test:runner:0.2')
3. androidTestCompile('com.android.support.test:rules:0.2')
4. androidTestCompile('com.android.support.test.espresso:espresso-core:2.1') {
5. transitive = false
6. }
7. }

版本衝突

在同一個配置下（例如androidTestCompile），某個模塊的不一樣版本同時被依賴時，默認使用最新版，gradle同步時不會報錯。例以下面的hamcrest-core和runner。

1. dependencies {
2. androidTestCompile('com.android.support.test:runner:0.4')
3. androidTestCompile('com.android.support.test:rules:0.2')
4. androidTestCompile('com.android.support.test.espresso:espresso-core:2.1')
5. }

1. +--- com.android.support.test:runner:0.4
2. | +--- com.android.support:support-annotations:23.0.1
3. | +--- junit:junit:4.12
4. | | \--- org.hamcrest:hamcrest-core:1.3
5. | \--- com.android.support.test:exposed-instrumentation-api-publish:0.4
6. +--- com.android.support.test:rules:0.2
7. | \--- com.android.support.test:runner:0.2 -> 0.4 (*)
8. \--- com.android.support.test.espresso:espresso-core:2.1
9. +--- com.android.support.test:rules:0.2 (*)
10. +--- com.squareup:javawriter:2.1.1
11. +--- org.hamcrest:hamcrest-integration:1.1
12. | \--- org.hamcrest:hamcrest-core:1.1 -> 1.3
13. +--- com.android.support.test.espresso:espresso-idling-resource:2.1
14. +--- org.hamcrest:hamcrest-library:1.1
15. | \--- org.hamcrest:hamcrest-core:1.1 -> 1.3
16. +--- javax.inject:javax.inject:1
17. +--- com.google.code.findbugs:jsr305:2.0.1
18. +--- com.android.support.test:runner:0.2 -> 0.4 (*)
19. +--- javax.annotation:javax.annotation-api:1.2
20. \--- org.hamcrest:hamcrest-core:1.1 -> 1.3

Force

force強制設置某個模塊的版本。

1. configurations.all {
2. resolutionStrategy {
3. force 'org.hamcrest:hamcrest-core:1.3'
4. }
5. }
6. dependencies {
7. androidTestCompile('com.android.support.test:runner:0.2')
8. androidTestCompile('com.android.support.test:rules:0.2')
9. androidTestCompile('com.android.support.test.espresso:espresso-core:2.1')
10. }

能夠看到，本來對hamcrest-core 1.1的依賴，所有變成了1.3。

1. +--- com.android.support.test:runner:0.2
2. | +--- junit:junit-dep:4.10
3. | | \--- org.hamcrest:hamcrest-core:1.1 -> 1.3
4. | +--- com.android.support.test:exposed-instrumentation-api-publish:0.2
5. | \--- com.android.support:support-annotations:22.0.0
6. +--- com.android.support.test:rules:0.2
7. | \--- com.android.support.test:runner:0.2 (*)
8. \--- com.android.support.test.espresso:espresso-core:2.1
9. +--- com.android.support.test:rules:0.2 (*)
10. +--- com.squareup:javawriter:2.1.1
11. +--- org.hamcrest:hamcrest-integration:1.1
12. | \--- org.hamcrest:hamcrest-core:1.1 -> 1.3
13. +--- com.android.support.test.espresso:espresso-idling-resource:2.1
14. +--- org.hamcrest:hamcrest-library:1.1
15. | \--- org.hamcrest:hamcrest-core:1.1 -> 1.3
16. +--- javax.inject:javax.inject:1
17. +--- com.google.code.findbugs:jsr305:2.0.1
18. +--- com.android.support.test:runner:0.2 (*)
19. +--- javax.annotation:javax.annotation-api:1.2
20. \--- org.hamcrest:hamcrest-core:1.1 -> 1.3

Exclude

Exclude能夠設置不編譯指定的模塊

1. configurations {
2. all*.exclude group: 'org.hamcrest', module: 'hamcrest-core'
3. }
4. dependencies {
5. androidTestCompile('com.android.support.test:runner:0.2')
6. androidTestCompile('com.android.support.test:rules:0.2')
7. androidTestCompile('com.android.support.test.espresso:espresso-core:2.1')
8. }

1. +--- com.android.support.test:runner:0.2
2. | +--- junit:junit-dep:4.10
3. | +--- com.android.support.test:exposed-instrumentation-api-publish:0.2
4. | \--- com.android.support:support-annotations:22.0.0
5. +--- com.android.support.test:rules:0.2
6. | \--- com.android.support.test:runner:0.2 (*)
7. \--- com.android.support.test.espresso:espresso-core:2.1
8. +--- com.android.support.test:rules:0.2 (*)
9. +--- com.squareup:javawriter:2.1.1
10. +--- org.hamcrest:hamcrest-integration:1.1
11. +--- com.android.support.test.espresso:espresso-idling-resource:2.1
12. +--- org.hamcrest:hamcrest-library:1.1
13. +--- javax.inject:javax.inject:1
14. +--- com.google.code.findbugs:jsr305:2.0.1
15. +--- com.android.support.test:runner:0.2 (*)
16. \--- javax.annotation:javax.annotation-api:1.2

單獨使用group或module參數

exclude後的參數有group和module，能夠分別單獨使用，會排除全部匹配項。例以下面的腳本匹配了全部的group爲’com.android.support.test’的模塊。

1. configurations {
2. all*.exclude group: 'com.android.support.test'
3. }
4. dependencies {
5. androidTestCompile('com.android.support.test:runner:0.2')
6. androidTestCompile('com.android.support.test:rules:0.2')
7. androidTestCompile('com.android.support.test.espresso:espresso-core:2.1')
8. }

1. \--- com.android.support.test.espresso:espresso-core:2.1
2. +--- com.squareup:javawriter:2.1.1
3. +--- org.hamcrest:hamcrest-integration:1.1
4. | \--- org.hamcrest:hamcrest-core:1.1
5. +--- com.android.support.test.espresso:espresso-idling-resource:2.1
6. +--- org.hamcrest:hamcrest-library:1.1
7. | \--- org.hamcrest:hamcrest-core:1.1
8. +--- javax.inject:javax.inject:1
9. +--- com.google.code.findbugs:jsr305:2.0.1
10. +--- javax.annotation:javax.annotation-api:1.2
11. \--- org.hamcrest:hamcrest-core:1.1

單獨給某個模塊指定exclude

1. dependencies {
2. androidTestCompile('com.android.support.test:runner:0.2')
3. androidTestCompile('com.android.support.test:rules:0.2')
4. androidTestCompile('com.android.support.test.espresso:espresso-core:2.1') {
5. exclude group: 'org.hamcrest'
6. }
7. }

1. +--- com.android.support.test:runner:0.2
2. | +--- junit:junit-dep:4.10
3. | | \--- org.hamcrest:hamcrest-core:1.1
4. | +--- com.android.support.test:exposed-instrumentation-api-publish:0.2
5. | \--- com.android.support:support-annotations:22.0.0
6. +--- com.android.support.test:rules:0.2
7. | \--- com.android.support.test:runner:0.2 (*)
8. \--- com.android.support.test.espresso:espresso-core:2.1
9. +--- com.android.support.test:rules:0.2 (*)
10. +--- com.squareup:javawriter:2.1.1
11. +--- com.android.support.test.espresso:espresso-idling-resource:2.1
12. +--- javax.inject:javax.inject:1
13. +--- com.google.code.findbugs:jsr305:2.0.1
14. +--- com.android.support.test:runner:0.2 (*)
15. \--- javax.annotation:javax.annotation-api:1.2

不一樣配置下的版本衝突

一樣的配置下的版本衝突，會自動使用最新版；而不一樣配置下的版本衝突，gradle同步時會直接報錯。可以使用exclude、force解決衝突。

例如compile 'com.android.support:appcompat-v7:23.1.1'，和androidTestCompile 'com.android.support.test.espresso:espresso-core:2.1'，所依賴的com.android.support:support-annotations版本不一樣，就會致使衝突。

1. dependencies {
2. compile 'com.android.support:appcompat-v7:23.1.1'
3. androidTestCompile('com.android.support.test:runner:0.2')
4. androidTestCompile('com.android.support.test:rules:0.2')
5. androidTestCompile('com.android.support.test.espresso:espresso-core:2.1')
6. }

gradle同步時會提示

1. Warning:Conflict with dependency 'com.android.support:support-annotations'. Resolved versions for app and test app differ.

執行dependencies會提示

1. FAILURE: Build failed with an exception.
3. * What went wrong:
4. A problem occurred configuring project ':app'.
5. > Conflict with dependency 'com.android.support:support-annotations'. Resolved versions for app and test app differ.
7. * Try:
8. Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output.
10. BUILD FAILED

不兼容

雖然能夠經過force、exclude等方式避免依賴項版本衝突，使得grade同步成功，可是並不能表明編譯時沒有問題。因爲不一樣版本可能不徹底兼容，因而會出現各類奇怪的報錯。已知的解決思路是更改包的版本、嘗試強制使用不一樣版本的依賴項，找到可兼容的依賴組合。

報錯例如：

1. com.android.dex.DexException: Multiple dex files define Lorg/hamcrest/MatcherAssert;
2. at com.android.dx.merge.DexMerger.readSortableTypes(DexMerger.java:596)
3. at com.android.dx.merge.DexMerger.getSortedTypes(DexMerger.java:554)
4. at com.android.dx.merge.DexMerger.mergeClassDefs(DexMerger.java:535)
5. at com.android.dx.merge.DexMerger.mergeDexes(DexMerger.java:171)
6. at com.android.dx.merge.DexMerger.merge(DexMerger.java:189)
7. at com.android.dx.command.dexer.Main.mergeLibraryDexBuffers(Main.java:454)
8. at com.android.dx.command.dexer.Main.runMonoDex(Main.java:303)
9. at com.android.dx.command.dexer.Main.run(Main.java:246)
10. at com.android.dx.command.dexer.Main.main(Main.java:215)
11. at com.android.dx.command.Main.main(Main.java:106)
12. Error:Execution failed for task ':app:dexDebugAndroidTest'.
13. > com.android.ide.common.process.ProcessException: org.gradle.process.internal.ExecException: Process 'command '/Library/Java/JavaVirtualMachines/jdk1.8.0_40.jdk/Contents/Home/bin/java'' finished with non-zero exit value 2
14. BUILD FAILED

又例如Android執行Espresso單元測試時出現：

1. Running tests
2. Test running started
3. java.lang.NoSuchMethodError: org.hamcrest.core.AnyOf.anyOf
4. at org.hamcrest.Matchers.anyOf(Matchers.java:87)
5. at android.support.test.espresso.Espresso.<clinit>(Espresso.java:158)
6. at com.jzj1993.unittest.test.MainActivityEspressoTest.sayHello(MainActivityEspressoTest.java:28)
7. at java.lang.reflect.Method.invokeNative(Native Method)
8. at java.lang.reflect.Method.invoke(Method.java:525)
9. at org.junit.runners.model.FrameworkMethod$1.runReflectiveCall(FrameworkMethod.java:45)
10. at org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java:15)
11. at org.junit.runners.model.FrameworkMethod.invokeExplosively(FrameworkMethod.java:42)
12. at org.junit.internal.runners.statements.InvokeMethod.evaluate(InvokeMethod.java:20)
13. at android.support.test.internal.statement.UiThreadStatement.evaluate(UiThreadStatement.java:55)
14. at android.support.test.rule.ActivityTestRule$ActivityStatement.evaluate(ActivityTestRule.java:257)
15. at org.junit.rules.RunRules.evaluate(RunRules.java:18)
16. at org.junit.runners.ParentRunner.runLeaf(ParentRunner.java:263)
17. at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:68)
18. at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:47)
19. at org.junit.runners.ParentRunner$3.run(ParentRunner.java:231)
20. at org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:60)
21. at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:229)
22. at org.junit.runners.ParentRunner.access$000(ParentRunner.java:50)
23. at org.junit.runners.ParentRunner$2.evaluate(ParentRunner.java:222)
24. at org.junit.runners.ParentRunner.run(ParentRunner.java:300)
25. at org.junit.runners.Suite.runChild(Suite.java:128)
26. at org.junit.runners.Suite.runChild(Suite.java:24)
27. at org.junit.runners.ParentRunner$3.run(ParentRunner.java:231)
28. at org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:60)
29. at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:229)
30. at org.junit.runners.ParentRunner.access$000(ParentRunner.java:50)
31. at org.junit.runners.ParentRunner$2.evaluate(ParentRunner.java:222)
32. at org.junit.runners.ParentRunner.run(ParentRunner.java:300)
33. at org.junit.runner.JUnitCore.run(JUnitCore.java:157)
34. at org.junit.runner.JUnitCore.run(JUnitCore.java:136)
35. at android.support.test.internal.runner.TestExecutor.execute(TestExecutor.java:54)
36. at android.support.test.runner.AndroidJUnitRunner.onStart(AndroidJUnitRunner.java:228)
37. at android.app.Instrumentation$InstrumentationThread.run(Instrumentation.java:1701)
39. Finish

參考資料與擴展閱讀

https://docs.gradle.org/current/userguide/dependency_management.html
http://www.concretepage.com/build-tools/gradle/gradle-exclude-transitive-dependency-example