Android热修复二（手写热更新代码）

最新推荐文章于 2024-04-09 16:31:28 发布

原创最新推荐文章于 2024-04-09 16:31:28 发布

· 996 阅读

7 ·

版权

文章标签：

#android

android 专栏收录该内容

30 篇文章

订阅专栏

Android热修复二（手写热更新）

上一篇： Android热修复一（热修复原理）

通过第一篇已经了解了原理了，想必动手实现也不是那么难了，下面到了激动人心的代码环节，决定课后不看代码自己手撸。

回顾一下基于类加载的热修复的实现步骤：

反射获取当前程序的PathClassLoader
反射获取DexPathClassLoader的pathList属性
反射获取pathList中的属性dexElements
把自己的补丁包 patch.dex 转化为 Elements[]数组 pathElements
将pathElements 插入到 dexElements最前面，得到新的 newElements
将newElements反射替换原来的dexElements

不废话，手撸开始。

编写测试代码：

首先建立一个MainActivity,通过点击事件来查看代码信息：

public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
    }

    public void onClick(View view) {
        switch (view.getId()){
            case R.id.btn_test:
                Toast.makeText(this, BugTest.getMessage(), Toast.LENGTH_SHORT).show();
                break;
        }
    }
}

BugTest.java:

public class BugTest {
    public static String getMessage() {
        return "程序出bug了，赶紧叫人来修补！！！";
    }
}

超简单的代码，正常点击，会提示 “程序出bug了，赶紧叫人来修补！！！”

下面对上面的代码做修复，目的是修改BugTest#getMessage() 方法。

我们程序中会多出用到反射，而且很多都是从父类中查找属性和方法，考虑到两个函数

getMethod/getField() 可以得到自己和父类的所有public 方法，但是不能获取非public的
getDeclaredMethod()/getDeclaredField() 可以得到自己类中包括非public所有方法,但是不能获取父类中方法

但是我们的需求既要父类的，也需要获取非public方法，所以有必要封装一个反射的工具类ReflectUtil.java:

package com.dragonforest.app.qqhotfix.util;

import android.util.Log;

import java.lang.reflect.Field;
import java.lang.reflect.Method;

import static android.content.ContentValues.TAG;

/**
 * 反射工具类
 *
 * @author 韩龙林
 * @date 2019/9/26 10:23
 */
public class ReflectUtil {

    /**
     * 反射获取属性 会从所有父类中找，不区分private
     */
    public static Field getField(Class cls, String fieldName) {
        // 如果自己类中找不到 就去父类中递归查找
        Field declaredField = null;
        while (cls != null) {
            Log.e(TAG, "getField: 当前类" + cls.getName());
            try {
                declaredField = cls.getDeclaredField(fieldName);
                if (declaredField != null) {
                    declaredField.setAccessible(true);
                    return declaredField;
                }
            } catch (NoSuchFieldException e) {
                e.printStackTrace();
            }
            cls = cls.getSuperclass();
        }
        // 没有找到
        return null;
    }

    /**
     * 反射获取方法 会从所有父类中找，不区分private  注意方法需要传入参数
     */
    public static Method getMethod(Class cls, String methodName, Class<?>... paramTypes) {

        // 如果自己类中找不到 就去父类中递归查找
        Method declaredMethod = null;
        while (cls != null) {
            try {
                declaredMethod = cls.getDeclaredMethod(methodName, paramTypes);
                if (declaredMethod != null) {
                    declaredMethod.setAccessible(true);
                    return declaredMethod;
                }
                cls = cls.getSuperclass();
            } catch (NoSuchMethodException e) {
                e.printStackTrace();
            }
        }

        // 没有找到
        return null;
    }
}

下面正式进入热修复的步骤，编写一个FixUtil.java:

package com.dragonforest.app.qqhotfix.util;

import android.content.Context;
import android.os.Build;
import android.util.Log;

import java.io.File;
import java.io.IOException;
import java.lang.reflect.Array;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;

import static android.content.ContentValues.TAG;

/**
 * 修复类
 *
 * @author 韩龙林
 * @date 2019/9/26 10:29
 */
public class FixUtil {

