澳门新葡亰网址下载快速接入美团热修复Robust

by admin on 2020年4月16日

美团 Android 热更新方案 Robust 开源了。

相信很多人都认识了解过
热修复、热更新、热补丁(对于这个技术也没有特别标准的一种叫法,下面我统一叫热更新),之后的一年里,各种热更新方案如雨后春笋般出现,比较耳熟能详的就有Nuwa、Tinker、Andfix
和 Dexposed
等等,他们之间的区别以及优缺点就不在这里讨论了,鉴于它们的实际使用和局限性,美团的开发团队就脑洞大开了。

InstantRun

不得不说 InstantRun 真是个好东西。目前主流的热修复框架都有或多或少的参考
InstantRun 的某些技术点 。

我们知道,InstantRun 对应三种更新机制:

  • 冷插拔,我们称之为重启更新机制
  • 温插拔,我们称之为重启Activity更新机制
  • 热插拔,我们称之为热更新机制

Robust ,其热修复的关键技术点就是采用了 InstantRun
中的热更新机制,对应于多 ClassLoader 的动态加载方案,即一个 dex
文件对应一个新建 ClassLoader 。

Robust 是新一代热更新系统,对 Android
版本无差别兼容,无需发版就可以做到随时修改线上
bug,快速对重大线上问题作出反应。Robust 热更新系统借鉴 Instant Run
原理,实现了一个兼容性更强而且实时生效的热更新方案。其基本思路是,Robust
热更新系统在一个方法的入口处插入一段跳转代码,当发现某个方法出现 bug
就跳转执行补丁中的代码,略过原有代码的执行,否则执行原有方法体逻辑。

去年 Google 高调发布了 Android Studio 2.0,其中最重要的新特性Instant
Run,实现了对代码修改的实时生效(热插拔)。美团开发团队在了解 Instant
Run
原理之后,实现了一个兼容性更强的热更新方案,这就是产品化的hotpatch框架—–Robust,对于
Robust 的原理我们后面的文章再讨论,本篇只针对想快速上手的入门讲解

优势

  1. 支持Android2.3-7.X版本
  2. 高兼容性、高稳定性,修复成功率高达三个九
  3. 补丁下发立即生效,不需要重新启动
  4. 支持方法级别的修复,包括静态方法
  5. 支持增加方法和类
  6. 支持ProGuard的混淆、内联、优化等操作

优势

  • 支持 Android2.3-7.X 版本

  • 高兼容性、高稳定性,修复成功率高达三个九

  • 补丁下发立即生效,不需要重新启动

  • 支持方法级别的修复,包括静态方法

  • 支持增加方法和类

  • 支持 ProGuard 的混淆、内联、优化等操作

需要保存打包时生成的 mapping
文件以及 build/outputs/robust/methodsMap.robust 文件。

Android热更新方案Robust

大概流程

image

自动化补丁

自动化补丁是 Robust
实现的一个跃进,开源版本中也已经包含这部分工作。使用者只需要提交修改完
bug 后的代码,运行和线上 apk 打包同样的 gradle 命令即可,会在项目的
app/build/outputs/robust 目录下生成补丁。

具体实现原理和样例请查阅项目文档。

(文/开源中国)    

Android热更新方案Robust开源,新增自动化补丁工具

集成方法

  1. 在App的build.gradle,加入如下依赖

apply plugin: 'com.android.application'
//制作补丁时将这个打开,auto-patch-plugin紧跟着com.android.application
//apply plugin: 'auto-patch-plugin'
apply plugin: 'robust'
compile 'com.meituan.robust:robust:0.4.2'
  1. 在整个项目的build.gradle加入classpath

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
         classpath 'com.meituan.robust:gradle-plugin:0.4.2'
         classpath 'com.meituan.robust:auto-patch-plugin:0.4.2'
   }
}
  1. 项目发release版本,把签名文件在gradle中写好

   signingConfigs {
        debug {
            storeFile file("../robust.jks")
            storePassword "123456"
            keyAlias "robust"
            keyPassword "123456"
        }

        release {
            storeFile file("../robust.jks")
            storePassword "123456"
            keyAlias "robust"
            keyPassword "123456"
        }
    }

