Android 使用android-support-multidex解决Dex超出方法数的限制问题

随着应用不断迭代,业务线的扩展,应用越来越大(比如集成了各种第三方sdk或者公共支持的jar包,项目耦合性高,重复作用的类越来越多),相信很多人都遇到过如下的错误:

 UNEXPECTED TOP-LEVEL EXCEPTION:  
 java.lang.IllegalArgumentException: method ID not in [0, 0xffff]: 65536 
 at com.android.dx.merge.DexMerger$6.updateIndex(DexMerger.java:501)  
 at com.android.dx.merge.DexMerger$IdMerger.mergeSorted(DexMerger.java:282)  
 at com.android.dx.merge.DexMerger.mergeMethodIds(DexMerger.java:490)  
 at com.android.dx.merge.DexMerger.mergeDexes(DexMerger.java:167)  
 at com.android.dx.merge.DexMerger.merge(DexMerger.java:188)  
 at com.android.dx.command.dexer.Main.mergeLibraryDexBuffers(Main.java:439)  
 at com.android.dx.command.dexer.Main.runMonoDex(Main.java:287)  
 at com.android.dx.command.dexer.Main.run(Main.java:230)  
 at com.android.dx.command.dexer.Main.main(Main.java:199)  
 at com.android.dx.command.Main.main(Main.java:103)  

 没错,你的应用中的Dex 文件方法数超过了最大值65536的上限,简单来说,应用爆棚了.

        那么让我们看一下为什么会引起这种错误:

        在Android系统中,一个App的所有代码都在一个Dex文件里面。Dex是一个类似Jar的存储了多有Java编译字节码的归档文件。因为Android系统使用Dalvik虚拟机,所以需要把使用Java Compiler编译之后的class文件转换成Dalvik能够执行的class文件。这里需要强调的是,DexJar一样是一个归档文件,里面仍然是Java代码对应的字节码文件。当Android系统启动一个应用的时候,有一步是对Dex进行优化,这个过程有一个专门的工具来处理,叫DexOptDexOpt的执行过程是在第一次加载Dex文件的时候执行的。这个过程会生成一个ODEX文件,即Optimised Dex。执行ODex的效率会比直接执行Dex文件的效率要高很多。但是在早期的Android系统中,DexOpt有一个问题,也就是这篇文章想要说明并解决的问题。DexOpt会把每一个类的方法id检索起来,存在一个链表结构里面。但是这个链表的长度是用一个short类型来保存的,导致了方法id的数目不能够超过65536个。当一个项目足够大的时候,显然这个方法数的上限是不够的。尽管在新版本的Android系统中,DexOpt修复了这个问题,但是我们仍然需要对低版本的Android系统做兼容.

        目前比较常用的方法:(1) 应用插件化,比如使用我正在参与开发的插件化框架 : https://github.com/singwhatiwanna/dynamic-load-apk ,如果有建议或者相关的问题,欢迎到Github上积极参与. (2) 分割Dex,多工程: 把所需要的.class文件或者是Jar文件和一些源码一起编译生成一个Jar文件。然后使用Android SDK提供的dx工具把Jar文件转成Dex文件。我们可以提前对它进行ODex操作,让它在被DexClassLoader加载的时候,跳过DexOpt的部分工作,从而加快加载的过程. 这两种方法并不冲突,插件化除了解决应用爆棚,还有很多其他的优点,可以看我之前的文章,不再复述.

        当然,Google看来也意识到了目前应用方法数爆棚的问题, 目前在已经在API 21中提供了通用的解决方案,那就是android-support-multidex.jar. 这个jar包最低可以支持到API 4的版本(Android L及以上版本会默认支持mutidex).

让我们看一下如何应用android-support-multidex.jar(以下都以在Anroid studio中的使用为例,使用eclipse开发需要安装gradle插件,其他基本上相同):

首先可以用--multi-dex配置(build.gradle)进行解决,生成的Apk中将包含多个dex文件,比如classes.dex, classes2.dex. 如下,需要对build.gradle进行修改:

 afterEvaluate {  
     tasks.matching {  
         it.name.startsWith('dex')  
     }.each { dx ->  
  if (dx.additionalParameters == null) {  
             dx.additionalParameters = []  
         }  
         dx.additionalParameters += '--multi-dex' // enable multidex 
  
  // optional 
  // dx.additionalParameters += "--main-dex-list=$projectDir/<filename>".toString() // enable the main-dex-list 
     }  
 }  

但是默认的Dalvik 类加载器只会寻找classes.dex,所以需要将它们进行合并才能使得被识别

当然,现在有了android.support.multidex.jar的支持,一切都会变得非常简单,首先我们看一下相关源码的目录,具体的原理分析我会在之后的文章中进行讲解:

 android/support/multidex/BuildConfig.class 
 android/support/multidex/MultiDex$V14.class 
 android/support/multidex/MultiDex$V19.class 
 android/support/multidex/MultiDex$V4.class 
 android/support/multidex/MultiDex.class 
 android/support/multidex/MultiDexApplication.class 
 android/support/multidex/MultiDexExtractor$1.class 
 android/support/multidex/MultiDexExtractor.class 
 android/support/multidex/ZipUtil$CentralDirectory.class 
 android/support/multidex/ZipUtil.class 

