熱修復(fù)說白了就是”及時無感打補(bǔ)丁”,比如公司上線一個app彼妻,用戶反應(yīng)有重大bug,需要緊急修復(fù)侨歉。
2015年以來幽邓,Android開發(fā)領(lǐng)域里對熱修復(fù)技術(shù)的討論和分享越來越多牵舵,同時也出現(xiàn)了一些不同的解決方案.如果按照通常做法,那就是程序猿加班搞定bug,然后測試,重新打包并發(fā)布畸颅。這樣帶來的問題就是成本高,效率低妒峦。于是,熱修復(fù)就應(yīng)運(yùn)而生.一般通過事先設(shè)定的接口從網(wǎng)上下載無Bug的代碼來替換有Bug的代碼窥浪。這樣就省事多了,用 戶體驗(yàn)也好漾脂。目前熱修復(fù)盡管有很多坑骨稿,做了好多工作,可能吃力不討好形耗,各種適配可能還是沒修復(fù)線上的有些Bug激涤。
熱修復(fù)技術(shù)倦踢,可以看做是Android平臺發(fā)展成熟至一定階段的必然產(chǎn)物。它是一種維護(hù)流量边涕、對用戶打攪極小的技術(shù)應(yīng)用功蜓,其出現(xiàn)的邏輯無一不蘊(yùn)含了一個事實(shí):無線應(yīng)用已發(fā)展到一個新階段霞赫,即如何更好維護(hù)昂貴的流量端衰。
熱更新能力是Bugly為解決開發(fā)者緊急修復(fù)線上bug,而無需重新發(fā)版抵代,讓用戶無感知就能把問題修復(fù)的一項(xiàng)能力荤牍。Bugly目前采用微信Tinker的開源方案,開發(fā)者只需要集成我們提供的SDK就可以實(shí)現(xiàn)自動下載補(bǔ)丁包劈榨、合成同辣、并應(yīng)用補(bǔ)丁的功能旱函,我們也提供了熱更新管理后臺讓開發(fā)者對每個版本補(bǔ)丁進(jìn)行管理。
而在Android平臺上靶衍,業(yè)界除阿里系之外颅眶,比較著名的熱修復(fù)還有:騰訊QQ 空間的超級補(bǔ)丁技術(shù)涛酗、 微信的Tinkr、 餓了么的Amigo偷厦、美團(tuán)的Robust等等商叹。不 過他們各自高自身的局限性, 或者不夠穩(wěn)定只泼, 或者補(bǔ)丁過大剖笙, 或者效率低下, 或者使 用起來迫于繁瑣请唱,大部分技術(shù)上看起來似乎可行,但實(shí)際體驗(yàn)并不好十绑。
第一步:添加插件依賴
導(dǎo)入bugly jar包 聚至, build.gradle(Project)文件下面添加
buildscript {
repositories {
jcenter()
}
dependencies {
classpath 'com.android.tools.build:gradle:2.3.2'
// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
classpath "com.tencent.bugly:tinker-support:latest.release"
}
}
第二步:集成SDK
gradle配置
在app module的“build.gradle”文件中添加:
android {
defaultConfig {
ndk {
//設(shè)置支持的SO庫架構(gòu)
abiFilters 'armeabi' //, 'x86', 'armeabi-v7a', 'x86_64', 'arm64-v8a'
}
}
}
dependencies {
// 本地集成aar方式
// compile fileTree(dir: 'libs', include: ['**.*'])
// compile(name: 'bugly_crashreport_upgrade-1.3.0', ext: 'aar')
// 多dex配置//注釋掉原有bugly的倉庫 必須依賴multidex才可以使用
// MultiDex.install(base);
compile 'com.android.support:multidex:1.0.1'
// 多dex配置
//注釋掉原有bugly的倉庫
// compile 'com.tencent.bugly:crashreport:latest.release'//其中l(wèi)atest.release指代最新版本號,也可以指定明確的版本號本橙,例如2.3.2
compile 'com.tencent.bugly:crashreport_upgrade:latest.release'
//其中l(wèi)atest.release指代最新版本號扳躬,也可以指定明確的版本號,例如1.2.0
compile 'com.tencent.bugly:nativecrashreport:latest.release'
//其中l(wèi)atest.release指代最新版本號,也可以指定明確的版本號贷币,例如2.2.0
}
在app module的“build.gradle”文件中添加:
// 依賴插件腳本
apply from: 'tinker-support.gradle'
tinker-support.gradle內(nèi)容如下所示:
apply plugin: 'com.tencent.bugly.tinker-support'
def bakPath = file("${buildDir}/bakApk/")
/**
* 此處填寫每次構(gòu)建生成的基準(zhǔn)包目錄
*/
def baseApkDir = "app-0208-15-10-00"
/**
* 對于插件各參數(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.1"
// 構(gòu)建多渠道補(bǔ)丁時使用
// buildAllFlavorsDir = "${bakPath}/${baseApkDir}"
// 是否啟用加固模式嘲叔,默認(rèn)為false.(tinker-spport 1.0.7起支持)
// isProtectedApp = true
// 是否開啟反射Application模式
enableProxyApplication = false
}
/**
* 一般來說,我們無需對下面的參數(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}/${appName}/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的分配
}
}
更詳細(xì)的配置項(xiàng)參考tinker-support配置說明
第三步:初始化SDK
enableProxyApplication = false 的情況
這是Tinker推薦的接入方式,一定程度上會增加接入成本丁逝,但具有更好的兼容性汁胆。
集成Bugly升級SDK之后,我們需要按照以下方式自定義ApplicationLike來實(shí)現(xiàn)Application的代碼(以下是示例):
自定義MyApplication
public class MyApplication extends TinkerApplication implements
Enviroment.EnviromentCallback, ActivityLifecycleCallbacks{
public MyApplication() {
super(ShareConstants.TINKER_ENABLE_ALL, "cn.eagleview.glasssync.global.MyApplicationLike",
"com.tencent.tinker.loader.TinkerLoader", false);
}
注意:這個類集成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
我們需要您將以前的MyApplicaton配置為繼承TinkerApplication的類:
自定義ApplicationLike
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();
// 這里實(shí)現(xiàn)SDK初始化琢感,appId替換成你的在Bugly平臺申請的appId
// 調(diào)試時丢间,將第三個參數(shù)改為true
Bugly.init(getApplication(), "900029763", false);
}
@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);
// 安裝tinker
// TinkerManager.installTinker(this); 替換成下面Bugly提供的方法
Beta.installTinker(this);
}
@TargetApi(Build.VERSION_CODES.ICE_CREAM_SANDWICH)
public void registerActivityLifecycleCallback(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 void onCreate() {
super.onCreate();
// 這里實(shí)現(xiàn)SDK初始化柬甥,appId替換成你的在Bugly平臺申請的appId
// 調(diào)試時墙牌,將第三個參數(shù)改為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();
}
}
接入非常的簡單,有興趣可以自己參考 Bugly熱更新文檔
第四步:AndroidManifest.xml配置
在AndroidMainfest.xml中進(jìn)行以下配置:
- 權(quán)限配置
<!--Bugly升級SDK權(quán)限配置開始-->
<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" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<!--Bugly升級SDK權(quán)限配置結(jié)束-->
2.配置Activity和FileProvider
注意:如果您想兼容Android N或者以上的設(shè)備暗甥,必須要在AndroidManifest.xml文件中配置FileProvider來訪問共享路徑的文件。
<!--配置升級的能力-->
<!-- Bugly升級SDK配置開始 -->
<activity
android:name="com.tencent.bugly.beta.ui.BetaActivity"
android:theme="@android:style/Theme.Translucent"/>
<!-- com.tencent.bugly.hotfix.easy.fileProvider -->
<!-- android:authorities="${applicationId}.fileProvider" -->
<provider
android:name="android.support.v4.content.FileProvider"
android:authorities="cn.eagleview.glasssync.hotfix.easy.fileProvider"
android:exported="false"
android:grantUriPermissions="true">
<meta-data
android:name="android.support.FILE_PROVIDER_PATHS"
android:resource="@xml/provider_paths"/>
</provider>
<!-- Bugly升級SDK配置結(jié)束-->
<!--配置升級的能力-->
如果你使用的第三方庫也配置了同樣的FileProvider, 可以通過繼承FileProvider類來解決合并沖突的問題捉捅,示例如下:
<provider
android:name=".utils.BuglyFileProvider"
android:authorities="${applicationId}.fileProvider"
android:exported="false"
android:grantUriPermissions="true"
tools:replace="name,authorities,exported,grantUriPermissions">
<meta-data
android:name="android.support.FILE_PROVIDER_PATHS"
android:resource="@xml/provider_paths"
tools:replace="name,resource"/>
</provider>
這里要注意一下撤防,F(xiàn)ileProvider類是在support-v4包中的,檢查你的工程是否引入該類庫棒口。
在res目錄新建xml文件夾寄月,創(chuàng)建provider_paths.xml文件如下:
<?xml version="1.0" encoding="utf-8"?>
<paths xmlns:android="http://schemas.android.com/apk/res/android">
<!-- /storage/emulated/0/Download/${applicationId}/.beta/apk-->
<external-path name="beta_external_path" path="Download/"/>
<!--/storage/emulated/0/Android/data/${applicationId}/files/apk/-->
<external-path name="beta_external_files_path" path="Android/data/"/>
</paths>
這里配置的兩個外部存儲路徑是升級SDK下載的文件可能存在的路徑辜膝,一定要按照上面格式配置,不然可能會出現(xiàn)錯誤漾肮。
注:1.3.1及以上版本厂抖,可以不用進(jìn)行以上配置,aar已經(jīng)在AndroidManifest配置了克懊,并且包含了對應(yīng)的資源文件忱辅。
第五步:混淆配置
為了避免混淆SDK,在Proguard混淆文件中增加以下配置:
-dontwarn com.tencent.bugly.**
-keep public class com.tencent.bugly.**{*;}
如果你使用了support-v4包谭溉,你還需要配置以下混淆規(guī)則:
-keep class android.support.**{*;}
注意:如果使用了第三方的jar包如果混淆出錯墙懂,在里面添加避免混淆即可
第六步:配置簽名文件keystore
// 簽名配置
signingConfigs {
release {
try {
storeFile file("./keystore/release.keystore")
storePassword "testres"
keyAlias "testres"
keyPassword "testres"
} catch (ex) {
throw new InvalidUserDataException(ex.toString())
}
}
debug {
storeFile file("./keystore/debug.keystore")
}
}
//構(gòu)建類型,簽名需要配置signingConfig
buildTypes {
release {
zipAlignEnabled true
minifyEnabled true //是否開啟混淆
shrinkResources true //移除無用的資源文件
signingConfig signingConfigs.release
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
debug{
debuggable true
minifyEnabled false
signingConfig signingConfigs.debug
}
}
溫馨提示 需要引入:
第七步:打基準(zhǔn)包和補(bǔ)丁包
打基準(zhǔn)包需要注意的是
// 構(gòu)建基準(zhǔn)包和補(bǔ)丁包都要指定不同的tinkerId扮念,并且必須保證唯一性
tinkerId = "base-1.0.1"
打補(bǔ)丁包需要注意的是
/**
* 此處填寫每次構(gòu)建生成的基準(zhǔn)包目錄
*/
def baseApkDir = "app-0612-12-23-05"
·
·
·
// 構(gòu)建基準(zhǔn)包和補(bǔ)丁包都要指定不同的tinkerId损搬,并且必須保證唯一性
tinkerId = "patch-1.0.1"
對應(yīng)生成的文件如下圖所示:
注意:
上傳補(bǔ)丁時,必須先連網(wǎng)運(yùn)行一次基準(zhǔn)包柜与,否則上傳補(bǔ)丁時會找不到版本巧勤。。
上傳的補(bǔ)丁必須是patch_signew_7zip.apk文件弄匕,不能是另外兩個颅悉。。
第八步:上傳補(bǔ)丁包
大家這里可能會有一個疑問粘茄,補(bǔ)丁版本是怎么匹配到目標(biāo)版本的签舞,可以雙擊patch包,我們提供的插件會在tinker生成的patch包基礎(chǔ)上插入一個MF文件:
點(diǎn)擊發(fā)布新補(bǔ)丁柒瓣,上傳前面生成的patch包儒搭,Bugly平臺會自動為你匹配到目標(biāo)版本,你可以選擇下發(fā)范圍(開發(fā)設(shè)備搂鲫、全量設(shè)備磺平、自定義),填寫完備注之后拣挪,點(diǎn)擊立即下發(fā)讓補(bǔ)丁生效擦酌,這樣你就可以在客戶端當(dāng)中收到我們的策略,SDK會自動幫你把補(bǔ)丁包下到本地赊舶。
提醒:自定義只允許輸入 > 、> =笼平、=园骆、< 、< = 及數(shù)字寓调、小數(shù)點(diǎn)锌唾、分號(;) 比如只允許下發(fā)系統(tǒng)版本大于等于5.0設(shè)備和小于等于7.0設(shè)備 :>= 5.0;<=7.0
最終如果運(yùn)行我們帶有Bug的App,并且匹配到目標(biāo)版本以后晌涕,后臺就會下發(fā)補(bǔ)丁策略秋麸,可以在logcat看到日志:
下載成功之后,會立即去合成補(bǔ)丁驯耻,可以看到patch合成的日志:
注:Bugly熱修復(fù)方案是基于Tinker方案實(shí)現(xiàn)的炒考,必須重啟我們的App,補(bǔ)丁才會生效帘靡。瓤帚。
使用范例:
大家如果想測試驗(yàn)證熱更新能力,請仔細(xì)查看以下文檔:
熱更新使用范例
常見問題:
大家如果在使用我們Bugly熱更新遇到問題轩勘,請先查看FAQ:
熱更新常見問題
附件 :阿里熱修復(fù) 直接參考阿里官網(wǎng)
Tinker熱修復(fù) 可參考鴻洋_的Android 熱修復(fù) Tinker接入及源碼淺析
Amigo熱修復(fù) 有興趣可參考Amigo 源碼解讀
參考文檔的版權(quán)歸原作者所有绊寻,本人是項(xiàng)目開發(fā)的筆記整理悬秉,借鑒之處還望各位大神見諒......