AndFix使用说明

作者: seewhy | 来源:发表于2015-12-08 10:14 被阅读32741次

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

介绍

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解析

相关文章

网友评论

  • f722cf8e76fd:我单独移植了JNI部分,编译时,uint64_t, int64_t, uint32_t, int32_t等类似类型找不到
  • Miyok:作者你好 请问我修复点击事件的时候总是修复失败
    例如:
    <Button
    android:id="@+id/register"
    android:layout_width="match_parent"
    android:layout_height="40dp"
    android:layout_centerHorizontal="true"
    android:onClick="login"
    android:text="注册"
    android:textColor="@android:color/white"
    android:textSize="16sp"
    />

    public void login(View view) {
    MyLog.e("start activity");
    int m = 10;
    int j = 0;
    MyLog.e("old");
    MyLog.e("old k = " + m / j);
    }

    修改为:
    public void login(View view) {
    MyLog.e("start activity");
    int m = 10;
    int j = 1;
    MyLog.e("new");
    MyLog.e("new k = " + m / j);
    }
    旧代码点击会报错,因为分母是0,改成新代码后,执行PatchManager.addPatch(path);之后,报错内容为:
    Process: test.sht.com.testproject, PID: 10930
    java.lang.IllegalArgumentException: Expected receiver of type test.sht.com.testproject.MainActivity_CF, but got test.sht.com.testproject.MainActivity
    at java.lang.reflect.Method.invoke(Native Method)
    at java.lang.reflect.Method.invoke(Method.java:372)
    为什么会出现“Expected receiver of type test.sht.com.testproject.MainActivity_CF, but got test.sht.com.testproject.MainActivity”这种问题呢?

    非常希望作者能解答我的问题 谢谢 QQ 371079719
  • c9ab661fb607:你好 请问下能修复fragment里面的代码吗, 为什么我这边在修复Activity里面代码的时候都是没问题的, 但是修复fragment的时候,里面好多系统方法都找不到。
  • efc4a5722e63:看了andfix源码博客,但是不太明白,代码是如何实现比较两个apk的差异,从而生成apatch
  • ppzhu100:https://github.com/alibaba/JAndFix JAndFix是一种基于Java实现的Android实时热修复方案,它并不需要重新启动就能生效。JAndFix是在AndFix的基础上改进实现,AndFix主要是通过jni实现对method(ArtMethod)结构题内容的替换。JAndFix是通过Unsafe对象直接操作Java虚拟机内存来实现替换。
  • 4de765d5dfc6:你好,想请问下,高于5.0的版本,只要我点击加载按钮(这个是我自己加的)
    然后点击事件就是加载补丁了,然后就会直接退出,不报错,闪退,也捕获不到异常
  • f00d23b7efab:请问下:我的patch都打成功了,但运行成功后的应用,添加patch之后也正常输入Toast,但是界面就是没什么变化
  • dc2153921ba7:请问下:我的patch都打成功了,但运行成功后的应用,打patch的地方有log出来,界面出不来,经常anr。是什么原因呢?
  • chuwe1:生成补丁文件一直报错
    C:\Users\chuwe\Desktop\apkpatch>apkpatch -f app2.0.apk -t app1.0.apk -o output -k keystore.jks -p 123456 -a keystore -e 123456

    java.lang.RuntimeException: can,t modified Field:VERSION_CODE(I), in class :Lcom/chuwe1/andfixdemo/BuildConfig;
    at com.euler.patch.diff.DiffInfo.addModifiedFields(DiffInfo.java:88)
    at com.euler.patch.diff.DexDiffer.compareField(DexDiffer.java:125)
    at com.euler.patch.diff.DexDiffer.compareField(DexDiffer.java:101)
    at com.euler.patch.diff.DexDiffer.compareField(DexDiffer.java:95)
    at com.euler.patch.diff.DexDiffer.diff(DexDiffer.java:32)
    at com.euler.patch.ApkPatch.doPatch(ApkPatch.java:68)
    at com.euler.patch.Main.main(Main.java:97)
  • 58c869877c9b:模拟器 6.0的操作系统 loadPatch时report java.util.zip.ZipException: File too short to be a zip file: 0 ,5.0正常,有解决方案吗?
  • 萧寒:第四步:生成一个.apatch格式的补丁文件,需要提供原apk,修复后的apk,这个俩个apk是签过名的吗
  • MaxChou7:试了一下没有成功。也没有报什么错,好无奈 :sweat:
  • rrrui:使用加固平台可能会使热补丁功能失效(看到有人在360加固提了这个问题,自己还未验证)。

    使用加固前的apk进行diff即可,亲测有效。 :smile:
    0eff36c2bfe7:@rome753 谢了。
    rome753:@XingHang 应该是两个apk对比
    0eff36c2bfe7:@rrrui 请问diff 什么意思?
  • Shinelwww:-keep class com.alipay.euler.andfix.** { *; } 混淆不对,这样相当于keep所有了
  • 阳翟后生:博主,你好,我在写应用的时候没有用过extends Application,请问这个Application这个入口应该怎么写呢?谢谢
  • 一点墨汁:我是修改了一下加载补丁的顺序。
    try {
    String apkVersion = PackageInfoUtil.getVersion(getApplicationContext());
    mPatchManager = new PatchManager(this);
    //先去更新补丁文件
    String patchFilePath = Environment.getExternalStorageDirectory().getAbsolutePath() + APATCH_PATCH;
    File patchFile = new File(patchFilePath);
    if (patchFile.exists()) {
    mPatchManager.addPatch(patchFilePath);
    //复制且加载补丁成功后,删除下载的补丁
    File f = new File(this.getFilesDir(), DIR + APATCH_PATCH);
    if (f.exists()) {
    boolean result = new File(patchFilePath).delete();
    if (!result) {
    Log.e(TAG, patchFilePath + "删除补丁失败");
    }
    }
    } else {
    L.d(TAG, "补丁文件不存在");
    }
    //然后再去加载补丁或者删除补丁
    mPatchManager.init(apkVersion);
    mPatchManager.loadPatch();
    } catch (IOException e) {
    e.printStackTrace();
    } catch (PackageManager.NameNotFoundException e) {
    e.printStackTrace();
    }
  • 114a53745cc2:楼主,我第一次补丁成功了,可是怎么打第二个补丁啊?在吗 在线等啊,方便的话留个QQ哈 谢谢啦
  • 一点墨汁:楼主,你好,我想问一下如何打多个补丁?多个补丁的话,补丁的名字是一样的吗
    一点墨汁:@seewhy 那如果名字都不一样,是如何通过代码去动态加载不同名字的补丁文件的?
    seewhy:@weareshare 运行过程中多次调用addPatch方法就可以加载多个补丁,补丁的名字需要和之前的都不一样才能被加载。重新启动app后,如果有多个补丁,加载的顺序是按照补丁生成的时间顺序~
  • a837a7b038bc:我在模拟器上2.3.3的环境下运行就crash了,这个支持到那些版本?
    seewhy:@lg500235 官方说是支持2.3 到 6.0,我估计在模拟器上可能兼容性会差一点。
  • 程序狮:“验证apatch文件的签名是否就是在使用apkpatch工具时使用的签名(如果不验证那么任何人都可以制作自己的apatch文件来对你的APP进行修改)
    验证optimize file的指纹(防止有人替换掉本地保存的补丁文件,所以要验证MD5码”

    这个怎么验证呢??
  • 弦小杰:赞赞赞,照着你的终于完成了,哈哈
  • 陆地蛟龙:感谢楼主分享。

本文标题:AndFix使用说明

本文链接:https://www.haomeiwen.com/subject/foushttx.html