AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 移动研发平台 移动热修复 开发参考 Android SDK手册 SDK稳健接入

SDK稳健接入

更新时间：
产品详情
我的收藏

本文介绍移动热修复SDK稳健接入的方法。

前提条件

使用限制

  • 支持Android 4.3及以上系统，如自研设备和系统，请关闭系统级jit后进行接入。

  • 如需要混淆，需要使用ProGuard进行混淆。

  • 热修复SDK仅支持Java代码、资源文件和so文件的修复。

集成步骤

  1. 添加工程依赖

    1. Android Studio集成方式

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

      添加Maven仓库地址：

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

      添加gradle坐标版本依赖：

      android {
    ......
    defaultConfig {
        applicationId "com.xxx.xxx" //包名
        ......
        ndk {
            //选择要添加的对应cpu类型的.so库。
            //热修复支持五种
            abiFilters 'arm64-v8a', 'armeabi', 'armeabi-v7a', 'x86', 'x86_64'
        }
        ......
    }
    ......
}
dependencies {
    ......
        compile 'com.aliyun.ams:alicloud-android-hotfix:3.4.1'
    ......
}

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

      重要

      • 使用android studio打包生成apk时，要关闭instant run。

      • 使用gradle plugin版本高于4.2时，可能会因为自动开启资源优化导致资源名称被混淆，进而导致在生成补丁时一直卡在“开始构建补丁...”，无法正常解析apk包。解决方案：在gradle.properties 中新增android.enableResourceOptimizations=false，重新生成基线包和修复包，然后再生成补丁。

      • 如果开启了代码混淆，需要关闭R8，不然会导致生成的补丁较大。解决方案：在gradle.properties 中新增android.enableR8=false，重新生成基线包和修复包，然后再生成补丁。

      • 若SDK集成过程中出现UTDID冲突，请参考阿里云-云产品SDK UTDID冲突解决方案。

    2. eclipse集成方式

      1. 下载OneSDk.zip，解压后打开到libs目录，libs目录中，所有aar和jar文件都需要进行依赖。

      2. aar文件依赖方式：解压aar文件，复制解压文件jni目录下的so文件到自己的jni目录下, eclipse jni目录一般指的就是项目libs目录；复制jar文件项目libs目录下。合并AndroidManifest.xml文件中的内容到本项目AndroidManifest.xml文件。

      3. 复制所有jar文件到项目libs目录下。

      重要

      编译期间报UTDID类重复异常, 请参考阿里云-云产品SDK UTDID冲突解决方案

  2. 添加应用权限

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

    <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"/>

    SDK权限

    是否必须

    说明

    INTERNET

    是

    允许网络请求，下载补丁时使用。

    ACCESS_NETWORK_STATE

    是

    获取运营商和网络类型信息，用于统计不同网络下的补丁加载状态统计。

    ACCESS_WIFI_STATE

    是

    获取运营商和网络类型信息，用于统计不同网络下的补丁加载状态统计。

    READ_EXTERNAL_STORAGE

    否

    外部存储读权限，调试工具从SD卡加载本地补丁需要。

    说明

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

  3. 配置AndroidManifest文件

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

    <meta-data
android:name="com.taobao.android.hotfix.IDSECRET"
android:value="App ID" />
<meta-data
android:name="com.taobao.android.hotfix.APPSECRET"
android:value="App Secret" />
<meta-data
android:name="com.taobao.android.hotfix.RSASECRET"
android:value="RSA密钥" />

    将上述value中的值分别改为通过平台HotFix服务申请得到的App Secret和RSA密钥。App Secret和RSA密钥的获取方式请参见查看应用信息。出于安全考虑，建议使用setSecretMetaData这个方法进行设置，详见SDK API的方法说明。如找不到对应参数，可参考EMAS快速入门中的“下载SDK”获取应用配置信息。

    说明

    • 另外，热修复暂不支持EMAS统一插件的JSON文件读取。

    • IDSECRET、APPSECRET、RSASECRET将被用于计量计费，请妥善保管注意安全。

    • 为避免在日志中泄露IDSECRET、APPSECRET、RSASECRET参数或APP运行过程中产生的数据，建议线上版本关闭SDK调试日志。

    • 由于所有用户使用统一提供的SDK接入，在接入过程中需要在代码中设置IDSECRET、APPSECRET、RSASECRET参数，为防止恶意反编译获取参数造成信息泄露，建议开启混淆后再发布上线。

  4. 混淆配置

    #基线包使用，生成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.**{*;}
