Sophix接入指南
|版本號|日期|修改人|
|-----|----|---------------|-----|
V3.2.13|2020-4-27|陳鑫飛
1、應用配置
1）
https://mhub.console.aliyun.com/?spm=5176.13194971.0.0.53cbcb3cvDCnNo#/productList
下載配置文件 'aliyun-emas-services.json'將下載的文件放置到工程根路徑下
- 修改項目級目錄下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)修改應用級build.gradle（{project}/<app-module>/build.gradle）:
// 在 apply plugin: 'com.android.application' 下添加
apply plugin: 'com.aliyun.ams.emas-services'
4)修改應用目錄下json文件（{project}/<app-module>/ aliyun-emas-services.json）以现，將不需要使用的產(chǎn)品service對應的status狀態(tài)置為0（status=0或1時，分別表示不加載或加載該產(chǎn)品SDK）
2箕速、應用權限
Sophix SDK使用到以下權限（6.0以上需要手動獲取讀寫權限）
<! -- 網(wǎng)絡權限 -->
<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"/>
3朋譬、SophixStubApplication
public class SophixStubApplication extends SophixApplication {
private final String TAG = "Sophix";
// 此處SophixEntry應指定真正的Application盐茎，并且保證RealApplicationStub類名不被混淆。
@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徙赢，否則會跳過校驗字柠，風險較大
.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) {
// 如果需要在后臺重啟，建議此處用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窑业、生成補丁
下載打包工具
patch補丁包生成需要使用到打補丁工具SophixPatchTool, 如還未下載打包工具，請前往下載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
調試工具地址：http://ams-hotfix-repo.oss-cn-shanghai.aliyuncs.com/hotfix_debug_tool-release.apk
該工具提供了Windows和macOS和Linux版本常柄，Windows下運行SophixPatchTool.exe，macOS下運行SophixPatchTool.app搀擂，Linux下（Ubuntu 16.04 64bit最佳）運行SophixPatchTool西潘。并且需要安裝Java環(huán)境且在JDK7或以上才能正常使用。
1.2 生成Patch
1.2.1 主對話框
舊包：<必填> 選擇基線包路徑（有問題的APK）哨颂。
新包：<必填> 選擇新包路徑（修復過該問題APK）喷市。
日志：打開日志輸出窗口。
高級：展開高級選項威恼，見1.2.2品姓。
設置：配置其他信息。
GO!：開始生成補丁箫措。
1.2.2 主對話框 - 高級選項
強制冷啟動：勾選的話強制生成補丁包為需要冷啟動才能修復的格式腹备。默認不選的話，工具會根據(jù)代碼變更情況自動選擇即時熱替換或者冷啟動修復斤蔓。
不比較資源：打補丁時不比較資源的變化植酥。
不比較SO庫：打補丁時不比較SO庫的變化。
1.2.3 設置對話框
補丁輸出路徑：<必填> 指定生成補丁之后補丁的存放位置附迷，必須是已存在的目錄惧互。
Key Store Path：<選填>本地的簽名文件的路徑，不輸入則不做簽名喇伯。目前只支持jks的簽名文件喊儡。
Key Store Password：<選填>證書文件的密碼。
Key Alias：<選填>Key的別名稻据。
Key Passwrod：<選填>Key的密碼艾猜。
AES Key：<選填>自定義aes秘鑰, 必須是16位數(shù)字或字母的組合。必須與setAesKey中設置的秘鑰一致捻悯。
Filter Class File：<選填>本地的白名單類列表文件的路徑匆赃，放進去的類不會再計算patch，文件格式: 一行一個類名今缚。
1.3 命令行方式
SophixPatchTool 3.1.6之后支持以命令行的方式生成補丁包算柳。
采用命令行方式前，需要準備以下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
}
其中姓言，必填的項目是NewApkPath瞬项、OldApkPath、OutputDirPath何荚。其他的配置與圖形界面所對應項一致囱淋。然后把它存為profiles.json文件即可。
接下來餐塘，可以用下面的命令進行打包：
放大查看
SophixPatchTool --profiles profiles.json
執(zhí)行完畢后就可以在OutputDirPath下輸出補丁文件了妥衣。
SophixPatchTool在windows平臺下為SophixPatchTool.exe，mac平臺下為SophixPatchTool.app/Contents/MacOS/SophixPatchTool
