Android中64k方法数限制原理与解决

Posted by Wengdada on April 10, 2017

在Android项目中引入过多的jar会出现错误: android.dex.DexIndexOverflowException: Cannot merge new index xxxx into a non-jumbo instruction! 这个错误出现的原因是:早期的Dalvik VM内部使用short类型变量来标识方法的id,就有了 最大方法数的限制65536。所以 Android设定的方法数是65536个(DEX 64K problem),超过这个方法数,导致dex无法生成,就无法生成APK.

解决方法:

  • 删除不用的方法,删除不使用的jar 项目维护时间长了,里面会出现不再使用的类和不再使用的方法,建议集中清理下,把不再使用的方法,不再使用的类都清除,这样的好处是代码也干净了,如果方法数超出的不是太多的话通过清理就可以让方法数减少到65536以下,一般来说jar里面的方法数最好,清除一两个无用的jar包就能大大的减少方法数。

  • 分包 为了解决这个问题,Android开发社区有人想出了一些解决方案,比如dmarcato的这个,还有casidiablo的这个。他们都是可行的,但是需要一些比较严格的条件。Google决定提供一套官方的解决方案,在10月14日的时候发布了MultiDex 支持库,随后几周gradle在 v0.14.0版本中也支持了。通过在defaultConfig中设置multiDexEnabled可以开启分包模式,分包之后的Dex就低于了限制数,保证了正常的打包。

Android5.0之前

Dalvik在5.0之前,为每一个APK只生成一个classes.dex,所以会有上述所说的方法数超限的问题,如果我们可以将一个dex文件分成多个,在应用启动时,加载第一个(主dex)dex文件,当启动以后,再依次加载其他dex文件。这样就可以规避上述问题了。MultiDex即是实现了这样的功能

Android5.0之后

Android5.0及更高版本使用支持从apk中加载多个dex文件的ART运行时机制,在应用安装时,加载classed(…N).dex文件并编译成一个.oat文件以支持在Android设备上运行。

使用MultiDex支持库

 defaultConfig {
        multiDexEnabled=true
    }

如果你在使用 Android Studio,这个用起来很简单。如果不是,强烈建议你迁移过来。因为Google很快就会不知处Eclipse插件和旧的基于Ant的系统构建方式。

第1步 添加依赖于你的build.gradle支持MultiDex库

dependencies { ... compile 'com.android.support:multidex:' ... }

第2步 在buildType或productFlavor中开启multiDexEnabled。

defaultConfig { ... multiDexEnabled true ... }

现在,根据你的项目情况,你有3种选择:

如果你没有创建自己的Application 类,在你的清单文件AndroidManifest.xml中配置android.support.multidex.MultiDexApplication就可以了。

...android:name="android.support.multidex.MultiDexApplication" ...

如果你有自己的Application类了,让它继承 android.support.multidex.MultiDexApplication而不是android.app.Application 如果你的Application继承了其他的类,并且你不想改变或者没办法改变。按照下面的方法重写attachBaseContext()

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

特别注意,如果没有实现这部分代码,运行时会出现NoClassDefFoundError的错误,尤其是在依赖三方函数库时。

不论你选择上面哪种,都会创建多个大小差不多的dex文件代替单个庞大的dex文件。运行的时候回同事加载所有的这些dex文件。 编译app的时候,Gradle会生成很多个dex文件和一个apk文件让你可以在设备或者模拟器上运行。 虽然分包在大多数时候可以解决DEX 64K的问题,但是应该是保留使用。当你尝试使用它以前,请先尝试删除不需要的依赖并且使用ProGuard混淆,如果你必须要使用这个方案。请确保在旧设备上做了测试。

  • 忽略方法数限制的检查
    android.dexOptions {
      jumboMode = true
    }
    

设置dexOptions的,不做方法数限制的检查,这样做的缺点是apk无法再低版本的设备上面安装,会出现错误:

INSTALL_FAILED_DEXOPT 因为我们项目的 minSdkVersion为14,所以我采用了第三种的解决方案,不支持低版本的Android设备。

注意事项

  • Out of memory 问题 对于有很多依赖的项目,编译可能因为下面的错误中断
    Error:Execution failed for task ':app:dexDebug'. ... Error Code: 3 Output: UNEXPECTED TOP-LEVEL ERROR: java.lang.OutOfMemoryError: GC overhead limit exceeded at com.android.dx.cf.cst.ConstantPoolParser.parse0(ConstantPoolParser.java:326) ...
    

    在build.gralde android标签下面添加下面代码可以解决

    dexOptions { incremental true javaMaxHeapSize "4g" }
    
  • 应用启动缓慢

根据我们的经验,添加了这个支持库以后,大多数情况下都正常了。这对某些设备,比如Kindle Fire上面,应用启动会比之前慢很多。加载所有的类在应用一启动的时候会花费大量的时间。这就会导致黑屏一段时间,甚至导致ANR.

  • MultiDex与NoClassDefFoundError

这个问题之前出现过很多次,当时是由于配置了build.gradle文件但是没有使用MultiDexApplication造成的。所以开发者一定要记得使用MultiDexApplication或者MultiDex.install(this),具体参考上面提到过的配置Application。 还有一种情况,上面提到过的,使用MultiDex机制,必然存在主dex文件和从dex文件,应用启动时所需要的类,都应放入主dex中,否则也会出现NoClassDefFoundError。这种情况可以手动添加一些类到主dex中:

multiDexKeepFile 手动加入要放到Main.dex中的类

android/support/multidex/MultiDex.class

multiDexKeepProguard 以Proguard的方式手动加入要放到Main.dex中的类。

-keep class android.support.multidex.** {
  *;
}

然后在build.gradle中进行配置:

android {
  defaultConfig {
      multiDexEnabled true
      multiDexKeepProguard file('multiDexKeep.pro') 
      multiDexKeepFile file('multiDexKeep.txt') 
  }
}
dependencies {
  compile'com.android.support:multidex:1.0.1'
}

优化Multidex的开发和构建

multidex会加长构建应用的时间,这个必要的过程可能会拖慢你的开发进度。 为加速构建过程,我们可以在Gradle中配置productFlavors,可以参考Android工程gradle详解,里面很详细的介绍了productFlavors。开发时将minSdkVersion改为21使用ART运行时机制,这样能加快构建速度。release时改为合适的minSdkVersion,这样仅在release时费时较长。 build.gradle配置如下:

  android {
      productFlavors {
          dev {
              minSdkVersion 21
          }
          prod {
              minSdkVersion 14
          }
      }
            ...
      buildTypes {
          release {
           ...
          }
      }
  }
  dependencies {
    compile 'com.android.support:multidex:1.0.0'
  }

完成上述配置后,你可以使用结合了dev productFlavor和buildType属性的devDebug变体app。

这个变体app包含如下特性: 关闭了混淆(proguard) 支持multidex minSdkVersion 设置为 Android API level 21. 值得注意的是:上述配置后的devDebug变种app仅能运行在Android 5.0设备上。