全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 阿里云办公 培训与认证 物联网

快速接入

更新时间:2017-09-29 22:14:06

快速集成

1.1 Android SDK及工具下载

阿里云Sophix 3.0版本现已上线!

Sophix提供了一套更加完美的客户端服务端一体的热更新方案,做到了图形界面一键打包、加密传输、签名校验和服务端控制发布与灰度功能,让你用最少的时间实现最强大可靠的全方位热更新。

  • 一张表格来说明一下各个版本热修复的差别:
方案对比 Andfix开源版本 阿里Hotfix 1.X 阿里Hotfix最新版 (Sophix)
方法替换 支持,除部分情况[0] 支持,除部分情况 全部支持
方法增加减少 不支持 不支持 以冷启动方式支持[1]
方法反射调用 只支持静态方法 只支持静态方法 以冷启动方式支持
即时生效 支持 支持 视情况支持[2]
多DEX 不支持 支持 支持
资源更新 不支持 不支持 支持
so库更新 不支持 不支持 支持
Android版本 支持2.3~7.0 支持2.3~6.0 全部支持包含7.0以上
已有机型 大部分支持[3] 大部分支持 全部支持
安全机制 加密传输及签名校验 加密传输及签名校验
性能损耗 低,几乎无损耗 低,几乎无损耗 低,仅冷启动情况下有些损耗
生成补丁 繁琐,命令行操作 繁琐,命令行操作 便捷,图形化界面
补丁大小 不大,仅变动的类 小,仅变动的方法 不大,仅变动的资源和代码[4]
服务端支持 支持服务端控制[5] 支持服务端控制

说明:

  • [0] 部分情况指的是构造方法、参数数目大于8或者参数包括long,double,float基本类型的方法。
  • [1] 冷启动方式,指的是需要重启app在下次启动时才能生效。
  • [2] 对于Andfix及Hotfix 1.X能够支持的代码变动情况,都能做到即时生效。而对于其他代码变动较大的情况,会走冷启动方式,此时就无法做到即时生效。
  • [3] Hotfix 1.X已经支持绝大部分主流手机,只是在X86设备以及修改了虚拟机底层结构的ROM上不支持。
  • [4] 由于支持了资源和库,如果有这些方面的更新,就会导致的补丁变大一些,这个是很正常的。并且由于只包含差异的部分,所以补丁已经是最大程度的小了。
  • [5] 提供服务端的补丁发布和停发、版本控制和灰度功能,存储开发者上传的补丁包。

1.2 集成准备

1.2.1 android studio集成方式

gradle远程仓库依赖, 打开项目找到app的build.gradle文件,添加如下配置:

添加maven仓库地址:

  1. repositories {
  2. maven {
  3. url "http://maven.aliyun.com/nexus/content/repositories/releases"
  4. }
  5. }

添加gradle坐标版本依赖:

  1. compile 'com.aliyun.ams:alicloud-android-hotfix:3.1.3'

注意,若SDK集成过程中出现UTDID冲突,请参考:阿里云-移动云产品SDK UTDID冲突解决方案

如若仓库访问失败, 那么用本地依赖的方式进行依赖, SDK下载见“1.5 客户端本地SDK及DEMO下载”节。

1.2.2 eclipse集成方式

  • 下载OneSDk.zip,解压出hotfix_core-release.aar文件后再解压这个aar文件
  • 复制解压文件jni目录下的libsophix.so到自己的jni目录下, eclipse jni目录一般指的就是项目libs目录
  • 复制utdid4all-1.1.5.3_proguard.jar和alicloud-android-utils-1.0.3.jar文件到项目libs目录下
  • 重命名classes.jar为sophix.jar并复制到项目libs目录下
  • 合并AndroidManifest.xml文件中的内容到本项目AndroidManifest.xml文件

编译期间报utdid类重复异常, 那么步骤2中添加的utdid4all-1.1.5.3_proguard.jar从项目libs目录移除即可

1.2.3 权限说明

Sophix SDK使用到以下权限

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

READ_EXTERNAL_STORAGE权限属于Dangerous Permissions,仅调试工具获取外部补丁需要,不影响线上发布的补丁加载,调试时请自行做好android6.0以上的运行时权限获取。

1.2.4 配置AndroidManifest文件