#防止inline
-dontoptimize
    重要

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

  5. 使用proguad混淆

    如果开启了代码混淆，需要关闭R8，使用proguard进行混淆。不然可能导致生成补丁异常。根据使用的Android Gradle Plugin版本，具体操作如下：

    1. Android Gradle Plugin低于7.0

      在项目根目录的gradle.properties中添加如下配置。

      android.enableR8=false

    2. Android Gradle Plugin 7.0以上

      1. 在项目根目录的build.gradle中添加如下ProGuard Gradle Plugin配置。

        buildscript {
    repositories {
        // For the Android Gradle plugin.
        google()
        // For the ProGuard Gradle Plugin.
        mavenCentral()
    }
    dependencies {
        // The Android Gradle plugin.
        classpath("com.android.tools.build:gradle:x.y.z")
        // The ProGuard Gradle plugin.
        classpath("com.guardsquare:proguard-gradle:7.1.+")
    }
}

      2. 在app目录的build.gradle中应用ProGuard Gradle Plugin。

        apply plugin: 'com.guardsquare.proguard'

      3. 然后，关闭R8混淆。

        android {
   buildTypes {
       release {
           // 关闭 R8.
           minifyEnabled false
       }
   }
}

      4. 最后，配置ProGuard混淆。

        android {
   ...
}

proguard {
   configurations {
       release {
           defaultConfiguration 'proguard-android.txt'
           configuration 'proguard-rules.pro'
       }
       debug {
           defaultConfiguration 'proguard-android-debug.txt'
           configuration 'proguard-rules.pro'
       }
   }
}

  6. 初始化

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

    Sophix最新版本引入了新的初始化方式。

    原来的初始化方式仍然可以使用。只是新方式可以提供更全面的功能修复支持，将会带来以下优点：

    • 初始化与应用原先业务代码完全隔离，使得原先真正的Application可以修复，并且减少了补丁预加载时间等等。

    • 新方式能够更完美地兼容Android 8.0以后版本。

    具体而言，是需要用户自行加入以下这个类：

    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)
                .setUsingEnhance(true) // 适配加固模式,如果app使用了加固则需要加上此方法
                .setAppVersion(appVersion)
                .setSecretMetaData(null, null, null)
                .setEnableDebug(true)
                .setEnableFullLog()
                .setTags(Arrays.asList("Gray")) //请根据需求设置tag
                .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();
    }
}

    这其中，关键一点是：

        @Keep
    @SophixEntry(MyRealApplication.class)
    static class RealApplicationStub {}

    SophixEntry应指定项目中原先真正的Application（原项目里application的android::name指定的），这里用MyRealApplication指代。并且保证RealApplicationStub类名不被混淆。而SophixStubApplication的类名和包名可以自行取名。

    重要

    SophixStubApplication类中不能有任何的其他逻辑代码，您可以使用SharePreference保存状态。

    这里的Keep是android.support包中的类，目的是为了防止这个内部静态类的类名被混淆，因为sophix内部会反射获取这个类的SophixEntry。如果项目中没有依赖android.support的话，就需要在progurad里面手动指定RealApplicationStub不被混淆，详见下文。

    然后，在proguard文件里面需要加上下面内容：

    -keepclassmembers class com.my.pkg.MyRealApplication {
    public <init>();
}
-keep class com.my.pkg.SophixStubApplication$RealApplicationStub

    目的是防止真正Application的构造方法被proguard混淆。

    最后，需要把AndroidManifest里面的application改为这个新增的SophixStubApplication类：

        <application
        android:name="com.my.pkg.SophixStubApplication"
        ... ...>
        ... ...

    这样便完成了新方式的初始化接入改造。

  7. 拉取补丁

    初始化完成之后，可以去服务端查询并拉取补丁。

    SophixManager.getInstance().queryAndLoadNewPatch();
    重要

    • queryAndLoadNewPatch方法用来请求控制台发布的补丁包，会发起网络请求，所以必须在用户同意隐私协议之后调用。

    • 但不可放在attachBaseContext中，否则无网络权限，建议放在主进程用户同意隐私协议之后的任意时刻。

  8. 接入验证

    在Logcat中查看日志，验证功能是否正常。过滤tag: Sophix，查看下面的关键日志。

    # 开始拉取补丁
Sophix.NetworkManager I   query start
# 拉取补丁成功
Sophix.NetworkManager I   query download success
# 开始预加载补丁
Sophix.ColdDexManager I   preloadDex start sophix-merged.zip
# 预加载补丁成功
Sophix.ColdDexManager I   preloadDex end time consumed(ms): 36064
# 冷启动后，成功加载补丁
Sophix.PatchManager   I   loadPatch success hasDexPatched: true hasResPatched: true hasSOPatched: false

遇到集成问题可先查看常见问题和常见状态码解决，通过文档不能解决，可以联系：联系我们。

学习资料参考

说明

如有其他非官方资料请通过联系我们加钉钉群，把您的文章与我们分享，我们会挑选好文放在这里。

上一篇：SDK简介下一篇：SDK快速接入（不建议使用）