具体集成:

将如下配置加入工程 classPath中

 repositories {  
   jcenter()  
 }  
  
 dependencies {  
   compile 'com.google.android:multidex:0.1' 
 }  

MultiDex实现原理:

        Apk在运行的时候,有一个dexpathlist,而Multidex的源码中,会根据你的系统版本号对dexpathlist做修改,将所有的dex都添加到dexpathlist中.

接下来集成有两个步骤:

一. 从sdk\extras\android\support\multidex\library\libs 目录将android-support-multidex.jar导入工程中

二. 如果你的工程中已经含有Application类,那么让它继承android.support.multidex.MultiDexApplication类,

     如果你的Application已经继承了其他类并且不想做改动,那么还有另外一种使用方式,覆写attachBaseContext()方法:

 public class MyApplication extends FooApplication {  
  @Override 
  protected void attachBaseContext(Context base) {  
  super.attachBaseContext(base);  
         MultiDex.install(this);  
     }  
 }  

最后给出build.gradle中的完整配置:

 buildscript {  
     repositories {  
         jcenter()  
     }  
     dependencies {  
         classpath 'com.android.tools.build:gradle:0.13.3' 
         classpath 'jp.leafytree.gradle:gradle-android-scala-plugin:1.1' 
     }  
 }  
  
 apply plugin: 'com.android.application' 
 apply plugin: 'jp.leafytree.android-scala' 
  
 repositories {  
     jcenter()  
 }  
  
 android {  
     compileSdkVersion 21 
     buildToolsVersion '21.0.2' 
  
     defaultConfig {  
         applicationId 'some.app' 
         minSdkVersion 19 
         targetSdkVersion 19 
         versionCode 1 
         versionName '1.0' 
     }  
 }  
  
 dependencies {  
     compile 'com.google.android:multidex:0.1' 
     compile 'com.android.support:support-v4:19.0.1' 
     compile 'com.google.android.gms:play-services:5.0.77' 
     compile 'org.scala-lang:scala-library:2.11.2' 
     compile 'org.scaloid:scaloid_2.11:3.4-10' 
 }  

使用MutiDex的主意事项

一. 如果你继承了MutiDexApplication或者覆写了Application中的attachBaseContext()方法.

Application类中逻辑的注意事项:

Application 中的静态全局变量会比MutiDex instal()方法优先加载,所以建议避免在Application类中使用main classes.dex文件中可能使用到的静态变量,可以根据如下所示的方式进行修改:

 @Override 
  public void onCreate() {  
  super.onCreate();  
  
  final Context mContext = this;  
  new Runnable() {  
  
  @Override 
  public void run() {  
  // put your logic here! 
  // use the mContext instead of this here 
             }  
         }.run();  
     }  

二. 虽然Google解决了应用总方法数限制的问题,但并不意味着开发者可以任意扩大项目规模。Multidex仍有一些限制:

  1. DEX文件安装到设备的过程非常复杂,如果第二个DEX文件太大,可能导致应用无响应。此时应该使用ProGuard减小DEX文件的大小。
  2. 由于Dalvik linearAlloc的Bug,应用可能无法在Android 4.0之前的版本启动,如果你的应用要支持这些版本就要多执行测试。
  3. 同样因为Dalvik linearAlloc的限制,如果请求大量内存可能导致崩溃。Dalvik linearAlloc是一个固定大小的缓冲区。在应用的安装过程中,系统会运行一个名为dexopt的程序为该应用在当前机型中运行做准备。dexopt使用LinearAlloc来存储应用的方法信息。Android 2.2和2.3的缓冲区只有5MB,Android 4.x提高到了8MB或16MB。当方法数量过多导致超出缓冲区大小时,会造成dexopt崩溃。
  4. Multidex构建工具还不支持指定哪些类必须包含在首个DEX文件中,因此可能会导致某些类库(例如某个类库需要从原生代码访问Java代码)无法使用。

避免应用过大、方法过多仍然是Android开发者要注意的问题。Mihai Parparita的开源项目dex-method-counts可以用于统计APK中每个包的方法数量。

通常开发者自己的代码很难达到这样的方法数量限制,但随着第三方类库的加入,方法数就会迅速膨胀。因此选择合适的类库对Android开发者来说尤为重要。

开发者应该避免使用Google Guava这样的类库,它包含了13000多个方法。尽量使用专为移动应用设计的Lite/Android版本类库,或者使用小类库替换大类库,例如用Google-gson替换Jackson JSON。而对于Google Protocol Buffers这样的数据交换格式,其标准实现会自动生成大量的方法。采用Square Wire的实现则可以很好地解决此问题。

