Gradle依赖替换

前言

在项目开发过程中，不可避免的需要引入一些第三方库，而不同的第三方库之间，可能存在一些依赖关系。例如：你依赖了库A与B，而同时B也依赖于A。这样就可能存在这种情况：你依赖的A的版本与B中依赖的A的版本不同。

1. gradle的默认解决方案

通常情况下，gradle通过选择最高版本解决来解决版本冲突，下面以RxJava为例：

    implementation("io.reactivex.rxjava2:rxjava:2.1.6")
    implementation("io.reactivex.rxjava2:rxkotlin:2.4.0")

其中，我项目引入的rxjava的版本为2.1.6，rxkotlin 2.4.0中依赖的rxjava的版本为2.2.10。下面，我们运行一下:app -> tasks -> help -> dependencies，查看gradle console的输出，可以找到：

+--- io.reactivex.rxjava2:rxjava:2.1.6 -> 2.2.10
| \--- org.reactivestreams:reactive-streams:1.0.2
+--- io.reactivex.rxjava2:rxandroid:2.1.1
| \--- io.reactivex.rxjava2:rxjava:2.2.6 -> 2.2.10 (*)
\--- io.reactivex.rxjava2:rxkotlin:2.4.0
\--- io.reactivex.rxjava2:rxjava:2.2.10 (*)

显然，rxjava的版本都被替换成了2.2.10。

2. 实施特定的依赖版本

gradle对于解决版本冲突的默认行为并非不可改变的，我们可以指定我们希望的版本，或者禁用一些我们不希望的传递依赖

指定依赖版本

    //在引入时配置，指定版本为我们引入的版本
    implementation("io.reactivex.rxjava2:rxjava:2.1.6") {
        force = true
    }
    //在configuration 级别指定，直接指定版本
    configurations.all {
        resolutionStrategy.force 'io.reactivex.rxjava2:rxjava:2.1.6'
    }

禁用传递的依赖项

 //在引入时配置，禁用该库的传递依赖项
    implementation("io.reactivex.rxjava2:rxkotlin:2.4.0") {
        transitive = false
    }
    //在configuration 级别指定，一杆子打死，谁也别想使用传递依赖
    configurations.all {
        transitive = false
    }

还有其他诸如exclude、because等属性和方法在这里不再详聊，下面我们看看当引用的库groupid不同时可以如何配置替换

3. 定义解析策略

仍以rxjava举例，众所周知，RxJava最近发布了3.0.0的RC版本，而Rxjava3的groupid与Rxjava2不同，gradle的默认策略已经无法解决了，force也只能饮恨，唯exclude和transitive可堪一战。于是A库来了exclude，B库来个exclude，想想那个场面，脑海是不是浮现出两个字：丑陋？！！天空是不是飘过四个大字：弟弟行为？！！心里是不是狂呼：这可如何是好？！！
诸君莫慌，resolutionStrategy可助你一臂之力

dependencySubstitution

dependencySubstitution接收一系列替换规则，允许你通过substitute函数为项目中的依赖替换为你希望的依赖项，例如：

configurations.all {
    resolutionStrategy.dependencySubstitution {
        substitute module("io.reactivex.rxjava2:rxjava") with module("io.reactivex.rxjava3:rxjava:3.0.0-RC1")
    }
}

substitute的参数不一定是module()，针对外部依赖和内部依赖，你有两种选择：module()和project()，视具体情况自由组合。
官方文档示例：

// add dependency substitution rules
configurations.all {
  resolutionStrategy.dependencySubstitution {
    // Substitute project and module dependencies
    substitute module('org.gradle:api') with project(':api')
    substitute project(':util') with module('org.gradle:util:3.0')

    // Substitute one module dependency for another
    substitute module('org.gradle:api:2.0') with module('org.gradle:api:2.1')
  }
}

eachDependency

eachDependency允许你在gradle解析配置时为每个依赖项添加一个替换规则，DependencyResolveDetails类型的参数可以让你获取一个requested和使用useVersion()、useTarget()两个函数指定依赖版本和目标依赖。request中存放了依赖项的groupid、module name以及version，你可以通过这些值来筛选你想要替换的依赖项，再通过useVersion或useTarget指定你想要的依赖。这段描述好多字啊我写的眼都花了想来你看得也头疼咱们还是来看例子吧：

configurations.all {
    resolutionStrategy.eachDependency { DependencyResolveDetails details ->
        if (details.requested.name == 'rxjava') {
            //由于useVersion只能指定版本号，不适用于group不同的情况
            details.useTarget group: 'io.reactivex.rxjava3', name: 'rxjava', version: '3.0.0-RC1'
        }
    }
}

果然还是代码看着舒服。
值得注意的是，useTarget的参数为一个包含了group、name、version的map，并非一个字符串，useVersion的参数才是一个字符串，这个字符串就是你希望的版本号。

后记

关于依赖替换相关的内容仍有许多，但限于我懒得打字和排版以及自身领悟度不够以免误人子弟所以就不再多言，有兴趣的朋友可以去看看gradle的说明文档，有一些方法俺也妹整明白呢，文档上这么说，可是用起来却没有效果，且留日后再看。

参考

• 排除依赖性解决方案
• 自定义依赖性解析行为
• resolutionStrategy