4.开启proguard混淆开关,robust做了混淆文件和代码的映射。

5.将robust项目源码中的app/src/robust.xml拷贝到自己项目下的app/src路径下

image

打开robust.xml修改两个地方

image

6.执行命令

./gradlew clean  assembleRelease --stacktrace --no-daemon

7.app/build/outputs文件夹下会生成mapping.txt,methodsMap.robust文件,将他们拷贝到app/robust文件夹中保存.

image

image

methodMap.robust,该文件在打补丁的时候用来区别到底哪些方法需要被修复,所以有它才能打补丁。而上文所说的还有
mapping.txt
文件,该文件列出了原始的类,方法和字段名与混淆后代码间的映射。

美团
Robust 的 github demo
地址

写代码

基本的配置就已经配置好了,写点简单的代码,先看效果图

image

功能很简单,第二个按钮跳转到第二个Activity。第一个按钮加载一会儿生成的patch文件。跳转代码如下

  findViewById(R.id.loaddPatch).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                //关键是第二个参数
                new PatchExecutor(getApplicationContext(), new PatchManipulateImp(), new Callback()).start();
            }
        });

        findViewById(R.id.jump).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                startActivity(new Intent(MainActivity.this,RobustActivity.class));
            }
        });

看下类PatchManipulateImp的代码,代码是从官方拷贝过来的,很简单。大致看一下

public class PatchManipulateImp extends PatchManipulate {
    /***
     * connect to the network ,get the latest patches
     * l联网获取最新的补丁
     * @param context
     *
     * @return
     */
    @Override
    protected List<Patch> fetchPatchList(Context context) {
        //将app自己的robustApkHash上报给服务端,服务端根据robustApkHash来区分每一次apk build来给app下发补丁
        //apkhash is the unique identifier for  apk,so you cannnot patch wrong apk.
        //String robustApkHash = RobustApkHashUtils.readRobustApkHash(context);
        //connect to network to get patch list on servers
        //在这里去联网获取补丁列表
        Patch patch = new Patch();
        patch.setName("123");
        //we recommend LocalPath store the origin patch.jar which may be encrypted,while TempPath is the true runnable jar
        //LocalPath是存储原始的补丁文件,这个文件应该是加密过的,TempPath是加密之后的,TempPath下的补丁加载完毕就删除,保证安全性
        //这里面需要设置一些补丁的信息,主要是联网的获取的补丁信息。重要的如MD5,进行原始补丁文件的简单校验,以及补丁存储的位置,这边推荐把补丁的储存位置放置到应用的私有目录下,保证安全性
        patch.setLocalPath(Environment.getExternalStorageDirectory().getPath()+ File.separator+"robust"+File.separator + "patch");

        //setPatchesInfoImplClassFullName 设置项各个App可以独立定制,需要确保的是setPatchesInfoImplClassFullName设置的包名是和xml配置项patchPackname保持一致,而且类名必须是:PatchesInfoImpl
        //请注意这里的设置
        patch.setPatchesInfoImplClassFullName("cx.com.robustdemo.PatchesInfoImpl");
        List  patches = new ArrayList<Patch>();
        patches.add(patch);
        return patches;
    }

    /**
     *
     * @param context
     * @param patch
     * @return
     *
     * you can verify your patches here
     */
    @Override

