上篇介紹了 Android 熱修復原理篇及幾大方案比較 介紹了熱修復功能和幾個比較火的庫,本篇介紹Bugly(目前採用微信Tinker的開源方案)的集成及使用方法.
bugly兼有異常採集上報,全量更新及熱更新功能,本文主要關注其熱更新模塊;話不多說兩橫一豎直接開幹.
首先註冊登錄bugly平臺賬號,然後就可以註冊新的app,填寫相應的信息,就可以得到相應的APP_ID。這點相信大家很有經驗,不用多說.
第一步:添加插件依賴
工程根目錄下“build.gradle”文件中添加:注意是根目錄下,即最外層的build.gradle下!
buildscript {
repositories {
jcenter()
}
dependencies {
// tinkersupport插件, 其中lastest.release指拉取最新版本,也可以指定明確版本號,例如1.0.4
classpath "com.tencent.bugly:tinker-support:latest.release"
}
}
注意:自tinkersupport 1.0.3版本起無需再配tinker插件的classpath。
第二步:集成SDK
gradle配置
在app module的“build.gradle”文件中添加(示例配置):
dependencies {
compile "com.android.support:multidex:1.0.1" // 多dex配置
compile 'com.tencent.bugly:crashreport_upgrade:latest.release' // 升級SDK
}
在app module的“build.gradle”文件中添加:
// 依賴插件腳本
apply from: 'tinker-support.gradle'
tinker-support.gradle內容如下所示(示例配置):
注:您需要在同級目錄下創建tinker-support.gradle這個文件哦。
apply plugin: 'com.tencent.bugly.tinker-support'
def bakPath = file("${buildDir}/bakApk/")
/**
* 此處填寫每次構建生成的基準包目錄
*/
def baseApkDir = "app-0208-15-10-00"
/**
* 對於插件各參數的詳細解析請參考
*/
tinkerSupport {
// 開啓tinker-support插件,默認值true
enable = true
// 指定歸檔目錄,默認值當前module的子目錄tinker
autoBackupApkDir = "${bakPath}"
// 是否啓用覆蓋tinkerPatch配置功能,默認值false
// 開啓後tinkerPatch配置不生效,即無需添加tinkerPatch
overrideTinkerPatchConfiguration = true
// 編譯補丁包時,必需指定基線版本的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.1"
// 構建多渠道補丁時使用
// buildAllFlavorsDir = "${bakPath}/${baseApkDir}"
// 是否開啓反射Application模式
enableProxyApplication = false
}
/**
* 一般來說,我們無需對下面的參數做任何的修改
* 對於各參數的詳細介紹請參考:
* 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" // 可選,設置mapping文件,建議保持舊apk的proguard混淆方式
//applyResourceMapping = "${bakPath}/${appName}/app-release-R.txt" // 可選,設置R.txt文件,通過舊apk文件保持ResId的分配
}
}
更詳細的配置項參考tinker-support配置說明
第三步:初始化SDK
enableProxyApplication = false 的情況
這是Tinker推薦的接入方式,一定程度上會增加接入成本,但具有更好的兼容性。
集成Bugly升級SDK之後,我們需要按照以下方式自定義ApplicationLike來實現Application的代碼(以下是示例):
自定義Application
public class SampleApplication extends TinkerApplication {
public SampleApplication() {
super(ShareConstants.TINKER_ENABLE_ALL, "xxx.xxx.SampleApplicationLike",
"com.tencent.tinker.loader.TinkerLoader", false);
}
}
注意:這個類集成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
我們需要您將以前的Applicaton配置爲繼承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();
// 這裏實現SDK初始化,appId替換成你的在Bugly平臺申請的appId
// 調試時,將第三個參數改爲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中進行配置
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配置
1. 權限配置
<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"/>
注意:如果你也想使用升級功能,你必須要進行2、3項的配置,而如果你只想使用熱更新能力,你只需要配置權限即可。
2. Activity配置
<activity
android:name="com.tencent.bugly.beta.ui.BetaActivity"
android:theme="@android:style/Theme.Translucent" />
3. 配置FileProvider
注意:如果您想兼容Android N或者以上的設備,必須要在AndroidManifest.xml文件中配置FileProvider來訪問共享路徑的文件。如果你使用的第三方庫也配置了同樣的FileProvider,你需要將第三方庫配置的路徑copy到我們配置的provider_path文件下。
<provider
android:name="android.support.v4.content.FileProvider"
android:authorities="${applicationId}.fileProvider"
android:exported="false"
android:grantUriPermissions="true">
<meta-data
android:name="android.support.FILE_PROVIDER_PATHS"
android:resource="@xml/provider_paths"/>
</provider>
${applicationId}請替換爲您的包名,例如com.bugly.upgrade.demo。這裏要注意一下,FileProvider類是在support-v4包中的,檢查你的工程是否引入該類庫。
在res目錄新建xml文件夾,創建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下載的文件可能存在的路徑,一定要按照上面格式配置,不然可能會出現錯誤。
第五步:混淆配置
爲了避免混淆SDK,在Proguard混淆文件中增加以下配置:
-dontwarn com.tencent.bugly.**
-keep public class com.tencent.bugly.**{*;}
如果你使用了support-v4包,你還需要配置以下混淆規則:
-keep class android.support.**{*;}
查看Bugly的Logcat日誌
開啓Bugly的Logcat日誌需要在初始化時,isDebug參數設爲true。
TAG爲CrashReportInfo,是Bugly主要操作日誌,包括初始化、日誌上報信息;
TAG爲CrashReport,是Bugly調試日誌,若Bugly使用中有問題,可以將該日誌信息反饋給客服人員。
到此bugly熱更新配置已完成,下面來進行具體用法
完整接入流程
- 打基準包安裝並上報聯網(注:填寫唯一的tinkerId)
- 對基準包的bug修復(可以是Java代碼變更,資源的變更)
- 修改基準包路徑、填寫補丁包tinkerId、mapping文件路徑、resId文件路徑
- 執行tinkerPatchRelease打Release版本補丁包
- 選擇app/build/outputs/patch目錄下的補丁包並上傳(注:不要選擇tinkerPatch目錄下的補丁包,不然上傳會有問題)
- 編輯下發補丁規則,點擊立即下發
- 重啓基準包,請求補丁策略(SDK會自動下載補丁併合成)
- 再次重啓基準包,檢驗補丁應用結果
- 查看頁面,查看激活數據的變化
普通打包
1、編譯基準包
配置基準包的tinkerId
tinkerId最好是一個唯一標識,例如git版本號、versionName等等。 如果你要測試熱更新,你需要對基線版本進行聯網上報。
這裏強調一下,基線版本配置一個唯一的tinkerId,而這個基線版本能夠應用補丁的前提是集成過熱更新SDK,並啓動上報過聯網,這樣我們後臺會將這個tinkerId對應到一個目標版本,例如tinkerId = "bugly_1.0.0" 對應了一個目標版本是1.0.0,基於這個版本打的補丁包就能匹配到目標版本。
執行assembleRelease
編譯生成基準包:
這個會在build/outputs/bakApk路徑下生成每次編譯的基準包、混淆配置文件、資源Id文件,如下圖所示:
實際應用中,請注意保存線上發佈版本的基準apk包、mapping文件、R.txt文件,如果線上版本有bug,就可以藉助我們tinker-support插件進行補丁包的生成。
啓動apk,上報聯網數據
我們每次冷啓動都會請求補丁策略,會上報當前版本號和tinkerId,這樣我們後臺就能將這個唯一的tinkerId對應到一個版本,大家測試的時候可以打開logcat查看我們的日誌,如下圖所示:
2、對基線版本的bug修復
未修復前
這個類有一個會造成空指針的方法。
修復後
對產生bug的類進行修復,作爲補丁下次覆蓋基線版本的類。
3、根據基線版本生成補丁包
修改待修復apk路徑、mapping文件路徑、resId文件路徑
執行構建補丁包的task
如果你要生成不同編譯環境的補丁包,只需要執行TinkerSupport插件生成的task,比如buildTinkerPatchRelease
就能生成release編譯環境的補丁包。 注:TinkerSupport插件版本低於1.0.4的,需要使用tinkerPatchRelease來生成補丁包 。
生成的補丁包在build/outputs/patch目錄下:
大家這裏可能會有一個疑問,補丁版本是怎麼匹配到目標版本的,可以雙擊patch包,我們提供的插件會在tinker生成的patch包基礎上插入一個MF文件:
4、上傳補丁包到平臺
上傳補丁包到平臺並下發編輯規則
點擊發佈新補丁
,上傳前面生成的patch包,我們平臺會自動爲你匹配到目標版本,你可以選擇下發範圍(開發設備、全量設備、自定義),填寫完備註之後,點擊立即下發讓補丁生效,這樣你就可以在客戶端當中收到我們的策略,SDK會自動幫你把補丁包下到本地。
如何定義開發設備:接口Bugly.setIsDevelopmentDevice(getApplicationContext(),
true);
,後臺就會將你當前設備識別爲開發設備,如果設置爲false則非開發設備,會根據這個配置進行策略控制。
5、測試補丁應用效果
啓動app應用patch
如果匹配到目標版本,後臺就會下發補丁策略,可以在logcat看到如下日誌:(以CrashReport,info級別過濾)
下載成功之後,我們會立即去合成補丁,可以看到patch合成的日誌:
重啓app查看效果
注:我們方案是基於Tinker方案的實現,需要下次啓動才能讓補丁生效。
每次發版都要保留基準包、混淆配置文件、資源Id文件
tinker的一般模式需要Dex的合成,它並不支持加固,一定要使用加固的app可以使用usePreGeneratedPatchDex模式。由於加固會改變apk的dex結構,所以生成補丁包時我們務必要使用加固前的apk。 但是需要注意的是,某些加固工具會將非exported的四大組件的類名替換,對於這部分類即使使用usePreGeneratedPatchDex也無法修改。對於360加固,MainActivity由於被提前加載,也無法修復。大家對於加固的情況,請仔細測試,能否支持與加固的方式有關聯。
注:熱修補技術本待完善中,在實際工程可能會有額外問題出現,比如支持四大組件的代理;直接解壓沒有修改的Dex時,需要計算是否會被Android N的內聯規則可能影響等.請儘量規避這些方面再使用.
附加:若有多渠道打包或者加固打包需求參考如下,普通打包不必參考:多渠道打包tinker是支持我們打多渠道的,建議大家按照以下步驟進行最佳實踐: 1. 配置productFlavors
2. 執行
|