有关 Android Studio 重复引入包的问题和解决方案

随着产品功能需求的增加,我们开发的安卓项目不得不入引入越来越多的第三方库。这些三方库可能以 Jar 包的形式放置在 libs 目录下,可能以 Gradle 远程依赖的形式下载引入,也可能是以 Library Module 的形式放置在工程目录下,等等。

随之而来的问题是,复杂的依赖关系很可能导致重复引入包的问题。比较常见的使用场景就是 support-v4 包的重复引入。这样就会导致,执行 Run 操作打包生成 Apk 文件时出现类似这样的 DexException 错误提示,导致编译失败:

Error:Execution failed for task ':app:transformClassesWithDexForDebug'.
> com.android.build.api.transform.TransformException: 
com.android.ide.common.process.ProcessException: 
java.util.concurrent.ExecutionException: com.android.dex.DexException: 
Multiple dex files define Landroid/support/v4/app/ActivityCompatHoneycomb;

有多种使用场景会出现这种问题。根据解决方案的不同,大体上可以分为两种:本地 Jar 包重复嵌入和 Gradle 远程重复依赖。

第一种,比较好理解。比如 app module 与 library module 各自 libs 目录中嵌入了相同的 Jar 包。这种情况也比较好解决,只需要将 app module 下的重复 jar 包删除即可。

第二种,稍微复杂一点。比如对于 Gradle 远程依赖的两个第三方库,他们内部同时依赖相同的另一个辅助第三方库。这个时候我们就没办法像第
一种情况那样手动删除本地文件。好在 Gradle 插件提供了相应的解决方案,即使用 exclude 语法,如:

compile 'com.yifeng.example:example-1:1.0'
compile ('com.yifeng.example:example-2:1.0') {
    exclude group: 'com.android.support', module: 'support-v4'
}

如例子中所示,远程依赖的第三方库 example-1 与 example-2 内部同时引入 support-v4 包,那么只需要在其中一个的引入地方添加 exclude 语句,根据 group 和 module 过滤规则,将相同引入的 v4 包剔除在外即可。

当需要在一个依赖中去除多个递归依赖项时,可以使用多条 exclude 语句,比如:

compile ('com.wdullaer:materialdatetimepicker:3.2.2') {
    exclude group: 'com.android.support', module: 'support-v4'
    exclude group: 'com.android.support', module: 'design'
}

还有一种更简单的写法,使用 Groove 语言的循环语句,模板如下(同样适用于 module 规则):

compile() { dep ->
    [group1, group2].each{ group -> dep.exclude group: group }
}

对于上面的例子,便可以改造成:

compile() { dep ->
    ['support-v4', 'support-v13', 'design'].each{ module -> dep.exclude module: module }
}

更多细节,参考:ModuleDependency
以上两种场景算是比较好处理的。还有一种特殊情况,就是不同第三方库内部出现相同包名相同文件名的 java 类。这种情况出现的概率很低,但是不幸的是我在工作中就遇见过。
当时项目中引入的 友盟统计移动统一认证 的 SDK 出现重复引入问题,执行 Run 操作编译打包时出现 duplicate entry 错误,如图:

Paste_Image.png

通过错误提示,很容易就找到错误出处,我们看下两个 SDK 中的 jar 包源码:

Paste_Image.png
Paste_Image.png

虽然相同包名相同类名的文件在不同 SDK 中出现的概率极低,但是一旦出现,处理起来就比较棘手。最好的解决方案就是联系提供 SDK 的技术人员反映问题,让其通过修改源码重新打包一个新的 Jar 包。

还有一个解决办法就是,重新命名 Jar 包里的包名或者文件名。网上也有一个工具:jarjar.jar,可以帮助我们重命名包名和文件名,以及 Jar 包中的相关代码引用路径。参考地址如下:

该工具提供有多种使用方式,最简单实用的就是通过命令行使用。举个例子,打开命令行工具,执行:

java -jar jarjar-1.4.jar process rule.txt example.jar example_output.jar

其中,rule.txt 是包含重命名规则的文件,内容如下:

rule p.rn.asm.** com.yifeng.example.@1

我们看一下重命名前后 Jar 包内容的代码对比图:

Paste_Image.png
Paste_Image.png

可以看到,不仅包名改变,Jar 包中的相关类引用路径也自动改变。这种 Jar 包重命名的方式虽然能解决重复引入包的问题,但不是长久之计,需要后续持续关注 SDK 的升级替换。
不同 Jar 包包含相同文件(路径也相同)的情况还有一种,就是 duplicate files 错误。多个 Jar 包包含重复的文件。这种情况在网上看到过,出自 StackOverFlow,错误提示类似:

Error:duplicate files during packaging of APK E:\Code\iDoc\app\build\outputs\apk\app-debug-unaligned.apk
    Path in archive: META-INF/license.txt
    Origin 1: E:\Code\iDoc\app\libs\spring-core-3.1.0.RELEASE.jar
    Origin 2: E:\Code\iDoc\app\libs\spring-web-3.1.0.RELEASE.jar
You can ignore those files in your build.gradle:
    android {
      packagingOptions {
        exclude 'META-INF/license.txt'
      }
    }

可以看到,解决方案已经在错误提示中有给出,使用 packagingOptions 配置的 exclude 语句删除重复文件即可,比如:

packagingOptions {
        exclude 'META-INF/DEPENDENCIES'
        exclude 'META-INF/NOTICE'
        exclude 'META-INF/LICENSE'
        exclude 'META-INF/LICENSE.txt'
        exclude 'META-INF/NOTICE.txt'
    }

最后再补充一点,关于 Gradle 依赖的 Scope 问题。通常依赖某个第三方库我们使用的都是 compile 关键字,实际上,还有一个 Provided 关键字偶尔也会用到。

打开 Project Structure,查看 Modules 的 Dependencies 内容时,可以看到每一个依赖项的右边有个 Scope 选项:

Paste_Image.png

compile 表示依赖的第三方库在工程编译阶段、测试阶段和 Apk 运行阶段都需要使用到;而 provided 表示该第三方库仅仅是在编译阶段和测试阶段使用到,不会出现在运行阶段,即表示不会打包到最终的 apk 文件中去,目标运行环境已经包含有该第三方库。(貌似 Dagger2 的使用可能会涉及到这个问题。)

关于 Scope 的详细介绍,可以参考文章:PROVIDED SCOPE IN GRADLE

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,062评论 25 707
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,497评论 18 139
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,679评论 6 342
  • 理论说完了,来次实践。 数据理解与预处理 数据来自kaggle的Give Me Some Credit项目,有15...
    九天朱雀阅读 1,275评论 0 2
  • 因为重要日子的临近,这些天学校那边紧锣密鼓而又井然有序的进行着各项相关事宜。我今天下午去学校参加彩排,看见家长和同...
    一瓶花开阅读 349评论 0 6