AndroidManifest.xml中间的application节点下添加如下配置:

  1. <meta-data
  2. android:name="com.taobao.android.hotfix.IDSECRET"
  3. android:value="App ID" />
  4. <meta-data
  5. android:name="com.taobao.android.hotfix.APPSECRET"
  6. android:value="App Secret" />
  7. <meta-data
  8. android:name="com.taobao.android.hotfix.RSASECRET"
  9. android:value="RSA密钥" />

将上述value中的值分别改为通过平台HotFix服务申请得到的App Secret和RSA密钥,出于安全考虑,建议使用setSecretMetaData这个方法进行设置,详见1.3.2.1的方法说明。

1.2.5 混淆配置

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

1.3 SDK接口使用说明

1.3.1 接入范例

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

  1. // initialize最好放在attachBaseContext最前面,初始化直接在Application类里面,切勿封装到其他类
  2. SophixManager.getInstance().setContext(this)
  3. .setAppVersion(appVersion)
  4. .setAesKey(null)
  5. .setEnableDebug(true)
  6. .setPatchLoadStatusStub(new PatchLoadStatusListener() {
  7. @Override
  8. public void onLoad(final int mode, final int code, final String info, final int handlePatchVersion) {
  9. // 补丁加载回调通知
  10. if (code == PatchStatus.CODE_LOAD_SUCCESS) {
  11. // 表明补丁加载成功
  12. } else if (code == PatchStatus.CODE_LOAD_RELAUNCH) {
  13. // 表明新补丁生效需要重启. 开发者可提示用户或者强制重启;
  14. // 建议: 用户可以监听进入后台事件, 然后调用killProcessSafely自杀,以此加快应用补丁,详见1.3.2.3
  15. } else {
  16. // 其它错误信息, 查看PatchStatus类说明
  17. }
  18. }
  19. }).initialize();
  20. // queryAndLoadNewPatch不可放在attachBaseContext 中,否则无网络权限,建议放在后面任意时刻,如onCreate中
  21. SophixManager.getInstance().queryAndLoadNewPatch();

1.3.2 接口说明

1.3.2.1 initialize方法

  • initialize(): <必选>

    该方法主要做些必要的初始化工作以及如果本地有补丁的话会加载补丁, 但不会自动请求补丁。因此需要自行调用queryAndLoadNewPatch方法拉取补丁。这个方法调用需要尽可能的早, 推荐在Application的onCreate方法中调用, initialize()方法调用之前你需要先调用如下几个方法, 方法调用说明如下:

  • setContext(application): <必选> 传入入口Application即可

  • setAppVersion(appVersion): <必选> 应用的版本号

  • setSecretMetaData(idSecret, appSecret, rsaSecret): <可选,推荐使用> 三个Secret分别对应AndroidManifest里面的三个,可以不在AndroidManifest设置而是用此函数来设置Secret。放到代码里面进行设置可以自定义混淆代码,更加安全,此函数的设置会覆盖AndroidManifest里面的设置,如果对应的值设为null,默认会在使用AndroidManifest里面的。

  • setEnableDebug(isEnabled): <可选> isEnabled默认为false, 是否调试模式, 调试模式下会输出日志以及不进行补丁签名校验. 线下调试此参数可以设置为true, 查看日志过滤TAG:Sophix, 同时强制不对补丁进行签名校验, 所有就算补丁未签名或者签名失败也发现可以加载成功. 但是正式发布该参数必须为false, false会对补丁做签名校验, 否则就可能存在安全漏洞风险

  • setAesKey(aesKey): <可选> 用户自定义aes秘钥, 会对补丁包采用对称加密。这个参数值必须是16位数字或字母的组合,是和补丁工具设置里面AES Key保持完全一致, 补丁才能正确被解密进而加载。此时平台无感知这个秘钥, 所以不用担心阿里云移动平台会利用你们的补丁做一些非法的事情。

  • setPatchLoadStatusStub(new PatchLoadStatusListener()): <可选> 设置patch加载状态监听器, 该方法参数需要实现PatchLoadStatusListener接口, 接口说明见1.3.2.2说明

  • setUnsupportedModel(modelName, sdkVersionInt):<可选> 把不支持的设备加入黑名单,加入后不会进行热修复。modelName为该机型上Build.MODEL的值,这个值也可以通过adb shell getprop | grep ro.product.model取得。sdkVersionInt就是该机型的Android版本,也就是Build.VERSION.SDK_INT,若设为0,则对应该机型所有安卓版本。

