全部产品

SDK快速接入(不建议使用)

更新时间:2020-10-13 10:39:06

前提条件

使用限制

  • 当前快速接入方式,在Android 9.0及以上系统会有发生崩溃的风险,请选择稳健接入方式接入。
  • 如当前已采用“快速接入”方式接入,发布补丁时,请在控制台设置过滤机型,过滤Android 9.0及以上系统版本。
  • 支持Android 4.0.3及以上系统,如自研设备和系统,请关闭系统级jit后进行接入。

集成步骤

1. 添加工程依赖

1.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. android {
  2. ......
  3. defaultConfig {
  4. applicationId "com.xxx.xxx" //包名
  5. ......
  6. ndk {
  7. //选择要添加的对应cpu类型的.so库。
  8. //热修复支持五种
  9. abiFilters 'arm64-v8a', 'armeabi', 'armeabi-v7a', 'x86', 'x86_64'
  10. }
  11. ......
  12. }
  13. ......
  14. }
  15. dependencies {
  16. ......
  17. compile 'com.aliyun.ams:alicloud-android-hotfix:3.2.15'
  18. ......
  19. }

如若仓库访问失败, 那么用本地依赖的方式进行依赖。

注意:

1.2 eclipse集成方式

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

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

2. 添加应用权限

Sophix SDK使用到以下权限,使用maven依赖或者aar依赖可以不用配置。具体配置在AndroidManifest.xml中。

  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以上的运行时权限获取。

3. 配置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这个方法进行设置,详见SDK API的方法说明。如找不到对应参数,可参考EMAS快速入门>下载配置文件获取应用配置信息。

说明:

  • 另外,热修复暂不支持EMAS统一插件的json文件读取。
  • App ID/App Secret将被用于计量计费,请妥善保管注意安全。

4. 混淆配置

  1. #基线包使用,生成mapping.txt
  2. -printmapping mapping.txt
  3. #生成的mapping.txt在app/build/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. -dontwarn com.alibaba.sdk.android.utils.**
  10. #防止inline
  11. -dontoptimize

注意:开启混淆时,生成修复包要使用旧包的mapping文件以保证混淆结果一致。

5. 初始化

initialize的调用应该尽可能的早,必须在Application.attachBaseContext()的最开始(在super.attachBaseContext之后,如果有Multidex,也需要在Multidex.install之后)进行SDK初始化操作,初始化之前不能用到其他自定义类,否则极有可能导致崩溃。而查询服务器是否有可用补丁的操作可以在后面的任意地方。不建议在Application.onCreate()中初始化,因为如果带有ContentProvider,就会使得Sophix初始化时机太迟从而引发问题。

以下为快速接入的初始化方式,直接在已有Application中添加以下代码即可。我们更推荐使用稳健接入,采用稳健接入后修复范围更广,稳定性更高。

  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();