阿里百川最新热修复技术Sophix

Sophix官方学习文档

最近一周公司项目已经上线了,暂时没有接到比较重要的任务,工作量相对比较少,于是决定搞一波事情,思来想去,把目标对准了热修复。热修复作为当下热门的技术,在业界内比较著名的有阿里系的AndFix、Sophix,腾讯QQ空间的超级补丁技术和微信的Tinker。由于最近一段时间了解到阿里发布了新一代热修复技术—Sophix,听说挺牛逼的样子,于是我决定折腾一下。

为什么要引入热修复?

当 App 上线以后,如果出现比较严重的bug,实在很着急……有时候仅仅是为了修改了几行代码,也要付出巨大的成本,你需要修复bug,重新测试,确保无误后,重新打包,发版到应用市场,等待通过审核,再等到用户下载更新的冗长路径,有的用户甚至对频繁发版的APP会有抵触而不更新。所以引入了热修复这个技术,阿里百川的解释是:无需发新版本,无需等待用户更新,基于阿里巴巴首创Hotpatch技术,实时修复应用线上问题。阿里百川HotFix能够帮助开发者将修复Bug的补丁,实时发布到APP内,当用户启动APP时,补丁将自动加载安装,用户全程无感知,而Bug已经修复,最后还会自动删除补丁哦。

到这里,大家应该对它有个大致了解了,可能也有不少人对这个补丁还比较疑惑,不知道什么东西,至少我一开始是这样的,客官,别急,在文章后面会慢慢为你分析,下面就和大家一步步来入手学习SoPhix吧。

1、首先要注册阿里百川账号
可以使用淘宝账号进行注册,非常方便:

阿里百川最新热修复技术Sophix_第1张图片
111.png

2.创建应用
创建应用,填入相关信息

阿里百川最新热修复技术Sophix_第2张图片
Paste_Image.png

填完了之后会自动提供给你appkey和AppSecret,这个在后面构建项目的时候会用到

3.申请产品权限
在百川开发者控制台申请HotFix产品权限,官方将在1个工作日内完成审批。申请理由请“填写您真实的APP名,说明是否已上应用市场,通过什么渠道了解到百川HotFix。若无APP或还未上线请详细描述具体公司业务。

阿里百川最新热修复技术Sophix_第3张图片
Paste_Image.png

以上准备工作完成了之后,就可以进行集成使用了

1、先进入Sophix官网首页
可以直接用淘宝账号登录,非常便捷,

阿里百川最新热修复技术Sophix_第4张图片
Paste_Image.png

2、选择移动热修复,就会看到这个页面,点击管理控制台

阿里百川最新热修复技术Sophix_第5张图片
222.png

3、进入后台管理页面

阿里百川最新热修复技术Sophix_第6张图片
333.png

4、选择你需要的那一项点击管理,进入下一个页面

阿里百川最新热修复技术Sophix_第7张图片
Paste_Image.png

下面开始代码集成学习
阿里百川Sophix官方文档学习

1、在Project和app中的build.gradle中分别配置maven仓库和添加如下依赖

添加maven仓库地址:

repositories {
   maven {
       url "http://maven.aliyun.com/nexus/content/repositories/releases"
   }
}

添加app的build.gradle依赖:

compile 'com.aliyun.ams:alicloud-android-hotfix:3.1.1'

//传递性依赖utdid这个sdk, 所以不需要重复依赖utdid.但是另一方面其它阿里系SDK也可能依赖了
//utdid这个SDK, 如果编译期间报utdid重复, 所以此时进行如下处理即可, 关闭传递性依赖:
compile ('com.aliyun.ams:alicloud-android-hotfix:3.1.1') {
     exclude(module:'alicloud-android-utdid')
}
2 . 在AndroidManifest文件中添加Sophix权限






READ_EXTERNAL_STORAGE/ACCESS_WIFI_STATE权限属于Dangerous Permissions,自行做好android6.0以上的运行时权限获取

3 . 在AndroidManifest文件中配置创建应用时获取到的appId、appSecret、rsa秘钥(替换成你自己的哈,可以在你的应用那里查看)



4 . 新建Application子类

在attachBaseContext初始化SophixManager
在onCreate中查询服务器是否有新的可用补丁

public class MyApplication extends Application {
    
    @Override
    public void onCreate() {
        super.onCreate();

        // 查询服务器是否有可用补丁
        // SDK内部限制连续两次queryAndLoadNewPatch()方法调用不能短于3s, 否则的话就会报code:19的错误码. 
        SophixManager.getInstance().queryAndLoadNewPatch();
    }

    @Override
    protected void attachBaseContext(Context base) {
        super.attachBaseContext(base);
        initHotFix();
    }

