@linux1s1s 2017-01-22T16:55:28.000000Z 字数 7195 阅读 2005

Android 在线热修复框架 AndFix 初步四

AndroidExtend 2016-03

我们接着分析阿里开源的AndFix库，上次留下了三个坑，一个方法，两个类，不知道你们是否想急切了解呢？ loadPatch()方法和AndFixManager和Patch类。

分析loadPatch()方法的时候离不开AndFixManager这个类，所以，我会在分析loadPatch()方法的时候分析AndFixManager这个类。 Patch类相当于一个容器，把修复bug所需的信息放在其中，Patch类相对来说比较独立，不需要牵扯到另外两个坑，所以，就先把这个坑埋了。

要分析Patch类，就不能不分析阿里提供的打包.apatch的工具apkpatch-1.0.2.jar，Patch获取的信息其实就是apkpatch打包时放入其中的信息。我下面对apkpatch.jar的分析以这个版本的源码为准。

分析源码，那些try-catch-finally和逻辑无关，所以，我会把这些代码从源码中删掉的，除非有提示用户的操作

我们先来看看Patch类
从前一篇的分析中，我们看到调用了Patch的构造函数，那我们就从构造函数开始看。

public Patch(File file) throws IOException {
    this.mFile = file;
    this.init();
}

将传入的文件保存在类变量中，并调用init()函数，那么init()函数干什么呢？代码里异常和清理的代码我给删掉了，毕竟，这和我们对源码的分析关系不大，那么我们看一下剩下的代码

public void init(){
    JarFile jarFile = new JarFile(this.mFile);
    JarEntry entry = jarFile.getJarEntry(ENTRY_NAME);
    InputStream inputStream = jarFile.getInputStream(entry);
    Manifest manifest = new Manifest(inputStream);
    Attributes main = manifest.getMainAttributes();
    this.mName = main.getValue(PATCH_NAME);
    this.mTime = new Date(main.getValue(CREATED_TIME));
    this.mClassesMap = new HashMap();
    Iterator it = main.keySet().iterator();
    while(it.hasNext()) {
        Name attrName = (Name)it.next();
        String name = attrName.toString();
        if(name.endsWith(CLASSES)) {
            List strings = Arrays.asList(main.getValue(attrName).split(","));
            if(name.equalsIgnoreCase(PATCH_CLASSES)) {
                this.mClassesMap.put(this.mName, strings);
            } else {
                this.mClassesMap.put(name.trim().substring(0, name.length() - 8), strings);
            }
        }
    }
}

先分析上面的代码，通过JarFile, JarEntry, Manifest, Attributes一层层的获取jar文件中值，并放入对应的类变量中这些值是从哪里来的呢？是从生成这个.apatch文件的时候写入的，即apkpatch.jar文件中写入的。虽然这个文件后缀名是apatch，不是jar，但是它生成的时候是使用Attributes，Manifest，jarEntry将数据写入的，其实依旧是jar格式，修改了扩展名而已

上面的那些常量都是什么呢，我们来看看这个类的类变量，就是一些对应的字符串。

private static final String ENTRY_NAME = "META-INF/PATCH.MF";
private static final String CLASSES = "-Classes";
private static final String PATCH_CLASSES = "Patch-Classes";
private static final String CREATED_TIME = "Created-Time";
private static final String PATCH_NAME = "Patch-Name";
private final File mFile;
private String mName;
private Date mTime;
private Map<String, List<String>> mClassesMap;

看完了Patch类，是不是还一头雾水呢, 其他的好理解， mClassesMap里面的各种类名是从哪里来，里面的类作用又是什么呢？这里，我们就需要进入apkpatch.jar一探究竟。这个Jar包作用就是生成patch包，这个已经在第二篇博文中详细介绍了，所以可以直接参考Android 在线热修复框架 AndFix 初步二。

到这里，Patch类基本作用就明白了，这个类相当于我们提供补丁的容器，容器里有了东西，我们要对容器进行操作了。于是我们开始填最后两个坑，即loadPatch()方法和AndFixManager类。

在阿里给的Demo里，我们还有最后的loadPatch()方法没有深入，所以先从loadPatch()方法开始。

public void loadPatch() {
    mLoaders.put("*", mContext.getClassLoader());// wildcard
    Set<String> patchNames;
    List<String> classes;
    for (Patch patch : mPatchs) {
        patchNames = patch.getPatchNames();
        for (String patchName : patchNames) {
            classes = patch.getClasses(patchName);
            mAndFixManager.fix(patch.getFile(),mContext.getClassLoader(), classes);
        }
    }
}

不知道大家是否还记得之前提到的mLoaders这个成员变量，隔了这么久，说实话我也忘记了，在这里我先带大家一起回忆一下， private final Map mLoaders;，mLoaders原来是储存不同ClassLoader的Map啊。好的，我们继续向下进行，在第一篇，通过private的initPatchs()方法，和public的addPatch()方法，将Patch加入了mPatchs这个List，所以，这里只要去遍历这个List，来获取不同的Patch，并对每个Patch做操作即可。每个Patch，代表了一个.apatch的文件，getClasses(patchName)代表着这个patch的patchName对应的所有需要修改的类。 patchName从两方面而来，一个是你用apkpatch.jar的时候使用-n选项指定或者默认的，另外一个方面是写入Manifest的时候以 -Classes结尾的key，这个我暂时还没有遇到过，遇到过的同学可以给我讲讲，抱歉博客暂时没有评论功能，可以发邮件给我,airzhaoyn@gmail.com。

好了，这里讲的差不多了，我们继续深入。可以看到，获取了一个patchName对应的所有的需要修改的类后，就会调用AndFixManager类的fix(File, ClassLoader,List)方法，先来看看源码

/**
 * fix
 * 
 * @param file
 *            patch file
 * @param classLoader
 *            classloader of class that will be fixed
 * @param classes
 *            classes will be fixed
 */
public synchronized void fix(File file, ClassLoader classLoader,
        List<String> classes) {
    //是否是支持的Android版本(在AndFixManager类初始化的时候会修改mSupport变量)
    if (!mSupport) {
        return;
    }
    //验证这个文件的签名和此应用是否一致
    if (!mSecurityChecker.verifyApk(file)) {// security check fail
        return;
    }
    //这段代码的源码中的注释很清楚，我就不写了
    File optfile = new File(mOptDir, file.getName());
    boolean saveFingerprint = true;
    if (optfile.exists()) {
        // need to verify fingerprint when the optimize file exist,
        // prevent someone attack on jailbreak device with
        // Vulnerability-Parasyte.
        // btw:exaggerated android Vulnerability-Parasyte
        // http://secauo.com/Exaggerated-Android-Vulnerability-Parasyte.html
        if (mSecurityChecker.verifyOpt(optfile)) {
            saveFingerprint = false;
        } else if (!optfile.delete()) {
            return;
        }
    }
    //start
    final DexFile dexFile = DexFile.loadDex(file.getAbsolutePath(),
            optfile.getAbsolutePath(), Context.MODE_PRIVATE);
    if (saveFingerprint) {
        mSecurityChecker.saveOptSig(optfile);
    }
    ClassLoader patchClassLoader = new ClassLoader(classLoader) {
        @Override
        protected Class<?> findClass(String className)
                throws ClassNotFoundException {
            Class<?> clazz = dexFile.loadClass(className, this);
            if (clazz == null
                    && className.startsWith("com.alipay.euler.andfix")) {
                return Class.forName(className);// annotation’s class
                                                // not found
            }
            if (clazz == null) {
                throw new ClassNotFoundException(className);
            }
            return clazz;
        }
    };
    //Enumerate the names of the classes in this DEX file.
    Enumeration<String> entrys = dexFile.entries();
    Class<?> clazz = null;
    while (entrys.hasMoreElements()) {
        String entry = entrys.nextElement();
        if (classes != null && !classes.contains(entry)) {
            continue;// skip, not need fix
        }
        clazz = dexFile.loadClass(entry, patchClassLoader);
        if (clazz != null) {
            fixClass(clazz, classLoader);
        }
    }
}