1.3.2.2 queryAndLoadNewPatch方法

该方法主要用于查询服务器是否有新的可用补丁. SDK内部限制连续两次queryAndLoadNewPatch()方法调用不能短于3s, 否则的话就会报code:19的错误码. 如果查询到可用的话, 首先下载补丁到本地, 然后

  • 应用原本没有补丁, 那么如果当前应用的补丁是热补丁, 那么会立刻加载(不管是冷补丁还是热补丁). 如果当前应用的补丁是冷补丁, 那么需要重启生效.
  • 应用已经存在一个补丁, 请求发现有新补丁后,本次不受影响。并且在下次启动时补丁文件删除, 下载并预加载新补丁。在下下次启动时应用新补丁。

    补丁在后台发布之后, 并不会主动下行推送到客户端, 需要手动调用queryAndLoadNewPatch方法查询后台补丁是否可用.

  • 只会下载补丁版本号比当前应用存在的补丁版本号高的补丁, 比如当前应用已经下载了补丁版本号为5的补丁, 那么只有后台发布的补丁版本号>5才会重新下载.

同时1.4.0以上版本服务后台上线了“一键清除”补丁的功能, 所以如果后台点击了“一键清除”那么这个方法将会返回code:18的状态码. 此时本地补丁将会被强制清除, 同时不清除本地补丁版本号

1.3.2.3 killProcessSafely方法

可以在PatchLoadStatusListener监听到CODE_LOAD_RELAUNCH后在合适的时机,调用此方法杀死进程。注意,不可以直接Process.killProcess(Process.myPid())来杀进程,这样会扰乱Sophix的内部状态。因此如果需要杀死进程,建议使用这个方法,它在内部做一些适当处理后才杀死本进程。

1.3.2.4 cleanPatches()方法

清空本地补丁,并且不再拉取被清空的版本的补丁。正常情况下不需要开发者自己调用,因为Sophix内部会判断对补丁引发崩溃的情况进行自动清空。

1.3.2.5 PatchLoadStatusListener接口

该接口需要自行实现并传入initialize方法中, 补丁加载状态会回调给该接口, 参数说明如下:

  • mode: 补丁模式, 0:正常请求模式 1:扫码模式 2:本地补丁模式
  • code: 补丁加载状态码, 详情查看PatchStatusCode类说明
  • info: 补丁加载详细说明, 详情查看PatchStatusCode类说明
  • handlePatchVersion: 当前处理的补丁版本号, 0:无 -1:本地补丁 其它:后台补丁

这里列举几个常见的code码说明,

  • code: 1 补丁加载成功
  • code: 6 服务端没有最新可用的补丁
  • code: 11 RSASECRET错误,官网中的密钥是否正确请检查
  • code: 12 当前应用已经存在一个旧补丁, 应用重启尝试加载新补丁
  • code: 13 补丁加载失败, 导致的原因很多种, 比如UnsatisfiedLinkError等异常, 此时应该严格检查logcat异常日志
  • code: 16 APPSECRET错误,官网中的密钥是否正确请检查
  • code: 18 一键清除补丁
  • code: 19 连续两次queryAndLoadNewPatch()方法调用不能短于3s

