阿里云Sophix热修复框架的接入简述

作者: 志威梦 | 来源:发表于2019-09-27 09:17 被阅读0次

目前来说Android开发热修复可以说是一个标准商业项目必备的基础功能，便于上线后的紧急问题修复。（ps，不论怎么测试，似乎上线后的app，总会有一些测试期间发现不了的Bug，😄），不去对比AndFix、Robust和tinker/bugly之类的。目前的热度依旧的无疑是阿里的sophix和腾讯的tinker.

先尝试tinker/bugly的接入，但是由于tinker目前尚不支持gradle 5以上版本的兼容，而我们项目用到了androidx以及jetpack等技术点，编译平台也是最新配置的，所以无法降级适配tinker，且tinker的接入确实繁杂，所以尝试sophix并测试OK。特此记录如下，给有需要的同学有点帮助更好。

一、接入准备文档

注册拥有阿里云账号阿里云
个人账号控制台添加产品
下载配置的aliyun-emas-service.json文件
下载辅助调试工具hotfix-debug-tool.apk和对应平台的补丁生成工具工具

二、项目配置

在项目根目录的build.gradle下配置添加

repositories {
     //添加阿里云的仓库
     maven {url "http://maven.aliyun.com/nexus/content/repositories/releases"}
    }

在app项目的目录级别下的build.gradle添加dependencies

implementation "com.aliyun.ams:alicloud-android-hotfix:3.2.8"//目前最新版

按照官方文档添加配置相应权限(一般来说，项目应该都有如下权限了)

    <! -- 网络权限 -->
    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
    <! -- 外部存储读权限，调试工具加载本地补丁需要 -->
    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>

添加混淆规则

#基线包使用，生成mapping.txt
    -printmapping mapping.txt
    #生成的mapping.txt在app/build/outputs/mapping/release路径下，移动到/app路径下
    #修复后的项目使用，保证混淆结果一致
    #-applymapping mapping.txt
    #hotfix
    -keep class com.taobao.sophix.**{*;}
    -keep class com.ta.utdid2.device.**{*;}
    -dontwarn com.alibaba.sdk.android.utils.**
    #防止inline
    -dontoptimize

这里说明一下，个人项目测试结果是，不论是构建基线包还是修复包,如上混淆规则都不用去修改。也不要去掉#-applymapping maping.txt以及也不用手动copy这个文件到对应目录。否则可能出现R8 errors的编译错误。

三、代码设置

这里注意，不建议采用快速接入方式，而应该是稳健接入方式，也不要用emas-service.json的方式来接入热修复这个功能。

创建Application的实现类，也就是自己项目App的具体Application的真实业务实现类，如：MyRealApplication
创建SophixApplication的实现类，不存放任何其他逻辑，仅仅是sophix的初始化，且务必不要引用到Android SDK标准库类以外的class，否则构建补丁时候容易报错。