    protected boolean verifyPatch(Context context, Patch patch) {
        //do your verification, put the real patch to patch
        //放到app的私有目录,拷贝到自己的目录下。执行。
        patch.setTempPath(context.getCacheDir()+ File.separator+"robust"+File.separator + "patch");
        //in the sample we just copy the file
        try {
            copy(patch.getLocalPath(), patch.getTempPath());
        }catch (Exception e){
            e.printStackTrace();
            throw new RuntimeException("copy source patch to local patch error, no patch execute in path "+patch.getTempPath());
        }

        return true;
    }
    public void copy(String srcPath,String dstPath) throws IOException {
        File src=new File(srcPath);
        if(!src.exists()){
            throw new RuntimeException("source patch does not exist ");
        }
        File dst=new File(dstPath);
        if(!dst.getParentFile().exists()){
            dst.getParentFile().mkdirs();
        }
        InputStream in = new FileInputStream(src);
        try {
            OutputStream out = new FileOutputStream(dst);
            try {
                // Transfer bytes from in to out
                byte[] buf = new byte[1024];
                int len;
                while ((len = in.read(buf)) > 0) {
                    out.write(buf, 0, len);
                }
            } finally {
                out.close();
            }
        } finally {
            in.close();
        }
    }
    /**
     *
     * @param patch
     * @return
     *
     * you may download your patches here, you can check whether patch is in the phone
     */
    @Override
    protected boolean ensurePatchExist(Patch patch) {
        return true;
    }
}

这里一定要注意

//后缀必须是PatchesInfoImpl  ,前面的要和robust.xml中<package>节点下的包名对应
  patch.setPatchesInfoImplClassFullName("cx.com.robustdemo.PatchesInfoImpl");

继承了PatchManipulate,有3个方法。

@Override
fetchPatchList() 方法主要是设置patch的路径等配置信息,然后返回
@Override
verifyPatch() //放到app的私有目录,是加载的真正的路径
@Override
protected boolean ensurePatchExist(Patch patch): 

澳门新葡亰网址下载 1

生成patch包

小小修改下第二个Activity的代码!

image

image

执行刚才的打包命令

./gradlew clean  assembleRelease --stacktrace --no-daemon

命令跑到中间会错,如下图,但是看到patch包已经生成了。

image

生成路径如下图

image

执行命令

adb push app/build/outputs/robust/patch.jar /sdcard/robust

最后一步,点击第一个按钮,再点击跳转到第二个按钮。先看效果,会发下hello
robust 变为热更了。

image

点击加载patch文件按钮

image

刚刚增加的代码打出的log,热更新成功了。

image

项目代码

image.png

不足

  1. 每次都要手动拷贝map文件,每次的都要替换插件来生成patch包。

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>

现在可以编译项目 时间会比较长

澳门新葡亰网址下载 2

build.png

先解释一下,在生成 apk 的时候使用 apply
plugin:’robust’,该插件会生成打补丁时需要的方法记录文件
methodMap.robust,该文件在打补丁的时候用来区别到底哪些方法需要被修复,所以有它才能打补丁。而上文所说的还有
mapping.txt
文件,该文件列出了原始的类,方法和字段名与混淆后代码间的映射。这个文件很重要,可以用它来翻译被混淆的代码。但也不是必须的,如果不需要混淆,可以不保留。这两个文件在生成apk后,分别在
build/outputs/robust/methodsMap.robust,build/outputs/mapping/mapping.txt(需要开启混淆后才会出现),我们需要自己分别拷贝到
app/robust 下,在 app 目录新建个叫 robust 的文件夹,把这两个文件放进去就
ok 了。

澳门新葡亰网址下载 3

WX20180307-113912@2x.png

完成了第二步了。我们得到了 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 配置的一样

澳门新葡亰网址下载 4

4.png

澳门新葡亰网址下载 5

5.png

新增加一个页面来测试补丁

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

澳门新葡亰网址下载 6

3.png

点击load_path

澳门新葡亰网址下载 7

image.png

如果看到 apply result true 那么就大功告成了。
再点击jump
便可以看到加载的是补丁里面的方法

最后来张效果图

澳门新葡亰网址下载 8

image.png

澳门新葡亰网址下载 9

image.png

发表评论

电子邮件地址不会被公开。 必填项已用*标注

网站地图xml地图