前言
在IT行业蓬勃发展的今天,作为程序猿的我们要时刻紧跟IT技术的步伐。移动互联网发展可谓日新月异,各种黑科技横空出世,目不暇接!今天我们就来学习下如何正确集成阿里云的移动热修复黑科技——Sophix。按照阿里云官方集成文档,我们含辛茹苦地把Demo搭建好了,Demo运行起来也能正常加载修复包Pathch
。但是,当你按照文档真正把Sophix集成到你的项目中的时候,各种 can not find class...
,一万匹曹泥马在你心中狂奔而过!!
步骤简介
-
创建项目
1、新建项目:SophixDemo
2、在项目的build.gradle
文件中添加maven
路径:
allprojects {
repositories {
google()
jcenter()
//aliyun hot fix
maven { url "http://maven.aliyun.com/nexus/content/repositories/releases" }
}
}
3、在app
的build.gradle
文件中添加SDK引用:
dependencies {
//其他SDK引用
//Sophix hot fix SDK
implementation 'com.aliyun.ams:alicloud-android-hotfix:3.2.0'
}
4、创建SophixStubApplication.java
和MyApplication.java
MyApplication.java
import android.app.Application;
import com.taobao.sophix.SophixManager;
/**
* Created on 2018/2/2.
*
* @author jsc
*/
public class MyApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
//hot fix. Load patch from aliyun service.
SophixManager.getInstance().queryAndLoadNewPatch();
}
}
SophixStubApplication.java
import android.content.Context;
import android.content.DialogInterface;
import android.support.annotation.Keep;
import android.support.multidex.MultiDex;
import android.support.v7.app.AlertDialog;
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;
/**
* Sophix入口类,专门用于初始化Sophix,不应包含任何业务逻辑。
* 此类必须继承自SophixApplication,onCreate方法不需要实现。
* 此类不应与项目中的其他类有任何互相调用的逻辑,必须完全做到隔离。
* AndroidManifest中设置application为此类,而SophixEntry中设为原先Application类。
* 注意原先Application里不需要再重复初始化Sophix,并且需要避免混淆原先Application类。
* 如有其它自定义改造,请咨询官方后妥善处理。
*/
public class SophixStubApplication extends SophixApplication {
private final String TAG = "SophixStubApplication";
//aesKey必须是16位数字或字母的组合,是和补丁工具设置里面AES Key保持完全一致, 补丁才能正确被解密进而加载
final String aesKey = "";
final String appId = "";
final String appSecret = "";
final String rsa = "";
// 此处SophixEntry应指定真正的Application,并且保证RealApplicationStub类名不被混淆。
@Keep
@SophixEntry(MyApplication.class)
static class RealApplicationStub {
}
@Override
protected void attachBaseContext(Context base) {
super.attachBaseContext(base);
// 如果需要使用MultiDex,需要在此处调用。
MultiDex.install(this);
initSophix();
}
private void initSophix() {
String appVersion;
try {
appVersion = this.getPackageManager()
.getPackageInfo(this.getPackageName(), 0)
.versionName;
} catch (Exception e) {
appVersion = "0.0.0";
}
SophixManager.getInstance().setContext(this)
.setAesKey(aesKey)
.setAppVersion(appVersion)
.setSecretMetaData(appId, appSecret, rsa)
.setEnableDebug(false)
.setEnableFullLog()
.setPatchLoadStatusStub(new PatchLoadStatusListener() {
@Override
public void onLoad(final int mode, final int code, final String info, final int handlePatchVersion) {
switch (code){
case PatchStatus.CODE_LOAD_SUCCESS:
// Toast.makeText(getBaseContext(), "Patch更新成功", Toast.LENGTH_SHORT).show();
break;
case PatchStatus.CODE_LOAD_RELAUNCH:
// 如果需要在后台重启,建议此处用SharePreference保存状态。
showForceRestartAppDialog();
break;
}
}
}).initialize();
}
private void showForceRestartAppDialog(){
new AlertDialog.Builder(getBaseContext())
.setMessage("Patch更新成功,请重启应用!")
.setCancelable(false)
.setPositiveButton("退出应用", new DialogInterface.OnClickListener() {
@Override
public void onClick(DialogInterface dialog, int which) {
SophixManager.getInstance().killProcessSafely();
}
}).show();
}
}
aesKey
——必须是16位数字或字母的组合,是和补丁工具设置里面AES Key保持完全一致, 补丁才能正确被解密加载
appId
——从 APP管理 中获取
appSecret
——从 APP管理 中获取
rsa
——从 APP管理 中获取
5、添加SophixStubApplication
到你的AndroidManifest.xml
中。
我们只添加SophixStubApplication就可以了,MyApplication不用添加进去。因为SophixStubApplication内部会通过反射找到我们的MyApplication。关键代码@SophixEntry(MyApplication.class)
。
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="jsc.exam.sophix">
<application
android:name=".SophixStubApplication"
android:allowBackup="true"
android:icon="@mipmap/ic_launcher"
android:label="@string/app_name"
android:roundIcon="@mipmap/ic_launcher_round"
android:supportsRtl="true"
android:theme="@style/AppTheme">
<activity
android:name=".MainActivity"
android:label="@string/app_name"
android:theme="@style/AppTheme.NoActionBar">
<intent-filter>
<action android:name="android.intent.action.MAIN" />
<category android:name="android.intent.category.LAUNCHER" />
</intent-filter>
</activity>
<activity android:name=".AboutActivity"></activity>
</application>
</manifest>
6、编写混淆文件。在app
下的proguard-rules.pro
文件中添加:
#基线包使用,生成mapping.txt
-printmapping mapping.txt
#生成的mapping.txt在app/buidl/outputs/mapping/release路径下,移动到/app路径下
#修复后的项目使用,保证混淆结果一致
#-applymapping /build/outputs/mapping/release/mapping.txt
#hotfix
-keep class com.taobao.sophix.**{*;}
-keep class com.ta.utdid2.device.**{*;}
#防止inline
-dontoptimize
-keepclassmembers class jsc.exam.sophix.MyApplication {
public <init>();
}
# 如果不使用android.support.annotation.Keep则需加上此行
# -keep class com.my.pkg.SophixStubApplication$RealApplicationStub
{提别提示}:
a、当我们在打包发布包的时候我们开启printmapping
,关闭applymapping
。这时候在项目文件夹app\build\outputs\mapping\release
下生成mappint.txt
文件。这时候apk
和这个mapping.txt
文件我们都要做一份保存(按照规范的开发流程,这时候在代码仓库中需要建立一个新的的分支branch,不管是用svn还是git代码仓库)。apk
用来发布,mappting.txt
文件是用来生成补丁patch
打包用。
b、当我们在打包补丁包的时候我们关闭printmapping
,开启applymapping
。这时候applymapping
指向我们mappting.txt
文件所在的路径。在demo中直接指向了app\build\outputs\mapping\release\mappint.txt
。
如前言所说的各种 can not find class
的罪魁祸首多半就是混淆。
如果找不类,我们可以从以下几方面去找到问题:
A、检查发布包、补丁包、APP管理的版本号是否一致。
B、检查发布包、补丁包是否用同一份mapping.txt来混淆打包的。
只要注意以上两点,集成Sophix
基本上不会出现什么问题的。
- 生成补丁包——请参照官方文档
- 测试补丁包——请参照官方文档
- 发布补丁包——请参照官方文档[APP管理]
源码
示例:https://github.com/JustinRoom/SophixDemo
结尾
希望这篇小文章能帮使用Sophix的小伙伴们跳过这些坑,不奢求打赏,加个关注啰!我是JustinEoy,QQ:1006368252
。
网友评论