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

AndroidExtend 2016-03

AndFix工作流程

关于AndFix的基本使用和使用流程在AndFix官方Github上已经说的比较详细，这里提取一下基本的修复流程，帮助初次使用者快速的使用AndFix，下面是简要流程图。

上面的流程不细说，接下来看看github上Download下来的代码导入Eclipse，对于Android Studio导入不再给出。

AndFix Demo

• 导入Android工程
  
  • 解压，导入Android工程samples目录下的AndFixDemoAndroid项目
  • 前面导入的项目会报错，因为此时没有加入lib依赖关系，所以这里需要导入AndFix-master作为整个工程，其实里面有很多文件都没有必要导入到工程，为了方便起见，导入进去也不会有任何影响
  • 设置AndFix-master为Lib工程，然后AndFixDemo工程依赖AndFix-masterLib工程即可，此时工程可以直接编译了。

• 运行项目，生成APK
  直接run，抓log如下
  

按照上面的流程图，这个apk就是线上的APK文件，将这个apk重命名为old.apk以备用

• 修复出现问题的Class文件，这里直接将A类替换为Fix类

线上的MainActivity类如下

public class MainActivity extends Activity {
    private static final String TAG = "euler";
    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        Log.e(TAG, A.a("good"));
        Log.e(TAG, "" + new A().b("s1", "s2"));
        Log.e(TAG, "" + new A().getI());
    }
    @Override
    protected void onDestroy() {
        super.onDestroy();
        android.os.Process.killProcess(android.os.Process.myPid());
    }
}

修复以后的

public class MainActivity extends Activity {
    private static final String TAG = "euler";
    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        Log.e(TAG, Fix.a("good"));
        Log.e(TAG, "" + new Fix().b("s1", "s2"));
        Log.e(TAG, "" + new Fix().getI());
    }
    @Override
    protected void onDestroy() {
        super.onDestroy();
        android.os.Process.killProcess(android.os.Process.myPid());
    }
}

• 接着再生成修复后的APK文件，重名为为new.apk保存以备用。

• 将上面两个文件old.apk和new.apk以及keystore文件都复制到apkpatch-1.0.3这个tools目录下

• 输入以下命令即可在output目录下生成.apatch文件
  

这里的命令稍微说明一下：(参数必选，如果没有输入会一直提示你正取的输入姿势，稍后我们来解答为什么需要这么严格的限制)

命令 : 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 用户别名密码

• 生成.patch文件以后，我们就可以直接把这个文件放到指定位置了，那么什么是指定位置呢？看看Demo上写了什么？定位到MainApplication这个类

public class MainApplication extends Application {
    private static final String TAG = "euler";
    private static final String APATCH_PATH = "/Download/out.apatch";
    /**
     * patch manager
     */
    private PatchManager mPatchManager;
    @Override
    public void onCreate() {
        super.onCreate();
        // initialize
        mPatchManager = new PatchManager(this);
        mPatchManager.init("1.0");
        Log.d(TAG, "inited.");
        // load patch
        mPatchManager.loadPatch();
        Log.d(TAG, "apatch loaded.");
        // add patch at runtime
        try {
            // .apatch file path
            String patchFileString = Environment.getExternalStorageDirectory()
                    .getAbsolutePath() + APATCH_PATH;
            mPatchManager.addPatch(patchFileString);
            Log.d(TAG, "apatch:" + patchFileString + " added.");
        } catch (IOException e) {
            Log.e(TAG, "", e);
        }
    }
}

L25 就是指定加载的patch文件目录，所以我们将上面生成的patch文件放到内部存储的.../Download/out.apatch目录即可

• patch文件放到指定目录以后，继续重新运行之前的old.apk，接下来观察一下log输出如下图所示就表示修复bug成功
  

为什么说是bug修复了呢，看看以下源码就清楚了
Class A