    private void initHotFix() {
        String appVersion;
        try {
            appVersion = getPackageManager().getPackageInfo(this.getPackageName(), 0).versionName;
        } catch (PackageManager.NameNotFoundException e) {
            appVersion = "1.0";
        }
        SophixManager.getInstance().setContext(this)
                .setAppVersion(appVersion) //appVersion与app版本无关可以自己定义只要与自己控制台中版本一致即可
//                .setSecretMetaData(APP_ID, APP_SECRET, RSA_SECRET)
                .setAesKey(null)
                .setEnableDebug(true) //正式发布该参数必须为false, false会对补丁做签名校验, 否则就可能存在安全漏洞风险
                .setPatchLoadStatusStub(new PatchLoadStatusListener() {
                    @Override
                    public void onLoad(final int mode, final int code, final String info, final int handlePatchVersion) {
                        // 补丁加载回调通知
                        Log.i("tag", "onLoad  code:---------->"+code);
                        if (code == PatchStatus.CODE_LOAD_SUCCESS) {
                            // 表明补丁加载成功
                        } else if (code == PatchStatus.CODE_LOAD_RELAUNCH) {
                            // 表明新补丁生效需要重启. 开发者可提示用户或者强制重启;
                            // 建议: 用户可以监听进入后台事件, 然后调用killProcessSafely自杀,以此加快应用补丁,详见1.3.2.3
                             SophixManager.getInstance().killProcessSafely();//安全自杀应用推荐
                        }else if (code == PatchStatus.CODE_LOAD_FAIL) {
                            // 内部引擎异常, 推荐此时清空本地补丁, 防止失败补丁重复加载
                            SophixManager.getInstance().cleanPatches();
                        } else {
                            // 其它错误信息, 查看PatchStatus类说明
                        }
                    }
                }).initialize();
    }
}

注意:上面的appVersion与app版本无关可以自己定义只要与自己控制台中版本一致即可。

initialize的调用应该尽可能的早,必须在Application.attachBaseContext()或者Application.onCreate()的最开始进行SDK初始化操作,否则极有可能导致崩溃。而查询服务器是否有可用补丁的操作可以在后面的任意地方。

5 . 混淆配置

在app目录下的proguard-rules.pro文件下添加如下代码:

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

--------------------------------------到这里代码集成已经全部完毕-------------------------------

接下来就是如何生成这个补丁?

官方生成补丁的文档

1、下载打补丁工具SophixPatchTool(Mac、Windows、Linux)都有的,以及调试工具(实际是一个apk,记得装到你的手机先),下载地址,就是上面这个官方生成补丁的文档。

阿里百川最新热修复技术Sophix_第8张图片
444.png

2、下载好了这个SophixPatchTool压缩文件,先解压,按如图操作即可

阿里百川最新热修复技术Sophix_第9张图片
555.png

生成补丁的这个客户端工具的界面是这样的(怎么样,很简单了吧,以前老版本都是dos命令)

阿里百川最新热修复技术Sophix_第10张图片
666.png
  • 旧包:<必填> 选择基线包路径(有问题的APK)。
  • 新包:<必填> 选择新包路径(修复过该问题APK)。
  • 日志:打开日志输出窗口。
  • 高级:展开高级选项,
  • 设置:配置其他信息。
  • GO!:开始生成补丁。

3 .点击对话框下面的设置,会出现如下界面,签名必须与app签名一致 保证安全性

阿里百川最新热修复技术Sophix_第11张图片
Paste_Image.png
  • 补丁输出路径:<必填> 指定生成补丁之后补丁的存放位置,必须是已存在的目录。
  • Key Store Path:<选填>本地的签名文件的路径,不输入则不做签名。
  • Key Store Password:<选填>证书文件的密码。
  • Key Alias:<选填>Key的别名。
  • Key Passwrod:<选填>Key的密码。
  • AES Key:<选填>自定义aes秘钥, 必须是16位数字或字母的组合。必须- 与setAesKey中设置的秘钥一致。
  • Filter Class File:<选填>本地的白名单类列表文件的路径,放进去的类不会再计算patch,文件格式: 一行一个类名。

4 . 点击go 就会生成补丁包以.jar结尾 路径是自己设定的

阿里百川最新热修复技术Sophix_第12张图片
Paste_Image.png

5、现在补丁已经生成好了,补丁需要上传到控制台。控制台地址

阿里百川最新热修复技术Sophix_第13张图片
777.png

这是我成功之后的截图


阿里百川最新热修复技术Sophix_第14张图片
Paste_Image.png

发布前请严格按照:扫码内测 => 灰度发布 => 全量发布的流程进行,以保证补丁包能够正常在所有Android版本的机型上生效。

6 . 下载阿里测试工具(就是一个apk哈,不是什么神秘的东西)
调试工具下载

7 . 将旧的apk和调试工具装在手机中 打开调试工具
输入包名->连接应用->扫描二维码 观察下方输出的日志

阿里百川最新热修复技术Sophix_第15张图片
888.jpg

如果最后结果为12,恭喜你成功了

8 . 成功的话就可以发布你的补丁包了,之后就可以观察手机中旧版本的apk已经变成新版本的了。

你可能感兴趣的:(阿里百川最新热修复技术Sophix)