官方文檔
使用指南:https://bugly.qq.com/docs/user-guide/instruction-manual-android-hotfix/?v=20200312155538
使用詳解:https://bugly.qq.com/docs/user-guide/instruction-manual-android-hotfix-demo/?v=20200312155538
更新日志:https://bugly.qq.com/docs/release-notes/release-android-beta/?v=20200312155538
一、配置
第一步:添加插件依賴
工程根目錄下“build.gradle”文件中添加:
buildscript {
repositories {
jcenter()
}
dependencies {
// tinkersupport插件, 其中lastest.release指拉取最新版本,也可以指定明確版本號,例如1.0.4
classpath "com.tencent.bugly:tinker-support:1.2.0"
}
}
第二步:集成SDK
1、在app module的“build.gradle”文件中添加(示例配置):
android {
defaultConfig {
ndk {
//設置支持的SO庫架構
abiFilters 'armeabi' //, 'x86', 'armeabi-v7a', 'x86_64', 'arm64-v8a'
}
}
}
dependencies {
implementation "com.android.support:multidex:1.0.1" // 多dex配置
//注釋掉原有bugly的倉庫
//compile 'com.tencent.bugly:crashreport:latest.release'//其中latest.release指代最新版本號,也可以指定明確的版本號,例如1.3.4
implementation 'com.tencent.bugly:crashreport_upgrade:1.4.2'
// 指定tinker依賴版本(注:應用升級1.3.5版本起,不再內置tinker)
implementation 'com.tencent.tinker:tinker-android-lib:1.9.14'
implementation 'com.tencent.bugly:nativecrashreport:latest.release'//其中latest.release指代最新版本號,也可以指定明確的版本號,例如2.2.0
}
2、在app module的“build.gradle”文件中添加:
// 依賴插件腳本
apply from: 'tinker-support.gradle'
3、在app的文件目錄下新建一個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 = "1.0.1-base"
// 構建多渠道補丁時使用
// buildAllFlavorsDir = "${bakPath}/${baseApkDir}"
// 是否啟用加固模式,默認為false.(tinker-spport 1.0.7起支持)
// isProtectedApp = true
// 是否開啟反射Application模式
enableProxyApplication = false
// 是否支持新增非export的Activity(注意:設置為true才能修改AndroidManifest文件)
supportHotplugComponent = true
}
/**
* 一般來說,我們無需對下面的參數做任何的修改
* 對于各參數的詳細介紹請參考:
* 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
注意:在tinker-support文件中可以配置enableProxyApplication 的參數,enableProxyApplication 參數指是否開啟反射Application模式
方法一、enableProxyApplication = false 的情況(推薦)
這是Tinker推薦的接入方式,一定程度上會增加接入成本,但具有更好的兼容性。
1、自定義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繼承類當中
參數解析
參數2:delegateClassName Application代理類 這里填寫你自定義的ApplicationLike
2、我們需要您將以前的Applicaton配置為繼承TinkerApplication的類:
3、自定義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);
}
}
注意: Bugly.init(getApplication(), "900029763", false);需要填寫你自己在Bugly申請的id。
方法二、enableProxyApplication = true的情況
public class MyApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
// 這里實現SDK初始化,appId替換成你的在Bugly平臺申請的appId
// 調試時,將第三個參數改為true
Bugly.init(this, "6666666", false);
}
@Override
protected void attachBaseContext(Context base) {
super.attachBaseContext(base);
// you must install multiDex whatever tinker is installed!
MultiDex.install(base);
// 安裝tinker
Beta.installTinker();
}
}
第四步: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. 1配置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包中的,檢查你的工程是否引入該類庫。
3. 2在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>
第五步:混淆配置
-dontwarn com.tencent.bugly.**
-keep public class com.tencent.bugly.**{*;}
# tinker混淆規則
-dontwarn com.tencent.tinker.**
-keep class com.tencent.tinker.** { *; }
二、使用
app module的“build.gradle”文件中配置apk加密密鑰
android {
signingConfigs {
config {
keyAlias "*****"
keyPassword "*****"
storeFile file("F:/android/*****/*****.jks")
storePassword "*****"
}
}
buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
signingConfig signingConfigs.config
}
}
}
1、打基準包
1.1、登錄bugly首頁創建產品,并獲取App ID
首頁地址:https://bugly.qq.com/v2/index
1.1.1、產品列表
1.1.2、產品信息
1.1.3、修改id
在你的ApplicationLike或者Application下進行修改
Bugly.init(getApplication(), "900029763", false);
1.2、配置基準包的tinkerId
1.3、打基準包
1.3.1、使用Android studio右側的Gradle的assembleRelease進行編譯
注意:assembleRelease的位置因AS版本等原因而定,每個目錄翻一翻就行。
1.3.2、編譯結果:
1.4、上報基準包
直接啟動apk,就可以完成聯網上報給bugly后臺的過程
注意:如果看不到log,您需要將bugly初始化init的第三個參數設置為true才能看到。
2、修改基準包
修復基準包;或修改基準包的一些內容作為補丁識別內容。
3、打包補丁
3.1修改tinker-support.gradle下的基準版本的目錄和修改一個補丁版的tinkerId
注意:tinkerId是基準版和補丁公用的參數,可以自定義一些參數作為表示添加進去。
3.1使用Android studio右側tinker-support下的buildTinkerPatchRelease進行編譯
3.2、編譯結果:
其中的patch_signed_7zip.apk就是我們要的補丁文件
4、上報補丁到bugly
上傳補丁文件,并點擊下發。
5、應用修復(自動修復)
5.1、基準包應用接收到補丁信息
注意:如果看不到log,您需要將bugly初始化init的第三個參數設置為true才能看到。
5.2、應用后臺自行修復
5.3、重啟應用查看修復結果
注意:bugly方案是基于Tinker方案的實現,需要下次啟動才能讓補丁生效。