public class A {
    String s = "s";
    private static O o = new O("a");
    static int i = 10;
    public static String a(String str) {
        Log.i("euler", "fix error");
        return "a";
    }
    public int b(String s1, String s2) {
        Log.i("euler", "fix error");
        Log.i("euler", o.s);
        return 0;
    }
    public int getI() {
        return i;
    }
}

Class Fix

public class Fix {
    String s = "s";
    private static O o = new O("fix");
    static int i = 11;
    public static String a(String str) {
        Log.d("qq", str);
        Log.i("euler", "fix succes");
        return "b";
    }
    public int b(String s1, String s2) {
        Log.e("euler", s1);
        Log.e("euler", i + "==" + c());
        Log.i("euler", "fix succes" + s);
        Log.i("euler", o.s);
        return 0;
    }
    private String c() {
        return "a";
    }
    public int getI() {
        return i;
    }
}

AndFix 测试

测试机器：Genymotion
Android版本：2.3 - 5.1
测试结果：4.0 - 5.1 均通过，2.3Crash，附上Log如下(真机未测试)

03-03 01:44:29.000: E/AndroidRuntime(502): FATAL EXCEPTION: main
03-03 01:44:29.000: E/AndroidRuntime(502): java.lang.RuntimeException: Unable to start activity ComponentInfo{com.euler.andfix/com.euler.andfix.MainActivity}: java.lang.NullPointerException: null result when primitive expected
03-03 01:44:29.000: E/AndroidRuntime(502):  at android.app.ActivityThread.performLaunchActivity(ActivityThread.java:1647)
03-03 01:44:29.000: E/AndroidRuntime(502):  at android.app.ActivityThread.handleLaunchActivity(ActivityThread.java:1663)
03-03 01:44:29.000: E/AndroidRuntime(502):  at android.app.ActivityThread.access$1500(ActivityThread.java:117)
03-03 01:44:29.000: E/AndroidRuntime(502): 	at android.app.ActivityThread$H.handleMessage(ActivityThread.java:931)
03-03 01:44:29.000: E/AndroidRuntime(502):  at android.os.Handler.dispatchMessage(Handler.java:99)
03-03 01:44:29.000: E/AndroidRuntime(502):  at android.os.Looper.loop(Looper.java:130)
03-03 01:44:29.000: E/AndroidRuntime(502):  at android.app.ActivityThread.main(ActivityThread.java:3683)
03-03 01:44:29.000: E/AndroidRuntime(502):  at java.lang.reflect.Method.invokeNative(Native Method)
03-03 01:44:29.000: E/AndroidRuntime(502):  at java.lang.reflect.Method.invoke(Method.java:507)
03-03 01:44:29.000: E/AndroidRuntime(502):  at com.android.internal.os.ZygoteInit$MethodAndArgsCaller.run(ZygoteInit.java:839)
03-03 01:44:29.000: E/AndroidRuntime(502):  at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:597)
03-03 01:44:29.000: E/AndroidRuntime(502):  at dalvik.system.NativeStart.main(Native Method)
03-03 01:44:29.000: E/AndroidRuntime(502): Caused by: java.lang.NullPointerException: null result when primitive expected
03-03 01:44:29.000: E/AndroidRuntime(502):  at com.euler.andfix.MainActivity.onCreate(Native Method)
03-03 01:44:29.000: E/AndroidRuntime(502):  at android.app.Instrumentation.callActivityOnCreate(Instrumentation.java:1047)
03-03 01:44:29.000: E/AndroidRuntime(502):  at android.app.ActivityThread.performLaunchActivity(ActivityThread.java:1611)
03-03 01:44:29.000: E/AndroidRuntime(502):  ... 11 more

AndFix 局限性

• 不支持资源文件修改
• 不支持YunOs
• APK加固以后制作patch文件失效，加固前制作patch可以使用，但会影响加固效果
• mutildex是否支持，待验证。

上面埋下了一个坑，就是apkpatch工具输入的参数为什么是必须的，这个坑准备在下一篇博文中填，另外AndFix源码解析部分也会有博文更新，未完待续...