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}/
// 在 apply plugin: 'com.android.application' 下添加
apply plugin: 'com.aliyun.ams.emas-services'
4)修改应用目录下json文件（{project}/
2、应用权限
Sophix SDK使用到以下权限（6.0以上需要手动获取读写权限）
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保存状态。
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环境且在JDK7或以上才能正常使用。
1.2 生成Patch
1.2.1 主对话框
旧包：<必填> 选择基线包路径（有问题的APK）。
新包：<必填> 选择新包路径（修复过该问题APK）。
日志：打开日志输出窗口。
高级：展开高级选项，见1.2.2。
设置：配置其他信息。
GO!：开始生成补丁。
1.2.2 主对话框 - 高级选项
强制冷启动：勾选的话强制生成补丁包为需要冷启动才能修复的格式。默认不选的话，工具会根据代码变更情况自动选择即时热替换或者冷启动修复。
不比较资源：打补丁时不比较资源的变化。
不比较SO库：打补丁时不比较SO库的变化。
1.2.3 设置对话框
补丁输出路径：<必填> 指定生成补丁之后补丁的存放位置，必须是已存在的目录。
Key Store Path：<选填>本地的签名文件的路径，不输入则不做签名。目前只支持jks的签名文件。
Key Store Password：<选填>证书文件的密码。
Key Alias：<选填>Key的别名。
Key Passwrod：<选填>Key的密码。
AES Key：<选填>自定义aes秘钥, 必须是16位数字或字母的组合。必须与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
执行完毕后就可以在OutputDirPath下输出补丁文件了。
SophixPatchTool在windows平台下为SophixPatchTool.exe，mac平台下为SophixPatchTool.app/Contents/MacOS/SophixPatchTool