Android10分钟手写热修复

目录

目录

效果展示

修复前
修复后

实现原理

Android中的类加载也是通过ClassLoader实现的，它加载类的时候是顺序遍历一个pathList的数组，该数组存放了所以需要加载的Class，假如我们的Class3出现了问题，这时我们只需要编译一个修复后的Class3并且将它的加载顺序放在出问题的Class3之前就可修复问题了（如上图所示）。
Android源码中的体现如下：

 @Override
    protected Class<?> findClass(String name) throws ClassNotFoundException {
        List<Throwable> suppressedExceptions = new ArrayList<Throwable>();
        Class c = pathList.findClass(name, suppressedExceptions);
        if (c == null) {
            ClassNotFoundException cnfe = new ClassNotFoundException(
                    "Didn't find class \"" + name + "\" on path: " + pathList);
            for (Throwable t : suppressedExceptions) {
                cnfe.addSuppressed(t);
            }
            throw cnfe;
        }
        return c;
    }

而如何将我们修复后的Class加载顺序排到出问题的Class之前呢？这就需要我们使用Java那强大的反射功能了。
首先我们需要利用ClassLoader对象获取到pathList这个属性

我们使用如下代码进行获取：

/**
     * 根据属性名找到对应属性
     * @param instance
     * @param name
     * @return
     */
    public static Field getField(Object instance,String name){
        Class<?> cls = instance.getClass();
        //当查找到了Object类还没找到的时候停止循环
        while (cls != Object.class){
            try {
                Field fied = cls.getDeclaredField(name);
                if(fied != null){
                    fied.setAccessible(true);
                }
                return fied;
            }catch (Exception e){
            }
            //假如当前的对象中没有这个属性就从父类中继续寻找，直到找到为止
            cls = cls.getSuperclass();
        }
        return null;
    }

接下来我们找到DexPathList这个类，查看它的源码发现它的findClass方法中遍历的是dexElements

public Class<?> findClass(String name, List<Throwable> suppressed) {
        for (Element element : dexElements) {
            Class<?> clazz = element.findClass(name, definingContext, suppressed);
            if (clazz != null) {
                return clazz;
            }
        }

        if (dexElementsSuppressedExceptions != null) {
            suppressed.addAll(Arrays.asList(dexElementsSuppressedExceptions));
        }
        return null;
    }

因此我们就可以得出结论，我们只要将我们修复后的Class文件的顺序放到dexElements数组的开头位置就能实现修复后的Class的加载顺序在出问题的Class的加载顺序之前了，具体代码实现如下：

/**
     * 热修复
     * @param context
     * @param patchFile 修复后的文件
     */
    public static void init(Context context, File patchFile){
        if(!patchFile.exists()){
            return;
        }
        //拿到ClassLoader
        ClassLoader classLoader = context.getClassLoader();
        try {
            //拿到pathList属性
            Field pathListField = ReflectUtils.getField(classLoader, "pathList");
            //根据属性拿到该属性的对象DexPathList
            Object pathList = pathListField.get(classLoader);

            //根据pathList拿到dexElements属性
            Field dexElementsField = ReflectUtils.getField(pathList, "dexElements");
            Object[] dexElements = (Object[]) dexElementsField.get(pathList);//dexElements是个数组

            //根据补丁包创建dexElements
            Method makeDexElementsMethod = ReflectUtils.getMethod(pathList, "makeDexElements", List.class, File.class, List.class,ClassLoader.class);
            //创建执行方法的第一个参数
            List<File> dexfiles = new ArrayList<>();
            dexfiles.add(patchFile);
            //创建执行方法的第二个参数
            File codeCacheDir = context.getCodeCacheDir();
            //创建执行方法的第三个参数
            ArrayList<IOException> suppressedExceptions = new ArrayList<IOException>();
            Object[] pathDexElements = (Object[]) makeDexElementsMethod.invoke(null, dexfiles, codeCacheDir, suppressedExceptions,classLoader);

            //根据以前的和补丁包生成的dexElements组合成一个新的Elements
            Object[] newDexElements = (Object[]) Array.newInstance(dexElements[0].getClass(), dexElements.length + pathDexElements.length);

            //将pathDexElements和dexElements的元素拷贝到新的数组中
            System.arraycopy(pathDexElements,0,newDexElements,0,pathDexElements.length);
            System.arraycopy(dexElements,0,newDexElements,pathDexElements.length,dexElements.length);

            //重新将dexElements属性赋值为新产生的数组
            dexElementsField.set(pathList,newDexElements);
        }catch (Exception e){
            System.out.println(e.getMessage());
        }
    }

其中makeDexElements方法的获取和调用是根据Android对应的源码来的：

如何生成修复文件

我们需要使用到build-tools里面的dx工具

具体使用方法如下：
首先我们得先运行一遍你修复后的代码（这样才能生成新的Class文件），比方说我之前为了让程序出现异常故意抛出了异常，现在我将他注释掉模拟修复后的代码：

public static void test(){
//        throw new IndexOutOfBoundsException("越界");
    }

然后我们将该文件运用dx工具生成一个修复包，具体命令如下：

dx --dex --output=patch.jar com\itfitness\hotfix\utils\TestUtil.class

另外要注意我们是在classes文件夹下执行的

生成完修复文件后我们需要将它放到存储卡中对应的位置

案例源码

https://github.com/myml666/HotFix