MultiDex的具体实现过程
一、代码示例
1、Gradle修改
修改Gradle的配置，支持multidex:
android {
compileSdkVersion 21
buildToolsVersion "21.1.0"
defaultConfig {
...
minSdkVersion 14
targetSdkVersion 21
...
// Enabling multidex support.
multiDexEnabled true
}
...
}
dependencies {
compile 'com.android.support:multidex:1.0.0'
}
2、manifest修改
在manifest文件中，在application标签下添加MultidexApplication Class的引用
...
二、实现源码
1、MultiDexApplication
public class MultiDexApplication extends Application {
public MultiDexApplication() {
}
protected void attachBaseContext(Context base) {
super.attachBaseContext(base);
MultiDex.install(this);
}
}
使用 MultiDexApplication的原因就是它重写了Application，主要是可以将其他dex文件注入到系统的ClassLoader
2、MultiDex
MultiDex.install，这个方法涵盖了MultiDex安装的整个流程：
publicstaticvoidinstall(Context context){
Log.i(TAG, "install");
// 检查当前系统是否支持multidex
if (IS_VM_MULTIDEX_CAPABLE) {
Log.i(TAG, "VM has multidex support, MultiDex support library is disabled.");
try {
clearOldDexDir(context);
} catch (Throwable t) {
Log.w(TAG, "Something went wrong when trying to clear old MultiDex extraction, "
+ "continuing without cleaning.", t);
}
return;
}
// MultiDex最低只支持到1.6
if (Build.VERSION.SDK_INT < MIN_SDK_VERSION) {
throw new RuntimeException("Multi dex installation failed. SDK " + Build.VERSION.SDK_INT
+ " is unsupported. Min SDK version is " + MIN_SDK_VERSION + ".");
}
try {
ApplicationInfo applicationInfo = getApplicationInfo(context);
if (applicationInfo == null) {
// Looks like running on a test Context, so just return without patching.
return;
}
synchronized (installedApk) {
// sourceDir对应于/data/app/.apk
String apkPath = applicationInfo.sourceDir;
// 若给定apk已经install过，直接退出
if (installedApk.contains(apkPath)) {
return;
}
installedApk.add(apkPath);
// MultiDex 最高只支持到20(Android 4.4W)，更高的版本不能保证正常工作
if (Build.VERSION.SDK_INT > MAX_SUPPORTED_SDK_VERSION) {
Log.w(TAG, "MultiDex is not guaranteed to work in SDK version "
+ Build.VERSION.SDK_INT + ": SDK version higher than "
+ MAX_SUPPORTED_SDK_VERSION + " should be backed by "
+ "runtime with built-in multidex capabilty but it's not the "
+ "case here: java.vm.version=\""
+ System.getProperty("java.vm.version") + "\"");
}
// 得到classLoader，它就是PathClassLoader是BaseDexClassLoaderd的子类，
// MultiDex主要通过修改pathList字段来添加更多的dex
// 后面就可以从这个PathClassLoader中拿到DexPathList中的Element数组
// 这个数组里面就包括由系统加载第一个dex包
ClassLoader loader;
try {
loader = context.getClassLoader();
} catch (RuntimeException e) {
/* Ignore those exceptions so that we don't break tests relying on Context like
* a android.test.mock.MockContext or a android.content.ContextWrapper with a
* null base Context.
*/
Log.w(TAG, "Failure while trying to obtain Context class loader. " +
"Must be running in test mode. Skip patching.", e);
return;
}
if (loader == null) {
// Note, the context class loader is null when running Robolectric tests.
Log.e(TAG,
"Context class loader is null. Must be running in test mode. "
+ "Skip patching.");
return;
}
// MultiDex的二级dex文件将存放在 /data/data//secondary-dexes 下
File dexDir = new File(context.getFilesDir(), SECONDARY_FOLDER_NAME);
// 从apk中查找并解压二级dex文件到/data/data//secondary-dexes
List files = MultiDexExtractor.load(context, applicationInfo, dexDir, false);
// 检查dex压缩文件的完整性
if (checkValidZipFiles(files)) {
// 开始安装dex
installSecondaryDexes(loader, dexDir, files);
} else {
Log.w(TAG, "Files were not valid zip files. Forcing a reload.");
/**
第一次检查失败，MultiDex会尽责的再检查一次
若第一次校验失败（dex文件损坏等），
MultiDex会重新调用MultiDexExtractor.load方法重查找加载二级dex文件列表，
值得注意的是此时forceReload的值为true，会强制重新从apk中解压dex文件
*/
files = MultiDexExtractor.load(context, applicationInfo, dexDir, true);
if (checkValidZipFiles(files)) {
// 开始安装dex
installSecondaryDexes(loader, dexDir, files);
} else {
// Second time didn't work, give up
throw new RuntimeException("Zip files were not valid.");
}
}
}
} catch (Exception e) {
Log.e(TAG, "Multidex installation failure", e);
throw new RuntimeException("Multi dex installation failed (" + e.getMessage() + ").");
}
Log.i(TAG, "install done");
}
1、检查虚拟机版本
跟虚拟机版本判断是否需要MultiDex;
在ART虚拟机中（部分4.4机器及5.0以上的机器），采用了Ahead-of-time（AOT）compilation技术，系统在apk的安装过程中，会使用自带的dex2oat工具对apk中可用的dex文件进行编译，并生成一个可在本地机器上运行的odex(optimized dex)文件，这样做会提高应用的启动速度。（但是安装速度降低了）
若不需要使用MultiDex，将使用clearOldDexDir清除/data/data/pkgName/code-cache/secondary-dexes目录下下所有文件
2、获取安装路径
根据applicationInfo.sourceDir的值获取安装的apk路径；安装完成的apk路径为 /data/app/.apk
3、安装检测
检查apk是否执行过MultiDex.install，若已经安装直接退出
4、获取二级dex列表
MultiDexExtractor.load获取apk中二级dex列表
5、校验dex压缩包的完整性
6、开始dex的安装
installSecondaryDexes 安装dex
// loader对应的就是PathClassLoader
// dexDir是dex的存放目录
// files对应的就是dex文件
private static void installSecondaryDexes(ClassLoader loader, File dexDir, List files) throws IllegalArgumentException, IllegalAccessException, NoSuchFieldException, InvocationTargetException, NoSuchMethodException, IOException {
if(!files.isEmpty()) {
if(VERSION.SDK_INT >= 19) {
MultiDex.V19.install(loader, files, dexDir);
} else if(VERSION.SDK_INT >= 14) {
MultiDex.V14.install(loader, files, dexDir);
} else {
MultiDex.V4.install(loader, files);
}
}
}
由于SDK版本不同，ClassLoader中的实现存在差异，所以使用了三个分支去执行dex的安装。这里我们选择MultiDex.V14.install进行分析，其他两个大同小异：
V14.install
private static void install(ClassLoader loader, List additionalClassPathEntries, File optimizedDirectory) throws IllegalArgumentException, IllegalAccessException, NoSuchFieldException, InvocationTargetException, NoSuchMethodException {
// 这个方法就是使用反射来得到loader的pathList字段
Field pathListField = MultiDex.findField(loader, "pathList");
// 得到loader的pathList字段后，我们就可以得到这个字段的值，也就是DexPathList对象
Object dexPathList = pathListField.get(loader);
// 这个方法就是将其他的dex文件Element数组和第一个dex的Element数组合并
// makeDexElements方法就是用来得到其他dex的Elements数组
MultiDex.expandFieldArray(dexPathList, "dexElements", makeDexElements(dexPathList, new ArrayList(additionalClassPathEntries), optimizedDirectory));
}
MultiDex在安装开始时，会先通过反射调用 BaseDexClassLoader 里DexPathList类型的pathList字段，接着通过pathList调用 DexPathList 的makeDexElements方法，将上面解压得到的additionalClassPathEntries（二级dex文件列表）封装成Element数组。
需要注意的是，makeDexElements最终会去进行dex2opt操作，这是一个比较耗时的过程，如果全部放在main线程去处理的话，比较影响用户体验，甚至可能引起ANR。
7、合并数组
调用 MultiDex.expandFieldArray 合并dex 数组
// instance对应的就是pathList对象
// fieldName 对应的就是字段名，我们要得到的就是pathList对象里面的dexElements数组
// extraElements对应的就是其他dex对应的Element数组
private static void expandFieldArray(Object instance, String fieldName, Object[] extraElements) throws NoSuchFieldException, IllegalArgumentException, IllegalAccessException {
// 得到Element数组字段
Field jlrField = findField(instance, fieldName);
// 得到pathList对象里面的dexElements数组
Object[] original = (Object[])((Object[])jlrField.get(instance));
// 创建一个新的数组用来存放合并之后的结果
Object[] combined = (Object[])((Object[])Array.newInstance(original.getClass().getComponentType(), original.length + extraElements.length));
// 将第一个dex的Elements数组复制到创建的数组中去
System.arraycopy(original, 0, combined, 0, original.length);
// 将其他dex的Elements数组复制到创建的数组中去
System.arraycopy(extraElements, 0, combined, original.length, extraElements.length);
// 将得到的这个合并的新数组的值设置到pathList对象的Element数组字段上
jlrField.set(instance, combined);
}
expandFieldArray同样是通过反射调用，找到pathList中的dexElements字段，并将上一步生成的封装了二级dex的Element数组添加到dexElements之后，完成整个安装流程
8、其他涉及的方法
MultiDexExtractor.load(……获取apk中可用的二级dex列表
/**
MultiDexExtractor.load会先判断是否需要从apk中解压dex文件，主要判断依据是：上次保存的apk（zip文件）的CRC校验码和last modify日期与dex的总数量是否与当前apk相同。此外，forceReload也会决定是否需要重新解压
*/
private static List load(Context context, ApplicationInfo applicationInfo, File dexDir,booleanforceReload)throwsIOException{
Log.i("MultiDex", "MultiDexExtractor.load(" + applicationInfo.sourceDir + ", " + forceReload + ")");
File sourceApk = new File(applicationInfo.sourceDir);
long currentCrc = getZipCrc(sourceApk);
List files;
if(!forceReload && !isModified(context, sourceApk, currentCrc)) {
try {
files = loadExistingExtractions(context, sourceApk, dexDir);
} catch (IOException var9) {
Log.w("MultiDex", "Failed to reload existing extracted secondary dex files, falling back to fresh extraction", var9);
files = performExtractions(sourceApk, dexDir);
putStoredApkInfo(context, getTimeStamp(sourceApk), currentCrc, files.size() + 1);
}
} else {
Log.i("MultiDex", "Detected that extraction must be performed.");
files = performExtractions(sourceApk, dexDir);
putStoredApkInfo(context, getTimeStamp(sourceApk), currentCrc, files.size() + 1);
}
Log.i("MultiDex", "load found " + files.size() + " secondary dex files");
return files;
}
解压apk
private static List performExtractions(File sourceApk, File dexDir)throwsIOException{
// extractedFilePrefix值为.apk.classes
String extractedFilePrefix = sourceApk.getName() + ".classes";
prepareDexDir(dexDir, extractedFilePrefix);
ArrayList files = new ArrayList();
ZipFile apk = new ZipFile(sourceApk);
try {
int e = 2;
// 扫描apk内所有classes2.dex、classes3.dex...文件
for(ZipEntry dexFile = apk.getEntry("classes" + e + ".dex"); dexFile != null; dexFile = apk.getEntry("classes" + e + ".dex")) {
// 解压路径为 /data/data//secondary-dexes/.classes2.dex.zip 、/data/data//secondary-dexes/.classes3.dex.zip ...
String fileName = extractedFilePrefix + e + ".zip";
File extractedFile = new File(dexDir, fileName);
files.add(extractedFile);
Log.i("MultiDex", "Extraction is needed for file " + extractedFile);
int numAttempts = 0;
boolean isExtractionSuccessful = false;
// 每个dex文件都会尝试3次解压
while(numAttempts < 3 && !isExtractionSuccessful) {
++numAttempts;
extract(apk, dexFile, extractedFile, extractedFilePrefix);
isExtractionSuccessful = verifyZipFile(extractedFile);
Log.i("MultiDex", "Extraction " + (isExtractionSuccessful?"success":"failed") + " - length " + extractedFile.getAbsolutePath() + ": " + extractedFile.length());
if(!isExtractionSuccessful) {
extractedFile.delete();
if(extractedFile.exists()) {
Log.w("MultiDex", "Failed to delete corrupted secondary dex \'" + extractedFile.getPath() + "\'");
}
}
}
if(!isExtractionSuccessful) {
throw new IOException("Could not create zip file " + extractedFile.getAbsolutePath() + " for secondary dex (" + e + ")");
}
++e;
}
} finally {
try {
apk.close();
} catch (IOException var16) {
Log.w("MultiDex", "Failed to close resource", var16);
}
}
return files;
}
解压成功后，会保存本次解压所使用的apk信息，用于下次调用MultiDexExtractor.load时判断是否需要重新解压：
private static void putStoredApkInfo(Context context,longtimeStamp,longcrc,inttotalDexNumber){
SharedPreferences prefs = getMultiDexPreferences(context);
Editor edit = prefs.edit();
// apk最后修改时间戳
edit.putLong("timestamp", timeStamp);
// apk的CRC校验码
edit.putLong("crc", crc);
// dex的总数量
edit.putInt("dex.number", totalDexNumber);
apply(edit);
}
如果apk未被修改，将会调用loadExistingExtractions方法，直接加载上一次解压出来的文件
privatestaticListloadExistingExtractions(Context context, File sourceApk, File dexDir)throwsIOException{
Log.i("MultiDex", "loading existing secondary dex files");
String extractedFilePrefix = sourceApk.getName() + ".classes";
int totalDexNumber = getMultiDexPreferences(context).getInt("dex.number", 1);
ArrayList files = new ArrayList(totalDexNumber);
for(int secondaryNumber = 2; secondaryNumber <= totalDexNumber; ++secondaryNumber) {
String fileName = extractedFilePrefix + secondaryNumber + ".zip";
File extractedFile = new File(dexDir, fileName);
if(!extractedFile.isFile()) {
throw new IOException("Missing extracted secondary dex file \'" + extractedFile.getPath() + "\'");
}
files.add(extractedFile);
if(!verifyZipFile(extractedFile)) {
Log.i("MultiDex", "Invalid zip file: " + extractedFile);
throw new IOException("Invalid ZIP file.");
}
}
return files;
}