AndFix使用说明

2023年12月16日 138次阅读 来源: seewhy

原文首发于我的个人博客，欢迎访问(_)，转载请注明出处。

介绍

AndFix，全称是Android hot-fix。是阿里开源的一个Android热补丁框架，允许APP在不重新发布版本的情况下修复线上的bug。支持Android 2.3 到 6.0。

使用方式

  1. 首先添加依赖
    compile 'com.alipay.euler:andfix:0.3.1@aar'
  2. 然后在Application.onCreate() 中添加以下代码
patchManager = new PatchManager(context);
patchManager.init(appversion);//current version
patchManager.loadPatch();

可以用这句话获取appversion
String appversion= getPackageManager().getPackageInfo(getPackageName(), 0).versionName;
注意每次appversion变更都会导致所有补丁被删除,如果appversion没有改变，则会加载已经保存的所有补丁。

  1. 然后在需要的地方调用PatchManager的addPatch方法加载新补丁，比如可以在下载补丁文件之后调用。

  2. 之后就是打补丁的过程了，首先生成一个apk文件，然后更改代码，在修复bug后生成另一个apk。
    通过官方提供的工具apkpatch
    生成一个.apatch格式的补丁文件，需要提供原apk，修复后的apk，以及一个签名文件。
    可以直接使用命令apkpatch查看具体的使用方法。
    使用示例：
    apkpatch -o D:/Patch/ -k debug.keystore -p android-a androiddebugkey -e android f bug-fix.apk t release.apk

  3. 通过网络传输或者adb push的方式将apatch文件传到手机上，然后运行到addPatch的时候就会加载补丁。
    加载过的补丁会被保存到data/packagename/files/apatch_opt目录下，所以下载过来的补丁用过一次就可以删除了。

大致原理

apkpatch将两个apk做一次对比，然后找出不同的部分。可以看到生成的apatch了文件，后缀改成zip再解压开，里面有一个dex文件。通过jadx查看一下源码，里面就是被修复的代码所在的类文件,这些更改过的类都加上了一个_CF的后缀，并且变动的方法都被加上了一个叫@MethodReplace的annotation，通过clazz和method指定了需要替换的方法。
然后客户端sdk得到补丁文件后就会根据annotation来寻找需要替换的方法。最后由JNI层完成方法的替换。

多次打补丁

如果本地保存了多个补丁，那么AndFix会按照补丁生成的时间顺序加载补丁。具体是根据.apatch文件中的PATCH.MF的字段Created-Time。

安全性

readme提示开发者需要验证下载过来的apatch文件的签名是否就是在使用apkpatch工具时使用的签名，如果不验证那么任何人都可以制作自己的apatch文件来对你的APP进行修改。
但是我看到AndFix已经做了验证，如果补丁文件的证书和当前apk的证书不是同一个的话，就不能加载补丁。
官网还有一条，提示需要验证optimize file的指纹，应该是为了防止有人替换掉本地保存的补丁文件，所以要验证MD5码，然而SecurityChecker类里面也已经做了这个工作。。但是这个MD5码是保存在sharedpreference里面，如果手机已经root那么还是可以被访问的。

混淆

-printmapping proguard.map
首先需要生成mapping文件记录混淆规则，之后可以把printmapping 这句话注释掉，每次只使用applymapping。
-applymapping proguard.map
然后在下面加上

-keep class * extends java.lang.annotation.Annotation
-keepclasseswithmembernames class * {
    native <methods>;
}
-keep class com.alipay.euler.andfix.** { *; }

碰到的问题

刚开始做的demo中，每次产生的apatch文件用的名字都是相同的，结果导致只有第一次的补丁能生效。
看了源码后发现只有每次名字不同才能加载，log中应该也有提示，但是没注意到。

File src = new File(path);
File dest = new File(mPatchDir, src.getName());
if(!src.exists()){
    throw new FileNotFoundException(path);
}
if (dest.exists()) {
    Log.d(TAG, "patch [" + path + "] has be loaded.");
    return;
}

局限性

  • 不支持YunOS
  • 无法添加新类和新的字段
  • 需要使用加固前的apk制作补丁，但是补丁文件很容易被反编译，也就是修改过的类源码容易泄露。
  • 使用加固平台可能会使热补丁功能失效（看到有人在360加固提了这个问题，自己还未验证）。

与Nuwa对比

Nuwa是另一个热补丁框架，原理是基于QQ空间团队提出的安卓App热补丁动态修复技术介绍。
与Nuwa相比，AndFix有一下优点：

  • 不需要重启APP即可应用补丁。
  • 安全性更好，Nuwa后面的版本应该也会加上安全方面的内容。

但是也有缺点

  • 无法添加类和字段

参考

官方readme文档
各大热补丁方案分析和比较
Alibaba-AndFix Bug热修复框架原理及源码解析
AndFix解析

    原文作者：seewhy
    原文地址: https://www.jianshu.com/p/479b8c7ec3e3
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