package com.my.pkg;
    import android.app.Application;
    import android.content.Context;
    import android.support.annotation.Keep;
    import android.util.Log;
    import com.taobao.sophix.PatchStatus;
    import com.taobao.sophix.SophixApplication;
    import com.taobao.sophix.SophixEntry;
    import com.taobao.sophix.SophixManager;
    import com.taobao.sophix.listener.PatchLoadStatusListener;
    import com.my.pkg.MyRealApplication;
    /**
     * Sophix入口类，专门用于初始化Sophix，不应包含任何业务逻辑。
     * 此类必须继承自SophixApplication，onCreate方法不需要实现。
     * 此类不应与项目中的其他类有任何互相调用的逻辑，必须完全做到隔离。
     * AndroidManifest中设置application为此类，而SophixEntry中设为原先Application类。
     * 注意原先Application里不需要再重复初始化Sophix，并且需要避免混淆原先Application类。
     * 如有其它自定义改造，请咨询官方后妥善处理。
     */
    public class SophixStubApplication extends SophixApplication {
     private final String TAG = "SophixStubApplication";
     // 此处SophixEntry应指定真正的Application，并且保证RealApplicationStub类名不被混淆。
     @Keep
     @SophixEntry(MyRealApplication.class)
     static class RealApplicationStub {}
     @Override
     protected void attachBaseContext(Context base) {
     super.attachBaseContext(base);
    //         如果需要使用MultiDex，需要在此处调用。
    //         MultiDex.install(this);
     initSophix();
     }
     private void initSophix() {
     String appVersion = "0.0.0";
     try {
     appVersion = this.getPackageManager()
     .getPackageInfo(this.getPackageName(), 0)
     .versionName;
     } catch (Exception e) {
     }
     final SophixManager instance = SophixManager.getInstance();
     instance.setContext(this)
     .setAppVersion(appVersion)
     .setSecretMetaData("idSetret", "appSecret", "rsaSecret")//这里配置必要的key，再emas-service.json中有.
     .setEnableDebug(true)
     .setEnableFullLog()
     .setPatchLoadStatusStub(new PatchLoadStatusListener() {
     @Override
     public void onLoad(final int mode, final int code, final String info, final int handlePatchVersion) {
     if (code == PatchStatus.CODE_LOAD_SUCCESS) {
     Log.i(TAG, "sophix load patch success!");
     } else if (code == PatchStatus.CODE_LOAD_RELAUNCH) {
     // 如果需要在后台重启，建议此处用SharePreference保存状态。
     Log.i(TAG, "sophix preload patch success. restart app to make effect.");
     }
     }
     }).initialize();
     }
    }

这里还要注意一点，就是kotlin版本的写法，关键在于java静态内部类的kotlin转换，不要写作object而是如下（没试过componain object RealApplicationStub是否可行）

    //这里的@keep是support包里面，用于保留，防止被混淆的。如果没有support的包，就要配置混淆规则
     @Keep
     @SophixEntry(MyRealApplication::class)
     internal class RealApplicationStub
    ...

####混淆规则的配置
    -keepclassmembers class com.my.pkg.MyRealApplication {
     public <init>();
    }
    # 如果不使用android.support.annotation.Keep则需加上此行
    # -keep class com.my.pkg.SophixStubApplication$RealApplicationStub

然后在AndroidManifest.xml中的Application节点下，name="SophixStubApplication"替换原有的业务的MyRealApplication

注意：在业务的Application中也就是示例的MyRealApplication中onCreate配置必要的初始化。由于attachBaseContext函数的调用先于onCreate,所以业务的application中如果有在attachBaseContext中初始化的函数，无必要就移到onCreate中去，十分必要的就放在SophixStubApplication中来，也注意和initSophix的顺序。

在必要的地方，如MyRealApplication的onCreate中，或者其他需要请求补丁的地方，调用请求

   // queryAndLoadNewPatch不可放在attachBaseContext 中，否则无网络权限，建议放在后面任意时刻，如onCreate中
    SophixManager.getInstance().queryAndLoadNewPatch();

也可以设置tag用于灰度测试的调试，区分环境

List<String> tags = new ArrayList<>();
    tags.add("test");
    //此处调用在queryAndLoadNewPatch()方法前
    SophixManager.getInstance().setTags(tags)；

四、补丁生成

生成基线包

正常的配置，构建release版的apk。存放为old.apk
修复所需的Bug后，生成修复后的release包，暂名为new.apk
然后用windows或Mac或Linux平台对应版的补丁生成工具（文章开始要求下载的），配置选择old.apk和new.apk以及设置patch输出路径等。注意配置release的签名keystore用于补丁签名，还有一点就是，如果项目用了androidx，补丁工具可能不兼容，就会报错。在设置里取消初始化检查，再打补丁。
将生成的补丁，上传阿里云热修复的后台，配置对应版本的补丁，然后创建版本--上传补丁--先本地二维码测试--灰度测试--发布补丁。

注意:调试debug-tool.apk未必在所有的手机都能正常工作，有的机型就不能连接被调试应用。可以换一个试试。还有就是，阿里云的sophix有免费额度，超额是收费的。在上传补丁时候，你的账号如果欠费，会上传失败。但是提示文案依旧是请求失败，稍后重试之类的。

阿里云Sophix热修复框架的接入简述

一、接入准备文档

二、项目配置

三、代码设置

四、补丁生成

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读