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

目前来说Android开发热修复可以说是一个标准商业项目必备的基础功能,便于上线后的紧急问题修复。(ps,不论怎么测试,似乎上线后的app,总会有一些测试期间发现不了的Bug,😄),不去对比AndFixRobusttinker/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中也就是示例的MyRealApplicationonCreate配置必要的初始化。由于attachBaseContext函数的调用先于onCreate,所以业务的application中如果有在attachBaseContext中初始化的函数,无必要就移到onCreate中去,十分必要的就放在SophixStubApplication中来,也注意和initSophix的顺序。

  • 在必要的地方,如MyRealApplicationonCreate中,或者其他需要请求补丁的地方,调用请求
   // queryAndLoadNewPatch不可放在attachBaseContext 中,否则无网络权限,建议放在后面任意时刻,如onCreate中
    SophixManager.getInstance().queryAndLoadNewPatch();
  • 也可以设置tag用于灰度测试的调试,区分环境
List<String> tags = new ArrayList<>();
    tags.add("test");
    //此处调用在queryAndLoadNewPatch()方法前
    SophixManager.getInstance().setTags(tags);

四、补丁生成

  1. 生成基线包

    正常的配置,构建release版的apk。存放为old.apk

  2. 修复所需的Bug后,生成修复后的release包,暂名为new.apk

  3. 然后用windowsMacLinux平台对应版的补丁生成工具(文章开始要求下载的),配置选择old.apknew.apk以及设置patch输出路径等。注意 配置release的签名keystore用于补丁签名,还有一点就是,如果项目用了androidx,补丁工具可能不兼容,就会报错。在设置里取消初始化检查,再打补丁

  4. 将生成的补丁,上传阿里云热修复的后台,配置对应版本的补丁,然后创建版本--上传补丁--先本地二维码测试--灰度测试--发布补丁。

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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,117评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,963评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 107,897评论 0 240
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,805评论 0 203
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,208评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,535评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,797评论 2 311
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,493评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,215评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,477评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,988评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,325评论 2 252
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,971评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,055评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,807评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,544评论 2 271
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,455评论 2 266

推荐阅读更多精彩内容