第一步:添加插件依賴
工程根目錄下“build.gradle”文件中添加:
buildscript {
repositories {
jcenter()
}
dependencies {
// tinkersupport插件, 其中lastest.release指拉取最新版本,也可以指定明確版本號,例如1.0.4
classpath "com.tencent.bugly:tinker-support:1.0.8"
}
}
第二步:集成SDK
gradle配置
在app module的“build.gradle”文件中添加(示例配置):
android {
defaultConfig {
ndk {
//設置支持的SO庫架構
abiFilters 'armeabi' //, 'x86', 'armeabi-v7a', 'x86_64', 'arm64-v8a'
}
}
}
dependencies {
compile "com.android.support:multidex:1.0.1" // 多dex配置
//註釋掉原有bugly的倉庫
//compile 'com.tencent.bugly:crashreport:latest.release'//其中latest.release指代最新版本號,也可以指定明確的版本號,例如2.3.2
compile 'com.tencent.bugly:crashreport_upgrade:1.3.1'
compile 'com.tencent.bugly:nativecrashreport:latest.release' //其中latest.release指代最新版本號,也可以指定明確的版本號,例如2.2.0
}
注意事項:
注意: 升級SDK已經集成crash上報功能,已經集成Bugly的用戶需要註釋掉原來Bugly的jcenter庫; 已經配置過符號表的Bugly用戶保留原有符號表配置; Bugly SDK(2.1.5及以上版本)已經將Java Crash和Native Crash捕獲功能分開,如果想使用NDK庫,需要配置: compile 'com.tencent.bugly:nativecrashreport:latest.release'
在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, 你無須關注tinkerId,默認爲false autoGenerateTinkerId = true
// tinkerId = "base-1.0.1" // 如果上面autoGenerateTinkerId 屬性設置爲true 則 tinkerid可以註銷掉
// 構建多渠道補丁時使用
// buildAllFlavorsDir = "${bakPath}/${baseApkDir}"
// 是否啓用加固模式,默認爲false.(tinker-spport 1.0.7起支持)
//如果需要加固 必須注意 打出來的插件包也要進行加固 簽名
// isProtectedApp = true
// 是否開啓反射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的分配
}
}
第三步:初始化SDK
分別介紹enableProxyApplication的兩種情況
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配置
在AndroidMainfest.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" />
2. Activity配置
<activity
android:name="com.tencent.bugly.beta.ui.BetaActivity"
android:configChanges="keyboardHidden|orientation|screenSize|locale"
android:theme="@android:style/Theme.Translucent" />
3. 配置FileProvider
注意:如果您想兼容Android N或者以上的設備,必須要在AndroidManifest.xml文件中配置FileProvider來訪問共享路徑的文件。
<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>
如果你使用的第三方庫也配置了同樣的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>
這裏要注意一下,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下載的文件可能存在的路徑,一定要按照上面格式配置,不然可能會出現錯誤。
注:1.3.1及以上版本,可以不用進行以上配置,aar已經在AndroidManifest配置了,並且包含了對應的資源文件。
第五步:混淆配置
爲了避免混淆SDK,在Proguard混淆文件中增加以下配置:
-dontwarn com.tencent.bugly.**
-keep public class com.tencent.bugly.**{*;}
如果你使用了support-v4包,你還需要配置以下混淆規則:
-keep class android.support.**{*;}
完整接入後的使用流程
- 打基準包安裝並上報聯網(注:填寫唯一的tinkerId)
- 對基準包的bug修復(可以是Java代碼變更,資源的變更)
- 修改基準包路徑、修改補丁包tinkerId、mapping文件路徑(如果開啓了混淆需要配置)、resId文件路徑
- 執行buildTinkerPatchRelease打Release版本補丁包
- 選擇app/build/outputs/patch目錄下的補丁包並上傳(注:不要選擇tinkerPatch目錄下的補丁包,不然上傳會有問題)
- 編輯下發補丁規則,點擊立即下發
- 殺死進程並重啓基準包,請求補丁策略(SDK會自動下載補丁併合成)
- 再次重啓基準包,檢驗補丁應用結果
- 查看頁面,查看激活數據的變化
普通打包
1、編譯基準包
配置基準包的tinkerId 如果設置了自動生成 此處可以不用配置
tinkerId最好是一個唯一標識,例如git版本號、versionName等等。 如果你要測試熱更新,你需要對基線版本進行聯網上報。
這裏強調一下,基線版本配置一個唯一的tinkerId,而這個基線版本能夠應用補丁的前提是集成過熱更新SDK,並啓動上報過聯網,這樣我們後臺會將這個tinkerId對應到一個目標版本,例如tinkerId = "bugly_1.0.0" 對應了一個目標版本是1.0.0,基於這個版本打的補丁包就能匹配到目標版本。
執行assembleRelease
編譯生成基準包:
此處有點坑 官方文檔未寫明是在什麼地方 實際上是在studio左右面的 gradle中
這個會在build/outputs/bakApk路徑下生成每次編譯的基準包、混淆配置文件、資源Id文件,如下圖所示:
實際應用中,請注意保存線上發佈版本的基準apk包、mapping文件、R.txt文件,如果線上版本有bug,就可以藉助我們tinker-support插件進行補丁包的生成。
啓動apk,上報聯網數據
我們每次冷啓動都會請求補丁策略,會上報當前版本號和tinkerId,這樣我們後臺就能將這個唯一的tinkerId對應到一個版本,大家測試的時候可以打開logcat查看我們的日誌,如下圖所示:
注意事項:
此處提示的啓動apk , 上報聯網數據 意思是說 要講基準包啓動並且聯網上傳tinkerid 否則控制檯無法找到基準包的版本
會報一下錯誤
當聯網運行一次基準包之後 在上傳 補丁包 即可上傳成功
如果看不到log,您需要將bugly初始化的第三個參數設置爲true才能看到。
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會自動幫你把補丁包下到本地。
5、測試補丁應用效果
啓動app應用patch
如果匹配到目標版本,後臺就會下發補丁策略,可以在logcat看到如下日誌:
下載成功之後,我們會立即去合成補丁,可以看到patch合成的日誌:
重啓app查看效果
注:我們方案是基於Tinker方案的實現,需要下次啓動才能讓補丁生效。
多渠道打包
Bugly支持兩種方式進行多渠道打包:
gradle配置productFlavors方式
多渠道打包工具打多渠道包方式(推薦)
方法1:gradle配置productFlavors方式
1. 配置productFlavors
2. 執行assembleRelease
生成基線apk
按照普通打包方式正常配置基線版本的tinkerId,然後執行assembleRelease生成不同渠道的apk,會在工程中build/bakApk/生成如下圖所示文件:
3. 打渠道補丁包配置
4.執行buildAllFlavorsTinkerPatchRelease
生成所有渠道補丁包
如下圖所示:
5.測試應用補丁包
與普通打包一致。
方法2:多渠道打包工具打多渠道包方式(推薦)
多渠道工具打包方式,參考這篇文章:Bugly多渠道熱更新解決方案
加固打包
需要集成升級SDK版本1.3.0以上版本才支持加固。
經過測試的加固產品:
騰訊樂固
愛加密
梆梆加固
360加固(SDK 1.3.1之後版本支持)
其他產品需要大家進行驗證。
1.設置isProtectedApp參數
在tinker-support配置當中設置isProtectedApp = true,表示你要打加固的的apk。 是否使用加固模式,僅僅將變更的類合成補丁。注意,這種模式僅僅可以用於加固應用中。
2.將基準包進行加固
如果你的app需要進行加固,你需要將你打出的基準包上傳到具體的加固平臺進行加固,例如樂固,加固完成之後需要對apk進行重簽名:
以上命令說明:
-verbose:指定生成詳細輸出
-keystore:指定證書存儲路徑
-signedjar:改選項的三個參數分別爲簽名後的apk包、未簽名的apk包、數字證書別名
示例:
如果你使用的加固產品提供了GUI的加固和簽名工具,可以通過工具來進行加固和簽名。
3.根據未加固的基準包生成補丁包
打patch包的操作跟普通打包方式一致。
注意:這裏指定的基線版本是未加固的版本。
4.測試驗證
測試驗證的版本是經過加固並且已經重簽名後的apk,安裝到測試設備並上報聯網,其他操作與普通打包無異。
安卓開發交流羣 : 595856941