最近公司項目中須要集成熱更新功能,因爲剛開始接入的時候踩了不少坑,因此如今記錄一下集成的過程. 集成過程參考了Bugly官方文檔熱更新使用指南 bugly.qq.com/docs/user-g…android
熱更新是Bugly爲解決開發者緊急修復線上bug,而無需從新發版讓用戶無感知就能把問題修復的一項能力。Bugly目前採用微信Tinker的開源方案,開發者只須要集成咱們提供的SDK就能夠實現自動下載補丁包、合成、並應用補丁的功能,提供了熱更新管理後臺讓開發者對每一個版本補丁進行管理。git
爲何使用Bugly熱更新?
無需關注Tinker是如何合成補丁的
無需本身搭建補丁管理後臺
無需考慮後臺下發補丁策略的任何事情
無需考慮補丁下載合成的時機,處理後臺下發的策略
提供了更加方便集成Tinker的方式
經過HTTPS及簽名校驗等機制保障補丁下發的安全性
豐富的下發維度控制,有效控制補丁影響範圍
提供了應用升級一站式解決方案
複製代碼
第一步:添加插件依賴 工程根目錄下「build.gradle」文件中添加:github
buildscript {
repositories {
jcenter()
}
dependencies {
// tinkersupport插件, 其中lastest.release指拉取最新版本,也能夠指定明確版本號,例如1.0.4
classpath"com.tencent.bugly:tinker-support:latest.release"//拉取的是最新版本
}
}
複製代碼
這裏寫代碼片安全
第二步:集成SDK gradle配置 在app module的「build.gradle」文件中添加:bash
android {
defaultConfig {
ndk {
//設置支持的SO庫架構
abiFilters 'armeabi' //, 'x86', 'armeabi-v7a', 'x86_64', 'arm64-v8a'
}
}
}
dependencies {
compile "com.android.support:multidex:1.0.1"
//其中latest.release指代最新版本號,也能夠指定明確的版本號,例如1.2.0
compile'com.tencent.bugly:crashreport_upgrade:latest.release'
//其中latest.release指代最新版本號,也能夠指定明確的版本號,例如2.2.0
compile'com.tencent.bugly:nativecrashreport:latest.release'
}
複製代碼
在app module的「build.gradle」文件中添加:微信
// 依賴插件腳本
apply from: 'tinker-support.gradle'
複製代碼
tinker-support.gradle內容以下所示: 注:須要在app module下建立tinker-support.gradle這個文件架構
apply plugin: 'com.tencent.bugly.tinker-support'
def bakPath = file("${buildDir}/bakApk/")
/**
* 此處填寫每次構建生成的基準包目錄
*/
def baseApkDir = "app-0908-17-42-31"
/**
* 對於插件各參數的詳細解析請參考
*/
tinkerSupport {
// 開啓tinker-support插件,默認值true
enable = true
// 指定歸檔目錄,默認值當前module的子目錄tinker
autoBackupApkDir = "${bakPath}"
// 編譯補丁包時,必需指定基線版本的apk,默認值爲空
// 若是爲空,則表示不是進行補丁包的編譯
// @{link tinkerPatch.oldApk }
baseApk = "${bakPath}/${baseApkDir}/app-release.apk"
// 對應tinker插件applyMapping
baseApkProguardMapping = "${bakPath}/${baseApkDir}/app-release-mapping.txt"
// 對應tinker插件applyResourceMapping
baseApkResourceMapping = "${bakPath}/${baseApkDir}/app-release-R.txt"
// 構建基準包和補丁包都要指定不一樣的tinkerId,而且必須保證惟一性
// tinkerId = "base-1.0.4"
tinkerId = "patch-1.0.4"
// 是否啓用覆蓋tinkerPatch配置功能,默認值false
// 開啓後tinkerPatch配置不生效,即無需添加tinkerPatch
overrideTinkerPatchConfiguration = true
// 構建多渠道補丁時使用
// buildAllFlavorsDir = "${bakPath}/${baseApkDir}"
//支持加固須要添加的屬性
isProtectedApp = true
// 是否開啓反射Application模式
enableProxyApplication = true
}
/**
* 通常來講,咱們無需對下面的參數作任何的修改
* 對於各參數的詳細介紹請參考:
* https://github.com/Tencent/tinker/wiki/Tinker-%E6%8E%A5%E5%85%A5%E6%8C%87%E5%8D%97
*/
tinkerPatch {
oldApk = "${bakPath}/${baseApkDir}/app-release.apk"
ignoreWarning = false
useSign = true
dex {
dexMode = "jar"
pattern = ["classes*.dex"]
loader = []
}
lib {
pattern = ["lib/*/*.so"]
}
res {
pattern = ["res/*", "r/*", "assets/*", "resources.arsc", "AndroidManifest.xml"]
ignoreChange = []
largeModSize = 100
}
packageConfig {
}
sevenZip {
zipArtifact = "com.tencent.mm:SevenZip:1.1.10"
// path = "/usr/local/bin/7za"
}
buildConfig {
keepDexApply = false
//tinkerId = "1.0.1-base"
//applyMapping = "${bakPath}/${appName}/app-release-mapping.txt" // 可選,設置mapping文件,建議保持舊apk的proguard混淆方式
//applyResourceMapping = "${bakPath}/${appName}/app-release-R.txt" // 可選,設置R.txt文件,經過舊apk文件保持ResId的分配
}
}
複製代碼
第三步:初始化SDKapp
enableProxyApplication = false 的狀況(親測這種)ide
這是Tinker推薦的接入方式,必定程度上會增長接入成本,但具備更好的兼容性。
集成Bugly升級SDK以後,咱們須要按照如下方式自定義ApplicationLike來實現Application的代碼
複製代碼
自定義Application學習
public class SampleApplication extends TinkerApplication {
/*注意:這個類集成TinkerApplication類,這裏面不作任何操做,全部Application的代碼都會放到ApplicationLike繼承類當中
參數解析
參數1:tinkerFlags 表示Tinker支持的類型 dex only、library only or all suuport,default: TINKER_ENABLE_ALL
參數2:delegateClassName Application代理類 這裏填寫你自定義的ApplicationLike
參數3:loaderClassName Tinker的加載器,使用默認便可
參數4:tinkerLoadVerifyFlag 加載dex或者lib是否驗證md5,默認爲false*/
public SampleApplication() {
super(TINKER_ENABLE_ALL, "包名.weixinTinker.SampleApplicationLike", "com.tencent.tinker.loader.TinkerLoader", false);
}
}
複製代碼
自定義SampleApplicationLike
/**
* 自定義ApplicationLike類.
* 注意:這個類是Application的代理類,之前全部在Application的實現必需要所有拷貝到這裏<br/>
*/
public class SampleApplicationLike extends DefaultApplicationLike {
public static final String TAG = "Tinker.SampleApplicationLike";
public SampleApplicationLike(Application application, int tinkerFlags,
boolean tinkerLoadVerifyFlag, long applicationStartElapsedTime,
long applicationStartMillisTime, Intent tinkerResultIntent) {
super(application, tinkerFlags, tinkerLoadVerifyFlag, applicationStartElapsedTime,
applicationStartMillisTime, tinkerResultIntent);
}
@Override
public void onCreate() {
super.onCreate();
// 設置是否開啓熱更新能力,默認爲true
Beta.enableHotfix = true;
// 設置是否自動下載補丁,默認爲true
Beta.canAutoDownloadPatch = false;
// 設置是否自動合成補丁,默認爲true
Beta.canAutoPatch = false;
// 設置是否提示用戶重啓,默認爲false
Beta.canNotifyUserRestart = true;
// 補丁回調接口
Beta.betaPatchListener = new BetaPatchListener() {
@Override
public void onPatchReceived(String patchFile) {
//Toast.makeText(getApplication(), "補丁下載地址" + patchFile, Toast.LENGTH_SHORT).show();
}
@Override
public void onDownloadReceived(long savedLength, long totalLength) {
Toast.makeText(getApplication(),
String.format(Locale.getDefault(), "%s %d%%",
"資源正在下載中",
(int) (totalLength == 0 ? 0 : savedLength * 100 / totalLength)),
Toast.LENGTH_SHORT).show();
}
@Override
public void onDownloadSuccess(String msg) {
Toast.makeText(getApplication(), "資源下載成功,正在準備解壓", Toast.LENGTH_SHORT).show();
Beta.applyDownloadedPatch();
}
@Override
public void onDownloadFailure(String msg) {
Toast.makeText(getApplication(), "資源下載失敗,請從新啓動應用嘗試", Toast.LENGTH_SHORT).show();
}
@Override
public void onApplySuccess(String msg) {
Toast.makeText(getApplication(), "資源解壓完成,請關閉應用,點擊桌面圖標啓動", Toast.LENGTH_SHORT).show();
}
@Override
public void onApplyFailure(String msg) {
Toast.makeText(getApplication(), "資源解壓失敗,請稍後嘗試", Toast.LENGTH_SHORT).show();
}
@Override
public void onPatchRollback() {
}
};
// 設置開發設備,默認爲false,上傳補丁若是下發範圍指定爲「開發設備」,須要調用此接口來標識開發設備
Bugly.setIsDevelopmentDevice(getApplication(), true);
// 這裏實現SDK初始化,appId替換成你的在Bugly平臺申請的appId
Bugly.init(getApplication(), appId, true);
}
@TargetApi(Build.VERSION_CODES.ICE_CREAM_SANDWICH)
@Override
public void onBaseContextAttached(Context base) {
super.onBaseContextAttached(base);
// you must install multiDex whatever tinker is installed!
MultiDex.install(base);
// TODO: 安裝tinker
Beta.installTinker(this);
}
@TargetApi(Build.VERSION_CODES.ICE_CREAM_SANDWICH)
public void registerActivityLifecycleCallback(
Application.ActivityLifecycleCallbacks callbacks) {
getApplication().registerActivityLifecycleCallbacks(callbacks);
}
}
注意:tinker須要你開啓MultiDex,你須要在dependencies中進行配置compile "com.android.support:multidex:1.0.1"纔可使用MultiDex.install方法; SampleApplicationLike這個類是Application的代理類,之前全部在Application的實現必需要所有拷貝到這裏,在onCreate方法調用SDK的初始化方法,在onBaseContextAttached中調用Beta.installTinker(this);。
複製代碼
enableProxyApplication = true 的狀況(沒測試這種)
public class MyApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
// 這裏實現SDK初始化,appId替換成你的在Bugly平臺申請的appId
// 調試時,將第三個參數改成true
Bugly.init(this, "900029763", false);
}
@Override
protected void attachBaseContext(Context base) {
super.attachBaseContext(base);
// you must install multiDex whatever tinker is installed!
MultiDex.install(base);
// 安裝tinker
Beta.installTinker();
}
}
注:無須你改造Application,主要是爲了下降接入成本,咱們插件會動態替換AndroidMinifest文件中的Application爲咱們定義好用於反射真實Application的類(須要您接入SDK 1.2.2版本 和 插件版本 1.0.3以上)
複製代碼
第四步:AndroidManifest.xml配置 在AndroidMainfest.xml中進行如下配置:
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<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_LOGS" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
複製代碼
<activity
android:name="com.tencent.bugly.beta.ui.BetaActivity"
android:configChanges="keyboardHidden|orientation|screenSize|locale"
android:theme="@android:style/Theme.Translucent" />
複製代碼
第五步:混淆配置 爲了不混淆SDK,在Proguard混淆文件中增長如下配置:
-dontwarn com.tencent.bugly.**
-keep public class com.tencent.bugly.**{*;}
複製代碼
若是你使用了support-v4包,你還須要配置如下混淆規則:
-keep class android.support.**{*;}
複製代碼
第六步:測試
熱更新:生成加固後的差別包的步驟:
1.用簽名文件進行打包處理,會在build/outputs/bakApk路徑下生成生成三個文件:apk文件,mapping文件,R文件(建議:另保存這三個文件,防止丟失)
2.在tinker-support.gradle文件中修改如下內容:baseApkDir基準包目錄,baseApk生成的apk文件,baseApkProguardMapping生成的mapping文件,baseApkResourceMapping生成的R文件
3.將生成的apk文件,進行加固,從新簽名(加固時須要操做)
4.將從新簽名後的文件,複製放在app module項目下(加固是須要的操做)
5.在AS右上角打開Gradle,點擊app->Tasks->tinker-support,雙擊buildTinkerPatchRelease腳本,執行完成後,會在build->outputs->patch->release下生成patch_signed_7zip.apk差別包
6.將差別包patch_signed_7zip.apk給後臺配置
複製代碼
上傳補丁包到平臺 上傳補丁包到平臺並下發編輯規則
總結
官方文檔的幫助下,集成了Bugly熱更新.固然在此以前也集成過原始的Tinker熱更新,比這個的集成比較複雜,接入的時候微信Tinker還不支持加固,不知足公司的需求,過了一週後Tinker發佈新版本,新版本支持加固,考慮到用原始的Tinker集成後,須要後臺的配置才能測試,這樣感受會浪費不少的時間,因此就用Bugly來集成,這樣測試的時候,本身去Bugly後臺配置就能夠測試.
如下是我的公衆號(longxuanzhigu),以後發佈的文章會同步到該公衆號,方便交流學習Android知識及分享我的愛好文章: