相信很多人都认识了解过 热修复、热更新、热补丁(对于这个技术也没有特别标准的一种叫法,下面我统一叫热更新),之后的一年里,各种热更新方案如雨后春笋般出现,比较耳熟能详的就有Nuwa、Tinker、Andfix 和 Dexposed 等等,他们之间的区别以及优缺点就不在这里讨论了,鉴于它们的实际使用和局限性,美团的开发团队就脑洞大开了。
去年 Google 高调发布了 Android Studio 2.0,其中最重要的新特性Instant Run,实现了对代码修改的实时生效(热插拔)。美团开发团队在了解 Instant Run 原理之后,实现了一个兼容性更强的热更新方案,这就是产品化的hotpatch框架—–Robust,对于 Robust 的原理我们后面的文章再讨论,本篇只针对想快速上手的入门讲解
Android热更新方案Robust开源,新增自动化补丁工具
Robust 为每个类新增了一个类型为 ChangeQuickRedirect 的静态变量,并且在每个方法前,增加判断该变量是否为空的逻辑,如果不为空,走打基础包时插桩的逻辑,否则走正常逻辑。
使用步骤
1.集成了 Robust 后,生成 apk。保存期间的混淆文件 mapping.txt,以及 Robust 生成记录文件 methodMap.robust
2.使用注解 @Modify 或者方法 RobustModify.modify() 标注需要修复的方法
3.开启补丁插件,执行生成 apk 命令,获得补丁包 patch.jar
4.通过推送或者接口的形式,通知 app 有补丁,需要修复
5.加载补丁文件不需要重新启动应用
集成方法
1、在项目最外层的 build.gradle 添加两处插件
classpath 'com.meituan.robust:gradle-plugin:0.3.3'
classpath 'com.meituan.robust:auto-patch-plugin:0.3.3'
2、然后在项目的 build.gradle 添加
//apply plugin: 'auto-patch-plugin'(生成补丁的时候打开)
apply plugin: 'robust'(生成apk的时候打开)
compile 'com.meituan.robust:robust:0.3.3'
3、需要手动 copy 一份 robust.xml 的配置文件到app的目录下,该文件各个配置注释的很清楚,若没特殊要求,不需要修改
<?xml version="1.0" encoding="utf-8"?>
<resources>
<switch>
<!--true代表打开Robust,请注意即使这个值为true,Robust也默认只在Release模式下开启-->
<!--false代表关闭Robust,无论是Debug还是Release模式都不会运行robust-->
<turnOnRobust>true</turnOnRobust>
<!--<turnOnRobust>false</turnOnRobust>-->
<!--是否开启手动模式,手动模式会去寻找配置项patchPackname包名下的所有类,自动的处理混淆,然后把patchPackname包名下的所有类制作成补丁-->
<!--这个开关只是把配置项patchPackname包名下的所有类制作成补丁,适用于特殊情况,一般不会遇到-->
<!--<manual>true</manual>-->
<manual>false</manual>
<!--是否强制插入插入代码,Robust默认在debug模式下是关闭的,开启这个选项为true会在debug下插入代码-->
<!--但是当配置项turnOnRobust是false时,这个配置项不会生效-->
<!--<forceInsert>true</forceInsert>-->
<forceInsert>false</forceInsert>
<!--是否捕获补丁中所有异常,建议上线的时候这个开关的值为true,测试的时候为false-->
<catchReflectException>true</catchReflectException>
<!--<catchReflectException>false</catchReflectException>-->
<!--是否在补丁加上log,建议上线的时候这个开关的值为false,测试的时候为true-->
<!--<patchLog>true</patchLog>-->
<patchLog>false</patchLog>
<!--项目是否支持progaurd-->
<proguard>true</proguard>
<!--<proguard>false</proguard>-->
<!--项目是否支持ASM进行插桩,默认使用ASM,推荐使用ASM,Javaassist在容易和其他字节码工具相互干扰-->
<useAsm>true</useAsm>
<!--<useAsm>false</useAsm>-->
</switch>
<!--需要热补的包名或者类名,这些包名下的所有类都被会插入代码-->
<!--这个配置项是各个APP需要自行配置,就是你们App里面你们自己代码的包名,
这些包名下的类会被Robust插入代码,没有被Robust插入代码的类Robust是无法修复的-->
<packname name="hotfixPackage">
<name>com.project</name>
</packname>
<!--不需要Robust插入代码的包名,Robust库不需要插入代码,如下的配置项请保留,还可以根据各个APP的情况执行添加-->
<exceptPackname name="exceptPackage">
</exceptPackname>
<!--补丁的包名,请保持和类PatchManipulateImp中fetchPatchList方法中设置的补丁类名保持一致( setPatchesInfoImplClassFullName("com.meituan.robust.patch.PatchesInfoImpl")),
各个App可以独立定制,需要确保的是setPatchesInfoImplClassFullName设置的包名是如下的配置项,类名必须是:PatchesInfoImpl-->
<patchPackname name="patchPackname">
<name>com.project</name>
</patchPackname>
<!--自动化补丁中,不需要反射处理的类,这个配置项慎重选择-->
<noNeedReflectClass name="classes no need to reflect">
</noNeedReflectClass>
</resources>
现在可以编译项目 时间会比较长
先解释一下,在生成 apk 的时候使用 apply plugin:'robust',该插件会生成打补丁时需要的方法记录文件 methodMap.robust,该文件在打补丁的时候用来区别到底哪些方法需要被修复,所以有它才能打补丁。而上文所说的还有 mapping.txt 文件,该文件列出了原始的类,方法和字段名与混淆后代码间的映射。这个文件很重要,可以用它来翻译被混淆的代码。但也不是必须的,如果不需要混淆,可以不保留。这两个文件在生成apk后,分别在 build/outputs/robust/methodsMap.robust,build/outputs/mapping/mapping.txt(需要开启混淆后才会出现),我们需要自己分别拷贝到 app/robust 下,在 app 目录新建个叫 robust 的文件夹,把这两个文件放进去就 ok 了。
完成了第二步了。我们得到了 apk ,mapping.txt,methodMap.robust ,有了它们我们再继续生成补丁 patch.jar。
加载补丁的方法
new PatchExecutor(getActivity(), new PatchManipulateImp(), new RobustCallBack() {
@Override
public void onPatchListFetched(boolean b, boolean b1) {
}
@Override
public void onPatchFetched(boolean b, boolean b1, Patch patch) {
}
@Override
public void onPatchApplied(boolean b, Patch patch) {
}
@Override
public void logNotify(String s, String s1) {
}
@Override
public void exceptionNotify(Throwable throwable, String s) {
}
}).start();
注意 PatchManipulateImp
关于PatchManipulateImp这个类控制了补丁的加载策略,代码中也增加不少的注释,在这个类中实际负责补丁的下载、校验和使用策略等,这个类需要实现如下几个方法
要加载补丁肯定得知道 patch.jar 放在哪啊是吧,打开看一眼(不要害怕只有很少代码),为了方便展示,就把不太重要的三个方法缩起来了,copy 方法是普通文件拷贝的IO流,verifyPatch 方法本来是验证补丁有效性的,后来发现对普通使用者没有那么高要求,就改成了备份补丁的回调了,ensurePatchExist 方法就检测补丁存在与否,好了大概知道其它的方法就详细介绍下主要方法 fetchPatchList,回顾一下上面的xxx再联想到这里吧,既然我们要加载补丁,那么我们得知道补丁在哪啊,这个方法就是把补丁找出来给上面那个谁用的。所以说,补丁的位置你可以根据拉取下来保存的位置来找出来,把路径给 setLocalPath 就好。再有就 setPatchesInfoImplClassFullName 的包名需要和 robust.xml 配置的一样
新增加一个页面来测试补丁
public class RobustActivity extends AppCompatActivity {
private TextView text2;
@Override
@Modify
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.layout_robust);
text2 = findViewById(R.id.text2);
// text2.setText(getString());
text2.setText(getinfo());
}
private String getString() {
return "hello word";
}
@Add
public String getinfo() {
StringBuilder msg = new StringBuilder();
for (int i = 0; i < 10; i++) {
msg.append(i + "\n");
}
return msg.toString();
}
}
制作补丁并使用
我们所需要做的跳转后效果是修改一下textview显示内容而已,那么在被修改的页面需要怎么标注被修改的方法呢,就像这样,先科普一下,在 robust 的注意事项里面已经提到过,修改方法和字段会有一些局限性,那是因为 android 本身ProGuard的内联、优化导致的。所以要绕过这个本身的问题,要必须遵循一些规律了...以后再介绍这个。修改完这些,我们再去 build.gradle 修改一下,开启打补丁那个,关闭生成apk那个。之后再在终端执行一遍生成apk的命令行。直到终端那里出现 auto patch end successfully
美团已经提供了自动化生成补丁的工具
在项目的 build.gradle apply plugin: 'auto-patch-plugin'打开
注释掉生成apk的插件
再次点击 assembleRelease
出现 auto patch end successfully 表示补丁已经生成 此时在robust文件里面可以看到patch.jar
点击load_path
如果看到 apply result true 那么就大功告成了。
再点击jump
便可以看到加载的是补丁里面的方法
最后来张效果图