    public static void installPatch(Context context, String patchPath) {
        File patchFile = new File(patchPath);
        if (!patchFile.exists()) {
            Log.e(TAG, "installPatch: " + patchPath + "无文件，无需修复");
            return;
        }
        File optDir = context.getCacheDir();
        try {
            // 1.得到当前程序的classLoader
            ClassLoader classLoader = context.getClassLoader();
            // 2.反射获取类加载器的pathList属性
            Class<? extends ClassLoader> pathClassLoaderCls = classLoader.getClass();
            Field pathListField = ReflectUtil.getField(pathClassLoaderCls, "pathList");
            Object pathList = pathListField.get(classLoader);
            // 3.反射获取DexPathList中的dexElements
            Field dexElementsField = ReflectUtil.getField(pathList.getClass(), "dexElements");
            Object[] dexElements = (Object[]) dexElementsField.get(pathList);
            // 4.加载自己的dex,并转化为Element[]
            // 通过反射DexPathList 中的makeDexElements() 方法来实现
            // 4.1 反射获取makeDexElements方法
            Object[] patchElements = null;
            // 版本适配
            if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N) {
                // Android 7.0+ 使用makeDexElements(List,File,List,ClassLoader)
                Method makeDexElementsMethod = ReflectUtil.getMethod(pathList.getClass(), "makeDexElements", List.class, File.class, List.class, ClassLoader.class);
                List<File> dexFileList = new ArrayList<>();
                dexFileList.add(patchFile);
                ArrayList<IOException> suppressedExceptions = new ArrayList<IOException>();
                patchElements = (Object[]) makeDexElementsMethod.invoke(null, dexFileList, optDir, suppressedExceptions, classLoader);
            } else if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
                // Android 6.0-7.0 使用makePathElements(List,File,List)
                Method makePathElements = ReflectUtil.getMethod(pathList.getClass(), "makePathElements", List.class, File.class, List.class);
                List<File> dexFileList = new ArrayList<>();
                dexFileList.add(patchFile);
                ArrayList<IOException> suppressedExceptions = new ArrayList<IOException>();
                patchElements = (Object[]) makePathElements.invoke(null, dexFileList, optDir, suppressedExceptions);
            } else if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
                // Android 5.0-6.0 使用makeDexElements(ArrayList,File,ArrayList)  注意这里参数编程ArrayList类型
                Method makeDexElementsMethod = ReflectUtil.getMethod(pathList.getClass(), "makeDexElements", ArrayList.class, File.class, ArrayList.class);
                List<File> dexFileList = new ArrayList<>();
                dexFileList.add(patchFile);
                ArrayList<IOException> suppressedExceptions = new ArrayList<IOException>();
                patchElements = (Object[]) makeDexElementsMethod.invoke(null, dexFileList, optDir, suppressedExceptions);
            } else if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT) {
                // Android 4.4-5.0 使用makeDexElements(ArrayList,File,ArrayList)  注意这里参数编程ArrayList类型
                // 和5.0一样的方法，注意4.4 会报错 Class ref in pre-verified class resolved to unexpected implementation
                Log.e(TAG, "installPatch: 当前版本：" + Build.VERSION.SDK_INT + "此版本暂未解决 Class ref in pre-verified class resolved to unexpected implementation 的问题，敬请期待！");
                return;
            } else {
                Log.e(TAG, "installPatch: 当前版本：" + Build.VERSION.SDK_INT + "不支持热更新");
                return;
            }
            // 5.合并两个Element[] patchElements要放在前面
            Object[] newElements = (Object[]) Array.newInstance(dexElements.getClass().getComponentType(), dexElements.length + patchElements.length);
            System.arraycopy(patchElements, 0, newElements, 0, patchElements.length);
            System.arraycopy(dexElements, 0, newElements, patchElements.length, dexElements.length);
            // 6.反射替换原来的dexElements
            dexElementsField.set(pathList, newElements);
            Log.e(TAG, "installPatch: 修复成功");
        } catch (Exception e) {
            e.printStackTrace();
            Log.e(TAG, "installPatch: 修复失败!!" + e.getMessage());
        }
    }
}

这个类包含了最核心的代码了，热更新的步骤就不说了，对版本适配做一下说明吧：

版本适配的点都在将文件dex转化为Elements数组的地方，不同版本的DexPathList方法中对应的方法有所区别（注意参数）：

Android 7.0 - 8.0 : 使用 makeDexElements(List,File,List,ClassLoader)
Android 6.0 - 7.0: 使用 makePathElements(List,File,List)
Android 5.0 - 6.0: 使用 makeDexElements(ArrayList,File,ArrayList)
android 4.4 - 5.0: 和5.0-6.0一样，但是4.4会报错 java.lang.IllegalAccessError: Class ref in pre-verified class resolved to unexpected implementation 具体原因，我正在研究。

最后就到用的环节了，我们在程序最开始启动的地方进行热修复，MyApplication#attachBaseContext:

package com.dragonforest.app.qqhotfix.application;

import android.app.Application;
import android.content.Context;

import com.dragonforest.app.qqhotfix.util.FixUtil;

import java.io.File;

/**
 * @author 韩龙林
 * @date 2019/9/26 12:52
 */
public class MyApplication extends Application {
    @Override
    protected void attachBaseContext(Context base) {
        super.attachBaseContext(base);
        FixUtil.installPatch(this,getFilesDir()+ File.separator+"patch.dex");
    }
}

这里传入的是getFilesDir() 没有使用getCacheDir() 应为后者在7.0上测试时会自动删除，所以没有使用。此外，7.0以后的私有目录结构有所修改。 7.0以前是 data/data/包名/files, 7.0以后变成了 data/user/0/包名/files了。

注意：这里热修复放在application中，是为了保证在加载所需要修复的类之前加载我们的补丁。也可以放在activity中，不过我们提前并不知道哪个类会出bug，所以在所有类加载之前进行修复。

生成补丁包：

首先将BugTest.java 修改成如下：

package com.dragonforest.app.qqhotfix.util;

/**
 * @author 韩龙林
 * @date 2019/9/26 10:24
 */
public class BugTest {
    public static String getMessage() {
        return "聪明的程序员已经通过热更新修补了！";
    }
}

我的步骤是 .java ---> .class ---> .jar ---> .dex

.java 编译成 .class javac -encoding UTF-8 com/dragonforest/app/qqhotfix/util/BugTest.java
.class 打包成 jar jar cvf patch.jar com/dragonforest/app/qqhotfix/util/BugTest.class
jar包转化为dex dx --dex --output=patch.dex patch.jar

至于配置dx什么的，去百度吧。

得到patch.dex, 然后上传到模拟器的私有目录的files下。

此时需要结束进程重启。即可看到更新代码已经生效。上诉代码已完成测试。下面去研究一下 android4.4上那个奇怪的问题啦。