详情查看SDK中PatchStatus类的代码,有具体说明:

  1. package com.taobao.sophix;
  2. public class PatchStatus {
  3. public final static int CODE_REQ_START = 0;
  4. public final static String INFO_REQ_START = "ready to start.";
  5. public final static int CODE_LOAD_SUCCESS = 1;
  6. public final static String INFO_LOAD_SUCCESS = "load new patch success.";
  7. public final static int CODE_ERR_NOTINIT = 2;
  8. public final static String INFO_ERR_NOTINIT = "didn't initialize hotfix sdk or initialize fail.";
  9. public final static int CODE_ERR_NOTMAIN = 3;
  10. public final static String INFO_ERR_NOTMAIN = "only allow query in main process.";
  11. public final static int CODE_ERR_INBLACKLIST = 4;
  12. public final static String INFO_ERR_INBLACKLIST = "current device does't support hotfix.";
  13. public final static int CODE_REQ_ERR = 5;
  14. public final static String INFO_REQ_ERR = "pull patch info detail fail, please check log.";
  15. public final static int CODE_REQ_NOUPDATE = 6;
  16. public final static String INFO_REQ_NOUPDATE = "there is not update.";
  17. public final static int CODE_REQ_NOTNEWEST = 7;
  18. public final static String INFO_REQ_NOTNEWEST = "the query patchversion equals or less than current patchversion, stop download.";
  19. public final static int CODE_DOWNLOAD_FAIL = 8;
  20. public final static int CODE_DOWNLOAD_SUCCESS = 9;
  21. public final static String INFO_DOWNLOAD_SUCCESS = "patch download success.";
  22. public final static int CODE_DOWNLOAD_BROKEN = 10;
  23. public final static String INFO_DOWNLOAD_BROKEN = "patch file is broken.";
  24. public final static int CODE_UNZIP_FAIL = 11;
  25. public final static String INFO_UNZIP_FAIL = "unzip patch file error, please check value of AndroidMenifest.xml RSASECRET or initialize param aesKey.";
  26. public final static int CODE_LOAD_RELAUNCH = 12;
  27. public final static String INFO_LOAD_RELAUNCH = "please relaunch app to load new patch.";
  28. public final static int CODE_LOAD_FAIL = 13;
  29. public final static String INFO_LOAD_FAIL = "load patch fail, please check stack trace of an exception: ";
  30. public final static int CODE_LOAD_NOPATCH = 14;
  31. public final static String INFO_LOAD_NOPATCH = "do not found any patch file to load.";
  32. public final static int CODE_REQ_APPIDERR = 15;
  33. public final static String INFO_REQ_APPIDERR = "appid is not found.";
  34. public final static int CODE_REQ_SIGNERR = 16;
  35. public final static String INFO_REQ_SIGNERR = "token is invaild, please check APPSECRET.";
  36. public final static int CODE_REQ_UNAVAIABLE = 17;
  37. public final static String INFO_REQ_UNAVAIABLE = "req is unavailable as has already been in arrearage.";
  38. public final static int CODE_REQ_CLEARPATCH = 18;
  39. public final static String INFO_REQ_CLEARPATCH = "clean client patch as server publish clear cmd.";
  40. public final static int CODE_REQ_TOOFAST = 19;
  41. public final static String INFO_REQ_TOOFAST = "two consecutive request should not short then 3s.";
  42. public final static int CODE_PATCH_INVAILD = 20;
  43. public static final String INFO_PATCH_INVAILD = "patch invaild, as patch not exist or is dir or not a jar compress file.";
  44. public final static int CODE_LOAD_FORBIDDEN = 21;
  45. public static final String INFO_LOAD_FORBIDDEN = "debuggable is false! forbid loading local patch for secure reason!";
  46. }

1.4 版本管理说明

说明一:patch是针对客户端具体某个版本的,patch和具体版本绑定

  • eg. 应用当前版本号是1.1.0, 那么只能在后台查询到1.1.0版本对应发布的补丁, 而查询不到之前1.0.0旧版本发布的补丁.

说明二:针对某个具体版本发布的新补丁, 必须包含所有的bugfix, 而不能依赖补丁递增修复的方式, 因为应用仅可能加载一个补丁

  • eg. 针对1.0.0版本在后台发布了一个补丁版本号为1的补丁修复了bug1, 然后发现此时针对这个版本补丁1修复的不完全, 代码还有bug2, 在后台重新发布一个补丁版本号为2的补丁, 那么此时补丁2就必须同时包含bug1和bug2的修复才行, 而不是只包含bug2的修复(bug1就没被修复了)

1.5 客户端本地SDK及DEMO下载

下载客户端SDK并集成(下载地址),Demo程序(Github)

1.6 注意事项

发布前请严格按照:扫码内测 => 灰度发布 => 全量发布的流程进行,以保证补丁包能够正常在所有Android版本的机型上生效。为了保险起见,理论上应该对每个版本的android手机都测一遍是否生效会比较好。不过,其实只需测试通过以下具有代表性的Android版本就基本没什么大问题了:4.0、4.4、5.1、7.0

遇到问题先查看文档:https://help.aliyun.com/knowledge_list/51422.html

还可以加入Sophix交流群进行讨论,钉钉群号:11734260,钉钉下载地址

1.7 补丁使用

生成的补丁需要上传到控制台。控制台地址

详情说明见:管理控制台使用

1.8 其他学习资料

本文导读目录