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的说明文档,有一些方法俺也妹整明白呢,文档上这么说,可是用起来却没有效果,且留日后再看。

参考

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,716评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,558评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,431评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,127评论 0 209
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,511评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,692评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,915评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,664评论 0 202
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,412评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,616评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,105评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,424评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,098评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,096评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,869评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,748评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,641评论 2 271