AndFix Bug热修复框架的使用



AndFix

这篇主要介绍alibaba的AndFix项目的使用，下一篇介绍 AndFix原理及源码解析。

Github：https://github.com/alibaba/AndFix

---

AndFix介绍

AndFix是一个Android App的在线热补丁框架。使用此框架，我们能够在不重复发版的情况下，在线修改App中的Bug。AndFix就是 “Android Hot-Fix”的缩写。 
就目前来说，AndFix支持Android 2.3到6.0版本，并且支持arm 与 X86系统架构的设备。完美支持Dalvik与ART的Runtime。 
AndFix 的补丁文件是以 .apatch 结尾的文件。 
AndFix是阿里巴巴开源项目。

---

Android上如何使用

1.在自定义Application中初始化，为了更早的修复应用中的bug。

package com.euler.andfix;

import android.app.Application;

import com.alipay.euler.andfix.patch.PatchManager;

/**
 * MainApplication 2015-11-12 下午2:07:11
 * 
 * @author 乔晓松 965266509@qq.com
 */
public class MainApplication extends Application {

    public PatchManager mPatchManager;

    @Override
    public void onCreate() {
        super.onCreate();
        // 初始化patch管理类
        mPatchManager = new PatchManager(this);
        // 初始化patch版本
        mPatchManager.init("1.0");
        // 加载已经添加到PatchManager中的patch
        mPatchManager.loadPatch();
    }
}

 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

2.如果有新的补丁需要修复，下载完成后，进行以下操作

//添加patch，只需指定patch的路径即可，补丁会立即生效
mPatchManager.addPatch(path);
 
 
1
2
 
 
1
2

3.当apk版本升级，需要把之前patch文件的删除，需要以下操作

//删除所有已加载的patch文件
mPatchManager.removeAllPatch();
 
 
1
2
 
 
1
2

---

patch文件的生成

使用工具：apkpatch-1.0.3 
原理：根据两个apk包，生成一个差异文件，就是所谓的补丁文件即patch文件。

命令 : apkpatch.bat -f new.apk -t old.apk -o output1 -k debug.keystore -p android -a androiddebugkey -e android

-f <new.apk> ：新版本
-t <old.apk> : 旧版本
-o <output> ： 输出目录
-k <keystore>： 打包所用的keystore
-p <password>： keystore的密码
-a <alias>： keystore 用户别名
-e <alias password>： keystore 用户别名密码
 
 
1
2
3
4
5
6
7
8
9
 
 
1
2
3
4
5
6
7
8
9

 
执行完命令，就会在输出目录中输出.apatch文件: 
 
new-c293df7dbc23f11214fdd020ea78d3b8.apatch：就是patch文件。

.apatch文件根目录内容： 
META_INF文件下内容： 
PATCH.MF文件内容：注：Patch-Classes就是改动过的class.

客户端请求服务器接口(api)，服务器根据用户传递的数据分析是否有需要修复的bug。 
如果有bug需要修复，就下载服务器指定的.apatch文件的链接，下载完后及时加载并修复，使用addpatch(path)方法，补丁会立即生效。

在Android Studio使用

maven dependency:

<dependency>
    <groupId>com.alipay.euler</groupId>
    <artifactId>andfix</artifactId>
    <version>0.3.1</version>
    <type>aar</type>
</dependency>
 
 
1
2
3
4
5
6
 
 

  
  

 
 
 
 
1
2
3
4
5
6

or gradle dependency:

dependencies {
    compile 'com.alipay.euler:andfix:0.3.1@aar'
}
 
 
1
2
3
 
 
1
2
3

在Eclipse使用

把Java层的代码引入到你的工程，配置Ndk开发环境并把jni Native代码添加进来。

代码混淆(ProGuard)

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