常见问题

DexException: Library dex files are not supported in multi-dex mode,你可能会见到如下的错误:

 Error:Execution failed for task ':app:dexDebug'.  
 > com.android.ide.common.internal.LoggedErrorException: Failed to run command:  
     $ANDROID_SDK/build-tools/android-4.4W/dx --dex --num-threads=4 --multi-dex  
     ...  
   Error Code:  
  2 
   Output:  
     UNEXPECTED TOP-LEVEL EXCEPTION:  
     com.android.dex.DexException: Library dex files are not supported in multi-dex mode  
         at com.android.dx.command.dexer.Main.runMultiDex(Main.java:322)  
         at com.android.dx.command.dexer.Main.run(Main.java:228)  
         at com.android.dx.command.dexer.Main.main(Main.java:199)  
         at com.android.dx.command.Main.main(Main.java:103)  

对于dex 的--multi-dex 选项设置与预编译的library工程有冲突,因此如果你的应用中包含引用的lirary工程,需要将预编译设置为false:

 android {  
  // ... 
     dexOptions {  
         preDexLibraries = false 
     }  
 }  

OutOfMemoryError: Java heap space

当运行时如果看到如下错误:

 UNEXPECTED TOP-LEVEL ERROR:  
 java.lang.OutOfMemoryError: Java heap space  

在dexOptions中有一个字段用来增加java堆内存大小:

 android {  
  // ... 
     dexOptions {  
         javaMaxHeapSize "2g" 
     }  
 }      
  

使用eclipse的开发人员可以参考Google官方文档

https://developer.android.com/tools/building/multidex.html#mdex-gradle

需要安装支持gradle构建的插件,下载地址:

http://dist.springsource.com/release/TOOLS/gradle  (目前可能需要翻墙) 

参考相关资料:

1. MutiDex 官方文档https://developer.android.com/reference/android/support/multidex/MultiDex.html

2. http://blog.osom.info/2014/10/multi-dex-to-rescue-from-infamous-65536.html

另附android -support-mutidex.jar下载地址: http://download.csdn.net/detail/t12x3456/8143383

补充注意事项:

 com.android.dex.DexException: Multiple dex files define L{package}/BuildConfig;  

如果遇到这个错误请进行如下检查:

1. 主工程与依赖library工程包名是否重复 2. 检查主工程与依赖library工程是否含有重复的support.jar或者其他jar包

解决方案:

1. 修改library工程包名

2. 删除重复jar包

3.手工添加lib包,增加如下配置

 dependencies {  
             compile fileTree(dir: 'libs', include: ['*.jar'])  
             compile project(':lib-project-module')  
         }  

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏一个爱瞎折腾的程序猿

asp.net core使用Swashbuckle.AspNetCore(swagger)生成接口文档

开局一张图,然后开始编,一些基本的asp.net core东西就不再赘述,本文只对Swashbuckle.AspNetCore的几个使用要点进行描述。

1361
来自专栏Linux驱动

15.linux-LCD层次分析(详解)

如果我们的系统要用GUI(图形界面接口),这时LCD设备驱动程序就应该编写成frambuffer接口,而不是像之前那样只编写操作底层的LCD控制器接口。 什么是...

2506
来自专栏空帆船w

Android 专用的日志封装库

所以在程序开发或者上线后如果出现了 Bug,能够及时查看日志,对修复 Bug 非常有帮助。

852
来自专栏老码农专栏

ActFramework R1.4.0 带来 WebSocket 的支持

1123
来自专栏Java帮帮-微信公众号-技术文章全总结

JavaWeb11-jsp.cookie.session(1)

? Jsp&cookie & session 一.jsp 1. jsp的介绍 JSP全名为Java Server Pages,中文名叫java服务器页面,本质...

2935
来自专栏雨过天晴

转 PHP-redis编译成功

1673
来自专栏坚毅的PHP

jersey处理支付宝异步回调通知的问题:java.lang.IllegalArgumentException: Error parsing media type 'application/x-www

tcpflow以流为单位分析请求内容,非常适合服务器端接口类服务查问题 这次遇到的问题跟支付宝支付后的回调post结果有关 淘宝的代码例子: publi...

5465
来自专栏java达人

ThreadLocal与Spring 事务管理

编写线程安全代码的关键是管理程序中的共享可变状态,除了通过synchronized加锁机制防止多个线程同时访问同一段数据外,还有一种方法就是通过ThreadLo...

22610
来自专栏lgp20151222

rabbit的简单搭建,java使用rabbitmq queue的简单例子和一些坑

由于本人的码云太多太乱了,于是决定一个一个的整合到一个springboot项目里面。

3031
来自专栏散尽浮华

Linux系统下的用户密码设定梳理

随着linux使用的普遍,对于linux用户以及系统的安全要求越来越高,而用户密码复杂程度是系统安全性高低的首要体现。因此如何对linux下用户的密码进行规则限...

2829

扫码关注云+社区