Android 接入阿里热修复Sophix框架

傷城~ 2023-06-11 09:23 8阅读 0赞

### 一：**为什么选阿里热修复** ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70][]

### 二：**阿里热修复的原理（**Sophix技术概览：[https://yq.aliyun.com/articles/103527][https_yq.aliyun.com_articles_103527]**）** ###

### ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 1][] ###

### 三：创建产品及应用（一二三点，都在阿里云官网可以看到） ###

**1.1 找到移动研发平台入口**

在阿里云官网，找到：[移动研发平台][Link 1]，点击后，进入到移动研发平台官网详情页面

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 2][]

点击后，进入到[移动研发平台][Link 2]（Enterprise Mobile Application Studio，简称EMAS）官网详情页面，如下图所示：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 3][]

**1.2 进入管理控制台**

如果没有开通服务，点击“立即开通”，用支付宝登入下，用支付宝个人实名认证下

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 4][]

然后开通EMAS服务![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 5][]

如果已经开通，点击“管理控制台”按钮，进入到控制台页面，点击新建产品

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 6][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 7][]

**1.3 点击产品，进入到单产品服务目录页面**

点击移动供热修复，如果没有应用，前先添加应用

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 8][]

写入应用包名和名称

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 9][]

下载aliyun-emas-services.json，并放置到根目录下

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 10][]  
**1.4 获取SDK配置信息**

获取到AppKey和AppSecret

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 11][]

### **2 SDK快速接入**     ###

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

添加maven仓库地址：

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

**2.2 添加gradle坐标版本依赖：**

implementation('com.aliyun.ams:alicloud-android-hotfix:3.2.8') {
        //utdid冲突处理
       // exclude(module: 'alicloud-android-utdid')
    }

**2.3 Sophix SDK使用到以下权限**

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

**2.4 在AndroidManifest.xml的Application节点下添加如下配置**

这个RSASECRET的值,我在控制台没有看到,是在aliyun-emas-services.json里找到的

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 12][]

**2.5  混淆配置**

#基线包使用，生成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

**2.6 在application下添加代码，实现快速接入**

public class HotFixApplication extends Application {
    
        private final String TAG = "HotFixApplication";
    
        @Override
        protected void attachBaseContext(Context base) {
            super.attachBaseContext(base);
            //  MultiDex.install(this);
            final SophixManager instance = SophixManager.getInstance();
            instance.setContext(this)
                    .setAppVersion(getVersionCode(base))
                    .setAesKey(null)
                    .setEnableDebug(true)
                    .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) {
                                // 表明补丁加载成功
                            } else if (code == PatchStatus.CODE_LOAD_RELAUNCH) {
                                // 表明新补丁生效需要重启. 开发者可提示用户或者强制重启;
                                // 建议: 用户可以监听进入后台事件, 然后调用killProcessSafely自杀，以此加快应用补丁，详见1.3.2.3
                            } else {
                                // 其它错误信息, 查看PatchStatus类说明
                            }
                            Log.d(TAG, "code=" + code + "   info=" + info + "   handlePatchVersion=" + handlePatchVersion);
                        }
                    }).initialize();
        }
    
        private String getVersionCode(Context base) {
            try {
                return String.valueOf(base.getPackageManager().getPackageInfo(base.getPackageName(), 0).versionCode);
            } catch (PackageManager.NameNotFoundException e) {
                return "";
            }
        }
    
        @Override
        public void onCreate() {
            super.onCreate();
            SophixManager.getInstance().queryAndLoadNewPatch();
        }
    }

备注：官方文档地址：[https://help.aliyun.com/product/51340.html?spm=a2c4g.11186623.6.540.47e3741ex5bVzq][https_help.aliyun.com_product_51340.html_spm_a2c4g.11186623.6.540.47e3741ex5bVzq]

调试工具地址：[http://ams-hotfix-repo.oss-cn-shanghai.aliyuncs.com/hotfix\_debug\_tool-release.apk][http_ams-hotfix-repo.oss-cn-shanghai.aliyuncs.com_hotfix_debug_tool-release.apk]

### 3 实现热修复功能 ###

我们原始的代码打个包，修改了再打个包（如果是系统版本超过6.0的，要填加手动获取权限的代码，要不然会在加载补丁的时候报没有权限的错误），用sophix热更新补丁工具，生成补丁（这个设置和高级，自己看着配置下）

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 13][]

生成了补丁，先将补丁放到某个文件夹里

![20191030171343507.png][]

用Sophix调试工具加载本地的补丁，测试下热修复（安装的要是旧包，然后通过热修复，达到新包的样子）

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 14][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 15][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 16][]

这个状态码，官方有文档的，可以自己对照看下，上面的是快速接入，这样接入有个在Android 9.0以上系统会有发生崩溃的风险缺点，最好选择稳健接入方式接入

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 17][]

### 4 稳健接入 ###

前面的步骤都相同，就混淆文件和application改下

混淆文件添加

`   -keepclassmembers class com.my.pkg.MyRealApplication {`

`   public <init>();`

`   }`

`   # 如果不使用android.support.annotation.Keep则需加上此行`

`   # -keep class com.my.pkg.SophixStubApplication$RealApplicationStub`

新增SophixStubApplication文件

public class SophixStubApplication extends SophixApplication {
        private final String TAG = "SophixStubApplication";
        // 此处SophixEntry应指定真正的Application，并且保证RealApplicationStub类名不被混淆。
        @Keep
        @SophixEntry(HotFixApplication.class)
        static class RealApplicationStub {}
        @Override
        protected void attachBaseContext(Context base) {
            super.attachBaseContext(base);
    //         如果需要使用MultiDex，需要在此处调用。
        //    MultiDex.install(this);
            initSophix(base);
        }
        private void initSophix(Context base) {
    
            final SophixManager instance = SophixManager.getInstance();
            instance.setContext(this)
                    .setAppVersion(getVersionCode(base))
                    .setSecretMetaData(null, null, null)
                    .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();
        }
        private String getVersionCode(Context base) {
            try {
                return String.valueOf(base.getPackageManager().getPackageInfo(base.getPackageName(), 0).versionCode);
            } catch (PackageManager.NameNotFoundException e) {
                return "";
            }
        }
        @Override
        public void onCreate() {
            super.onCreate();
             SophixManager.getInstance().queryAndLoadNewPatch();
        }
    }

将AndroidManifest.xml里的application改为SophixStubApplication

<application
        android:name=".SophixStubApplication"

### 5 发布补丁 ###

上传补丁到后台，发布补丁

点击补丁管理  点击上传补丁

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 18][]

点击操作发布，到发布界面

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 19][]

发布完，查看详情

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 20][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70]: /images/20230531/8717e622d03f4820a21aeef4fb3bd0d0.png
[https_yq.aliyun.com_articles_103527]: https://yq.aliyun.com/articles/103527?spm=a2c4g.11186623.2.53.519861dbsALnpK
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 1]: /images/20230531/10b92b95cf6349af9210a4cf62e04f46.png
[Link 1]: https://www.aliyun.com/product/emas?spm=5176.185759.h2v3icoap.392.5c2e65f7Po5baM&aly_as=bxM8ZvOp
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 2]: /images/20230531/2148659cf0954f6192c07a24e2e5e08c.png
[Link 2]: https://www.aliyun.com/product/emas
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 3]: /images/20230531/3fd845b19bc141c6ad7e49a6bf381d9e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 4]: /images/20230531/60c77fb49a4a4fffb932564a8f507e3f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 5]: /images/20230531/da3c7d936a594e5caeebcbe79dcc8122.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 6]: /images/20230531/19996dd512da440e98f70e25381a0a30.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 7]: /images/20230531/7f00265d7d1745cb8f0c6324c79719bd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 8]: /images/20230531/215e519dcfa647a0a6a5d64aa3fbba6a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 9]: /images/20230531/4cf1f980906b421ca4a8447e9f99e561.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 10]: /images/20230531/6d9d3d3521bf4ba58c807b9262865447.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 11]: /images/20230531/95988eb1132f426c8ae51cf2cbb37254.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 12]: /images/20230531/df71c20ee59145c99db6a9eed750dd7e.png
[https_help.aliyun.com_product_51340.html_spm_a2c4g.11186623.6.540.47e3741ex5bVzq]: https://help.aliyun.com/product/51340.html?spm=a2c4g.11186623.6.540.47e3741ex5bVzq
[http_ams-hotfix-repo.oss-cn-shanghai.aliyuncs.com_hotfix_debug_tool-release.apk]: http://ams-hotfix-repo.oss-cn-shanghai.aliyuncs.com/hotfix_debug_tool-release.apk
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 13]: /images/20230531/d9fccd05c5744c4d8c52140e74356b34.png
[20191030171343507.png]: /images/20230531/111f95dfc8274e4eb76a5a39bfad2b3b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 14]: https://img-blog.csdnimg.cn/20191030172104243.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 15]: https://img-blog.csdnimg.cn/20191030172226161.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 16]: /images/20230531/1ea9eff0b6554827bd710d211a94c272.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 17]: /images/20230531/86ee8f9b3fa240b2a25e677e4c08582d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 18]: /images/20230531/b9e2bb3b2dc845eea224423313739b59.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 19]: /images/20230531/c6e63e4f628d48cd98b74a445e225996.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnNoaW5lXzA3MDc_size_16_color_FFFFFF_t_70 20]: /images/20230531/7b5670fe327f4030a2293d45f428d7a6.png