sophix集成指南

Sophix接入指南

|版本號(hào)|日期|修改人|
|-----|----|---------------|-----|
V3.2.13|2020-4-27|陳鑫飛

1、應(yīng)用配置

1）

https://mhub.console.aliyun.com/?spm=5176.13194971.0.0.53cbcb3cvDCnNo#/productList

下載配置文件 'aliyun-emas-services.json'將下載的文件放置到工程根路徑下

  1. 修改項(xiàng)目級(jí)目錄下build.gradle（{project}/build.gradle）
buildscript {
  repositories {
    maven {
      url 'http://maven.aliyun.com/nexus/content/repositories/releases/'
    }
  dependencies {
    // 添加emas-services插件
    classpath 'com.aliyun.ams:emas-services:1.0.1'
  }
}
allprojects {
  repositories {
    ...
    maven {
      url 'http://maven.aliyun.com/nexus/content/repositories/releases/'
    }
  }

3)修改應(yīng)用級(jí)build.gradle（{project}/<app-module>/build.gradle）:

// 在 apply plugin: 'com.android.application' 下添加
apply plugin: 'com.aliyun.ams.emas-services'

4)修改應(yīng)用目錄下json文件（{project}/<app-module>/ aliyun-emas-services.json），將不需要使用的產(chǎn)品service對(duì)應(yīng)的status狀態(tài)置為0（status=0或1時(shí)，分別表示不加載或加載該產(chǎn)品SDK）

2、應(yīng)用權(quán)限

Sophix SDK使用到以下權(quán)限（6.0以上需要手動(dòng)獲取讀寫(xiě)權(quán)限）

<! -- 網(wǎng)絡(luò)權(quán)限 -->
<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" />
<! -- 外部存儲(chǔ)讀權(quán)限，調(diào)試工具加載本地補(bǔ)丁需要 -->
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>

3、SophixStubApplication

 public class SophixStubApplication extends SophixApplication {
    private final String TAG = "Sophix";
 
    // 此處SophixEntry應(yīng)指定真正的Application，并且保證RealApplicationStub類(lèi)名不被混淆。
    @Keep
    @SophixEntry(GowildApplication.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)
                .setAppVersion(appVersion)
                .setSecretMetaData("appkeyXXX","secret","rsaXXX")
               //注意上線必須改成false，否則會(huì)跳過(guò)校驗(yàn)，風(fēng)險(xiǎn)較大
                .setEnableDebug(false)
                .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) {
                            // 如果需要在后臺(tái)重啟，建議此處用SharePreference保存狀態(tài)。
                            Log.i(TAG, "sophix preload patch success. restart app to make effect.");
                        }
                    }
                }).initialize();
    }
 
    @Override
    public void onCreate() {
        super.onCreate();
        SophixManager.getInstance().queryAndLoadNewPatch();
    }
}

4、生成補(bǔ)丁

下載打包工具
patch補(bǔ)丁包生成需要使用到打補(bǔ)丁工具SophixPatchTool, 如還未下載打包工具，請(qǐng)前往下載Android打包工具。

Mac版本打包工具地址：http://ams-hotfix-repo.oss-cn-shanghai.aliyuncs.com/SophixPatchTool_macos.zip

Windows版本打包工具地址：http://ams-hotfix-repo.oss-cn-shanghai.aliyuncs.com/SophixPatchTool_windows.zip

Linux版本打包工具地址：http://ams-hotfix-repo.oss-cn-shanghai.aliyuncs.com/SophixPatchTool_linux.zip

調(diào)試工具地址：http://ams-hotfix-repo.oss-cn-shanghai.aliyuncs.com/hotfix_debug_tool-release.apk

該工具提供了Windows和macOS和Linux版本，Windows下運(yùn)行SophixPatchTool.exe，macOS下運(yùn)行SophixPatchTool.app，Linux下（Ubuntu 16.04 64bit最佳）運(yùn)行SophixPatchTool。并且需要安裝Java環(huán)境且在JDK7或以上才能正常使用。

1.2 生成Patch
1.2.1 主對(duì)話框


image

舊包：<必填> 選擇基線包路徑（有問(wèn)題的APK）。
新包：<必填> 選擇新包路徑（修復(fù)過(guò)該問(wèn)題APK）。
日志：打開(kāi)日志輸出窗口。
高級(jí)：展開(kāi)高級(jí)選項(xiàng)，見(jiàn)1.2.2。
設(shè)置：配置其他信息。
GO!：開(kāi)始生成補(bǔ)丁。
1.2.2 主對(duì)話框 - 高級(jí)選項(xiàng)


avatar

強(qiáng)制冷啟動(dòng)：勾選的話強(qiáng)制生成補(bǔ)丁包為需要冷啟動(dòng)才能修復(fù)的格式。默認(rèn)不選的話，工具會(huì)根據(jù)代碼變更情況自動(dòng)選擇即時(shí)熱替換或者冷啟動(dòng)修復(fù)。
不比較資源：打補(bǔ)丁時(shí)不比較資源的變化。
不比較SO庫(kù)：打補(bǔ)丁時(shí)不比較SO庫(kù)的變化。
1.2.3 設(shè)置對(duì)話框

avatar

補(bǔ)丁輸出路徑：<必填> 指定生成補(bǔ)丁之后補(bǔ)丁的存放位置，必須是已存在的目錄。
Key Store Path：<選填>本地的簽名文件的路徑，不輸入則不做簽名。目前只支持jks的簽名文件。
Key Store Password：<選填>證書(shū)文件的密碼。
Key Alias：<選填>Key的別名。
Key Passwrod：<選填>Key的密碼。
AES Key：<選填>自定義aes秘鑰, 必須是16位數(shù)字或字母的組合。必須與setAesKey中設(shè)置的秘鑰一致。
Filter Class File：<選填>本地的白名單類(lèi)列表文件的路徑，放進(jìn)去的類(lèi)不會(huì)再計(jì)算patch，文件格式: 一行一個(gè)類(lèi)名。
1.3 命令行方式
SophixPatchTool 3.1.6之后支持以命令行的方式生成補(bǔ)丁包。

采用命令行方式前，需要準(zhǔn)備以下json格式的配置文件：

放大查看
{
"AesKey": "",
"ClassFilterFilePath": "",
"KeyAlias": "",
"KeyPassword": "",
"KeyStorePassword": "",
"KeyStorePath": "",
"NewApkPath": "/path/to/new.apk",
"OldApkPath": "/path/to/old.apk",
"OutputDirPath": "/path/to/output/dir/",
"isForceColdFix": false,
"isIgnoreRes": false,
"isIgnoreSo": false
}
其中，必填的項(xiàng)目是NewApkPath、OldApkPath、OutputDirPath。其他的配置與圖形界面所對(duì)應(yīng)項(xiàng)一致。然后把它存為profiles.json文件即可。

接下來(lái)，可以用下面的命令進(jìn)行打包：

放大查看
SophixPatchTool --profiles profiles.json
執(zhí)行完畢后就可以在OutputDirPath下輸出補(bǔ)丁文件了。

SophixPatchTool在windows平臺(tái)下為SophixPatchTool.exe，mac平臺(tái)下為SophixPatchTool.app/Contents/MacOS/SophixPatchTool

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書(shū)系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容