对这部分的源码解析，从源码中标注//start开始。我们先看一下DexFile是什么，官方文档这样说：Manipulates DEX files. It is used primarily by class loaders. 就是主要被类加载器使用的操作Dex文件的类。好了，我们可以继续看源码了，先获取一个DexFile对象的，然后通过匿名内部类实现了一个ClassLoaders的子类，遍历这个Dex文件中所有的类，如果需要修改的类集合(即从PatchManager loadPatch()方法中传过来的类集合)中在这个Dex文件中找到了一样的类，则使用loadClass(String, ClassLoader)加载这个类，然后调用fixClass(String, ClassLoader)修复这个类。

private void fixClass(Class<?> clazz, ClassLoader classLoader) {
    //使用反射获取这个类中所有的方法
    Method[] methods = clazz.getDeclaredMethods();
    //MethodReplace是这个库自定义的Annotation，标记哪个方法需要被替换
    MethodReplace methodReplace;
    String clz;
    String meth;
    for (Method method : methods) {
        //找到被MethodReplace注解的方法
        methodReplace = method.getAnnotation(MethodReplace.class);
        if (methodReplace == null)
            continue;
        clz = methodReplace.clazz();
        meth = methodReplace.method();
        if (!isEmpty(clz) && !isEmpty(meth)) {
            replaceMethod(classLoader, clz, meth, method);
        }
    }
}

在源码中基本把这个方法给解读完了，接下来就要看看它调用的replaceMethod(ClassLoader, String,String, Method)方法

private void replaceMethod(ClassLoader classLoader, String clz,
            String meth, Method method) {
    //对每个类创建一个不会冲突的key
    String key = clz + "@" + classLoader.toString();
    //mFixedClass是一个Map<String, Class<?>>，并被实例化为ConcurrentHashMap<>();
    Class<?> clazz = mFixedClass.get(key);
    if (clazz == null) {// class not load
        Class<?> clzz = classLoader.loadClass(clz);
        // initialize target class and modify access flag of class’ fields to public
        clazz = AndFix.initTargetClass(clzz);
    }
    if (clazz != null) {// initialize class OK
        mFixedClass.put(key, clazz);
        //获取名为meth的方法
        Method src = clazz.getDeclaredMethod(meth,
                method.getParameterTypes());
        AndFix.addReplaceMethod(src, method);
    }
}

这里源代码中的英文注释(作者注释)已经很清楚了，去看看调用的那个静态方法AndFix.addReplaceMethod(src, method);

public static void addReplaceMethod(Method src, Method dest) {
    replaceMethod(src, dest);
    initFields(dest.getDeclaringClass());
}

replaceMethod是一个native方法，声明如下: private static native void replaceMethod(Method dest, Method src); 由于暂时我对JNI不是很熟悉，所以这里就不分析了。看看另外一个方法initFields(Class<?>)

/**
 * modify access flag of class’ fields to public
 * 
 * @param clazz
 *            class
 */
private static void initFields(Class<?> clazz) {
    Field[] srcFields = clazz.getDeclaredFields();
    for (Field srcField : srcFields) {
        Log.d(TAG, "modify " + clazz.getName() + "." + srcField.getName()
                + " flag:");
        setFieldFlag(srcField);
    }
}

这里英文注释也很清楚了，只是其中调用了setFieldFlag(srcField);这个我们没见过的方法，声明为private static native void setFieldFlag(Field field); 又是个JNI方法，暂时不进行分析。

到这里，对阿里AndFix库Java层面上的代码的分析就结束了，有兴趣的同学可以进一步了解Native层的具体实现，这里不再给出。

附注：此文章转载并微修改自AndFix解析，特此说明。

Android 在线热修复框架 AndFix 初步 四

内容目录

Android 在线热修复框架 AndFix 初步四