前言
熱更新能力是Bugly為解決開發(fā)者緊急修復(fù)線上bug,而無需重新發(fā)版讓用戶無感知就能把問題修復(fù)的一項(xiàng)能力。Bugly目前采用微信Tinker的開源方案,開發(fā)者只需要集成我們提供的SDK就可以實(shí)現(xiàn)自動下載補(bǔ)丁包、合成、并應(yīng)用補(bǔ)丁的功能,我們也提供了熱更新管理后臺讓開發(fā)者對每個版本補(bǔ)丁進(jìn)行管理。
Tinker是什么:
Tinker是微信官方的Android熱補(bǔ)丁解決方案,它支持動態(tài)下發(fā)代碼、So庫以及資源,讓應(yīng)用能夠在不需要重新安裝的情況下實(shí)現(xiàn)更新。當(dāng)然,你也可以使用Tinker來更新你的插件。
為什么使用Tinker:
當(dāng)前市面的熱補(bǔ)丁方案有很多,其中比較出名的有阿里的AndFix、美團(tuán)的Robust以及QZone的超級補(bǔ)丁方案。但它們都存在無法解決的問題,Tinker我們不僅可以用做bugfix,甚至可以替代功能的發(fā)布。Tinker已運(yùn)行在微信的數(shù)億Android設(shè)備上,那么為什么你不使用Tinker呢?
接入Bugly熱更新 ?接入了熱更新就已經(jīng)接入了異常上報(bào)了,所有就不需要在進(jìn)行異常上報(bào)的接入了。
第一步:添加插件依賴
工程根目錄下“build.gradle”文件中添加:
buildscript{repositories{??
? ? ? jcenter()? ?
?}dependencies{
// tinkersupport插件, 其中l(wèi)astest.release指拉取最新版本,也可以指定明確版本號,例如1.0.4
? ? ?classpath"com.tencent.bugly:tinker-support:latest.release"
}
}
版本對應(yīng)關(guān)系:
tinker-support 1.0.5 對應(yīng) tinker 1.7.8(支持部分加固app的熱更新)
tinker-support 1.0.4 對應(yīng) tinker 1.7.7
tinker-support 1.0.3 對應(yīng) tinker 1.7.6
tinker-support 1.0.2 對應(yīng) tinker 1.7.5(需配置tinker插件的classpath)
第二步:集成SDK
gradle配置
在app module的“build.gradle”文件中添加(示例配置):
android {? ? ??
? defaultConfig {? ? ? ? ??
ndk {
//設(shè)置支持的SO庫架構(gòu)
abiFilters'armeabi'//, 'x86', 'armeabi-v7a', 'x86_64', 'arm64-v8a'}? ? ? ? }? ? ? }
dependencies{
// 多dex配置//注釋掉原有bugly的倉庫? 必須依賴multidex才可以使用 MultiDex.install(base);
compile"com.android.support:multidex:1.0.1"?
//其中l(wèi)atest.release指代最新版本號,也可以指定明確的版本號,例如1.2.0
compile'com.tencent.bugly:crashreport_upgrade:latest.release'
'//其中l(wèi)atest.release指代最新版本號,也可以指定明確的版本號,例如2.2.0
compile'com.tencent.bugly:nativecrashreport:latest.release
}
在app module的“build.gradle”文件中添加:
// 依賴插件腳本
applyfrom:'tinker-support.gradle'
tinker-support.gradle內(nèi)容如下所示(示例配置):
注:您需要在同級目錄(Moudle目錄下)下創(chuàng)建tinker-support.gradle這個文件哦。
applyplugin:'com.tencent.bugly.tinker-support'
defbakPath = file("${buildDir}/bakApk/")
/**
*此處填寫每次構(gòu)建生成的基準(zhǔn)包目錄 ?根據(jù)下面的基準(zhǔn)包生成對應(yīng)的補(bǔ)丁包
*/
defbaseApkDir ="app-0507-11-13-19"
/**
*對于插件各參數(shù)的詳細(xì)解析請參考
*/
tinkerSupport {
//開啟tinker-support插件,默認(rèn)值true
enable =true
//指定歸檔目錄,默認(rèn)值當(dāng)前module的子目錄tinker
autoBackupApkDir ="${bakPath}"
//是否啟用覆蓋tinkerPatch配置功能,默認(rèn)值false
//開啟后tinkerPatch配置不生效,即無需添加tinkerPatch
overrideTinkerPatchConfiguration =true
//編譯補(bǔ)丁包時,必需指定基線版本的apk,默認(rèn)值為空
//如果為空,則表示不是進(jìn)行補(bǔ)丁包的編譯
// @{link tinkerPatch.oldApk }
baseApk ="${bakPath}/${baseApkDir}/app-release.apk"
//對應(yīng)tinker插件applyMapping
baseApkProguardMapping ="${bakPath}/${baseApkDir}/app-release-mapping.txt"
//對應(yīng)tinker插件applyResourceMapping
baseApkResourceMapping ="${bakPath}/${baseApkDir}/app-release-R.txt"
//構(gòu)建基準(zhǔn)包和補(bǔ)丁包都要指定不同的tinkerId,并且必須保證唯一性
?tinkerId = "base-1.0.4" ? ? ?//生成對于的基包版本 ?只有生成基準(zhǔn)包的時候使用
//tinkerId ="patch-1.0.4" ? ? //對于生成的補(bǔ)丁包版本 ?只有生成補(bǔ)丁包的時候使用
//構(gòu)建多渠道補(bǔ)丁時使用?
// buildAllFlavorsDir = "${bakPath}/${baseApkDir}"
//支持加固需要添加的屬性 ?1.7.8以后才可以使用的
isProtectedApp =true
//是否開啟反射Application模式 ? 這里有2中情況?
enableProxyApplication =true
}
/**
*一般來說,我們無需對下面的參數(shù)做任何的修改
*對于各參數(shù)的詳細(xì)介紹請參考:
* 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" //可選,設(shè)置mapping文件,建議保持舊apk的proguard混淆方式
//applyResourceMapping = "${bakPath}/${appName}/app-release-R.txt" //可選,設(shè)置R.txt文件,通過舊apk文件保持ResId的分配
}
}
第三步:初始化SDK
enableProxyApplication = false 的情況
這是Tinker推薦的接入方式,一定程度上會增加接入成本,但具有更好的兼容性。
集成Bugly升級SDK之后,我們需要按照以下方式自定義ApplicationLike來實(shí)現(xiàn)Application的代碼(以下是示例):
自定義Application
public class SampleApplication extends TinkerApplication {
/*注意:這個類集成TinkerApplication類,這里面不做任何操作,所有Application的代碼都會放到ApplicationLike繼承類當(dāng)中
參數(shù)解析
參數(shù)1:tinkerFlags表示Tinker支持的類型dex only、library only or all suuport,default: TINKER_ENABLE_ALL
參數(shù)2:delegateClassName Application代理類 這里填寫你自定義的ApplicationLike
參數(shù)3:loaderClassName Tinker的加載器,使用默認(rèn)即可
參數(shù)4:tinkerLoadVerifyFlag加載dex或者lib是否驗(yàn)證md5,默認(rèn)為false*/
publicSampleApplication() {
super(TINKER_ENABLE_ALL,"com.bugly.smile.buglydemo.SampleApplicationLike","com.tencent.tinker.loader.TinkerLoader", false);
}
}
自定義的ApplicationLike
public class SampleApplicationLike extends DefaultApplicationLike {
public static finalStringTAG="Tinker.SampleApplicationLike";
public SampleApplicationLike (Application application, inttinkerFlags,
booleantinkerLoadVerifyFlag, longapplicationStartElapsedTime,
longapplicationStartMillisTime,Intent tinkerResultIntent) {
super(application,tinkerFlags,tinkerLoadVerifyFlag,applicationStartElapsedTime,applicationStartMillisTime,tinkerResultIntent);
}
@Override
public voidonCreate() {
super.onCreate();
//這里實(shí)現(xiàn)SDK初始化,appId替換成你的在Bugly平臺申請的appId
//調(diào)試時,將第三個參數(shù)改為true
Bugly.init(getApplication(),"<申請的APPID>", false);
}
@TargetApi(Build.VERSION_CODES.ICE_CREAM_SANDWICH)
@Override
public voidonBaseContextAttached(Context base) {
super.onBaseContextAttached(base);
// you must install multiDex whatever tinker is installed!
MultiDex.install(base);
//安裝tinker
// TinkerManager.installTinker(this);替換成下面Bugly提供的方法
Beta.installTinker(this);
}
@TargetApi(Build.VERSION_CODES.ICE_CREAM_SANDWICH)publicvoidregisterActivityLifecycleCallback(Application.ActivityLifecycleCallbacks callbacks){
getApplication().registerActivityLifecycleCallbacks(callbacks);
}
}
注意:tinker需要你開啟MultiDex,你需要在dependencies中進(jìn)行配置compile "com.android.support:multidex:1.0.1"才可以使用MultiDex.install方法; SampleApplicationLike這個類是Application的代理類,以前所有在Application的實(shí)現(xiàn)必須要全部拷貝到這里,在onCreate方法調(diào)用SDK的初始化方法,在onBaseContextAttached中調(diào)用Beta.installTinker(this);
enableProxyApplication = true 的情況
public class MyApplication extends Application {
@Override
public voidonCreate() {
super.onCreate();
//設(shè)置為開發(fā)設(shè)備 注意這個必須在初始化Bugly之前設(shè)置為開發(fā)設(shè)備
Bugly.setIsDevelopmentDevice(this, true);
//這里實(shí)現(xiàn)SDK初始化,appId替換成你的在Bugly平臺申請的appId
//調(diào)試時,將第三個參數(shù)改為true ?打印Log的開關(guān)
Bugly.init(this,"申請的appId", false);
//異常展示時候,建議設(shè)置為手機(jī)號碼,方便后期Bug的修復(fù)
CrashReport.setUserId(this,"你需要作為UseId的參數(shù)");?
}
@Override
protected voidattachBaseContext(Context base) {
super.attachBaseContext(base);
// you must install multiDex whatever tinker is installed!
MultiDex.install(base);
//安裝tinker
Beta.installTinker();
}
}
注:無須你改造Application,主要是為了降低接入成本,我們插件會動態(tài)替換AndroidMinifest文件中的Application為我們定義好用于反射真實(shí)Application的類
最后只需要在AndroidManifest文件中將Application替換上就可以使用了。
第四步:AndroidManifest.xml配置
1. 權(quán)限配置
<uses-permissionandroid:name="android.permission.READ_PHONE_STATE"/>
<uses-permissionandroid:name="android.permission.INTERNET" />
<uses-permissionandroid:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permissionandroid:name="android.permission.ACCESS_WIFI_STATE"/>
<uses-permissionandroid:name="android.permission.READ_LOGS"/>
<uses-permissionandroid:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
<uses-permissionandroid:name="android.permission.READ_EXTERNAL_STORAGE"/>
第五步:混淆配置
為了避免混淆SDK,在Proguard混淆文件中增加以下配置:
-dontwarn com.tencent.bugly.**
-keep public class com.tencent.bugly.**{*;}
如果你使用了support-v4包,你還需要配置以下混淆規(guī)則:
-keep class android.support.**{*;}
到這里為止 Bugly熱更新就已經(jīng)完成了,下面就是如何使用了,我們需要驗(yàn)證熱更新的能力:
注意tinker無法使用熱更新修復(fù)的情況:
由于原理與系統(tǒng)限制,Tinker有以下已知問題:
Tinker不支持修改AndroidManifest.xml,Tinker不支持新增四大組件;
由于Google Play的開發(fā)者條款限制,不建議在GP渠道動態(tài)更新代碼;
在Android N上,補(bǔ)丁對應(yīng)用啟動時間有輕微的影響;
不支持部分三星android-21機(jī)型,加載補(bǔ)丁時會主動拋出"TinkerRuntimeException:checkDexInstall failed";
對于資源替換,不支持修改remoteView。例如transition動畫,notification icon以及桌面圖標(biāo)。
驗(yàn)證Bugly熱更新 必須在聯(lián)網(wǎng)的情況下才可以使用熱更新
普通打包
1、編譯基準(zhǔn)包
配置基準(zhǔn)包的tinkerId (注意這里的base版本必須聯(lián)網(wǎng)上報(bào) 才可以上傳補(bǔ)丁包)
設(shè)置你的基準(zhǔn)版本號 最好是和app version對應(yīng)
執(zhí)行assembleRelease編譯生成基準(zhǔn)包:?
在android studio的右邊選擇gradle找到我們接入熱更新的model 進(jìn)入build中選擇生成的基準(zhǔn)包類型:這里可以是Release和Debug版本?
這個會在build/outputs/bakApk路徑下生成每次編譯的基準(zhǔn)包、混淆配置文件、資源Id文件,如下圖所示:
這里面有的app-release.apk就是我們需要上線的基線版本,請注意保存線上發(fā)布版本的基準(zhǔn)apk包、mapping文件、R.txt文件,如果線上版本有bug,就可以借助我們tinker-support插件進(jìn)行補(bǔ)丁包的生成。
如果你沒有開啟混淆是不會有mapping.txt文件的,需要在Moudle的build.g'radle文件中開啟混淆
? ?如何生成簽名文件這里就不介紹了。
2、對基線版本的bug修復(fù)
上面生成了base包了,那就需要去生成patch包了。
基準(zhǔn)包的代碼:
補(bǔ)丁包(patch)的代碼:
3、根據(jù)基線版本生成補(bǔ)丁包
這里需要注意的:基準(zhǔn)包目錄必須是你上次生成的base包,注意這里是按照時間命名的,檢查是否正確,tinkerId 需要生成patch包必須使用 tinkerId="patch-base版本號對應(yīng)"
執(zhí)行構(gòu)建補(bǔ)丁包的task
如果你要生成不同編譯環(huán)境的補(bǔ)丁包,只需要執(zhí)行TinkerSupport插件生成的task,比如buildTinkerPatchRelease就能生成release編譯環(huán)境的補(bǔ)丁包。
生成的補(bǔ)丁包在build/outputs/patch目錄下,其中7zip.apk就是我們需要使用的補(bǔ)丁包:
打開補(bǔ)丁包可以看到里面會有一個YAPATCH.MF,這里面包含了我們是從base版本到patch版本:以及app的version信息
4、上傳補(bǔ)丁包到平臺
進(jìn)入到對應(yīng)appid的app中,選擇應(yīng)用升級,熱更新,發(fā)布新補(bǔ)丁。
發(fā)布patch版本,選擇補(bǔ)丁文件之后會自動從補(bǔ)丁包的YAPATCH.MF去尋找base版本以及app版本,注意這里的base版本必須聯(lián)網(wǎng)上報(bào)(必須在聯(lián)網(wǎng)的情況下啟動app),才可以上傳補(bǔ)丁成功。如果沒有
上傳了補(bǔ)丁包可以選擇下發(fā)的范圍:
開發(fā)設(shè)備:僅僅針對設(shè)置了開發(fā)設(shè)備。
利用代碼:Bugly.setIsDevelopmentDevice(this, true);設(shè)置為開發(fā)者設(shè)備。
全量設(shè)備:針對所有的用戶。
自定義:可以設(shè)置下發(fā)范圍:隨機(jī)下發(fā)設(shè)置的版本數(shù)量,還可以設(shè)置android版本范圍,僅僅在這個范圍內(nèi)才會下發(fā)并且生效。
下發(fā)補(bǔ)丁之后:
里面包括了激活的用戶數(shù)量以及下發(fā)的數(shù)量,在操作過程中我們可能對于上個補(bǔ)丁不太滿意,我們需要發(fā)布一個新的補(bǔ)丁,bugly提供了2中操作。
停止下發(fā):點(diǎn)擊之后將不會在下發(fā)bugly補(bǔ)丁,但是之前已經(jīng)下載并且激活的不會刪除掉補(bǔ)丁。
撤回:點(diǎn)擊之后將停止下發(fā)補(bǔ)丁,并且之前已經(jīng)下載并且激活的用戶將會刪除掉補(bǔ)丁包,并且恢復(fù)到基準(zhǔn)包的版本。
檢查patch包是否生效:
基準(zhǔn)包執(zhí)行效果圖:
修復(fù)之后的效果圖:
不能立即生效,需要吧app至于后臺一段時間才能生效。
如果你的手機(jī)root的話,可以在data/data/app包名目錄下有一個tinker目錄,里面就有對于的patch補(bǔ)丁包下載在里面。
如果用戶以及補(bǔ)丁下載成功以及激活的都會有統(tǒng)計(jì)的。
熱更新加固:
之前的tinker只有1.7.5之前支持加固,tinker 1.7.8 可以通過 isProtectedApp 開啟加固支持,這種模式僅僅可以使用在加固應(yīng)用中。
isProtectedApp=true ?
加固廠商 ? ? ? ? ? ? ? ? ? ? ? ? 測試
騰訊云·樂固 ? ? ? ? ? ? ? ? ?Tested
愛加密 ? ? ? ? ? ? ? ? ? ? ? ? ? Tested
梆梆加固 ? ? ? ? ? ? ? ? ? ? ? ?Tested
360加固暫不支持,需要等待新版本發(fā)布
其他請自行測試,只要滿足下面規(guī)則的都可以支持
最后附上自己在github上面的BuglyDemo。