官網文檔:http://tinkerpatch.com/Docs/SDK
官網demo:https://github.com/TinkerPatch/tinkerpatch-sample
本次使用demo:https://download.csdn.net/download/u010326875/12002859
按照官網文檔來配置tinker的使用
第一步、 添加 gradle 插件依賴:
第二步、 集成 TinkerPatch SDK:
第三步、 配置 tinkerpatchSupport 參數(tinkerpatch.gradle文件的內容):
第四步、 初始化 TinkerPatch SDK:
第五步、 編寫android頁面,操作觸發補丁包下發
第六步、 使用步驟
具體說明:
第一步、 添加 gradle 插件依賴:
buildscript {
repositories {
mavenCentral() //配置上這個,不然有可能會加載插件不成功
google()
jcenter()
}
dependencies {
// TinkerPatch 插件
classpath "com.tinkerpatch.sdk:tinkerpatch-gradle-plugin:1.2.14"
}
}
第二步、 集成 TinkerPatch SDK:
apply from: 'tinkerpatch.gradle' //爲了簡單方便,我們將 TinkerPatch 相關的配置都放於 tinkerpatch.gradle 中
dependencies {
// 若使用annotation需要單獨引用,對於tinker的其他庫都無需再引用
compileOnly("com.tinkerpatch.tinker:tinker-android-anno:1.9.14") { changing = true }
implementation("com.tinkerpatch.sdk:tinkerpatch-android-sdk:${TINKER_VERSION}")
implementation 'com.android.support:multidex:1.0.3'
}
TINKER_VERSION 在 gradle.properties 文件中聲明:TINKER_VERSION = 1.2.14
自行配置gradle的簽名信息等:
signingConfigs {
release {
try {
keyAlias 'bai'
keyPassword '123456'
storeFile file('E:/test/bai.jks')
storePassword '123456'
} catch (ex) {
throw new InvalidUserDataException(ex.toString())
}
}
debug {
storeFile file('E:/test/bai.jks')
keyAlias 'bai'
keyPassword '123456'
storePassword '123456'
}
}
buildTypes {
release {
minifyEnabled true
signingConfig signingConfigs.release
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
debug {
debuggable true
minifyEnabled false
signingConfig signingConfigs.debug
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
}
第三步、 配置 tinkerpatchSupport 參數(tinkerpatch.gradle文件的內容):
apply plugin: 'tinkerpatch-support'
/**
* TODO: 請按自己的需求修改爲適應自己工程的參數
*/
def bakPath = file("${buildDir}/bakApk/")
def baseInfo = "app-1.0.0-1112-12-49-34"
def variantName = "debug"
/**
* 對於插件各參數的詳細解析請參考
* http://tinkerpatch.com/Docs/SDK
*/
tinkerpatchSupport {
/** 可以在debug的時候關閉 tinkerPatch **/
/** 當disable tinker的時候需要添加multiDexKeepProguard和proguardFiles,
這些配置文件本身由tinkerPatch的插件自動添加,當你disable後需要手動添加
你可以copy本示例中的proguardRules.pro和tinkerMultidexKeep.pro,
需要你手動修改'tinker.sample.android.app'本示例的包名爲你自己的包名, com.xxx前綴的包名不用修改
**/
tinkerEnable = true
reflectApplication = true
/**
* 是否開啓加固模式,只能在APK將要進行加固時使用,否則會patch失敗。
* 如果只在某個渠道使用了加固,可使用多flavors配置
**/
protectedApp = false
/**
* 實驗功能
* 補丁是否支持新增 Activity (新增Activity的exported屬性必須爲false)
**/
supportComponent = true
autoBackupApkPath = "${bakPath}"
appKey = "22a3f0085f80f30b"
/** 注意: 若發佈新的全量包, appVersion一定要更新 **/
appVersion = "1.0.0"
def pathPrefix = "${bakPath}/${baseInfo}/${variantName}/"
def name = "${project.name}-${variantName}"
baseApkFile = "${pathPrefix}/${name}.apk"
baseProguardMappingFile = "${pathPrefix}/${name}-mapping.txt"
baseResourceRFile = "${pathPrefix}/${name}-R.txt"
/**
* 若有編譯多flavors需求, 可以參照: https://github.com/TinkerPatch/tinkerpatch-flavors-sample
* 注意: 除非你不同的flavor代碼是不一樣的,不然建議採用zip comment或者文件方式生成渠道信息(相關工具:walle 或者 packer-ng)
**/
}
/**
* 用於用戶在代碼中判斷tinkerPatch是否被使能
*/
android {
defaultConfig {
buildConfigField "boolean", "TINKER_ENABLE", "${tinkerpatchSupport.tinkerEnable}"
}
}
/**
* 一般來說,我們無需對下面的參數做任何的修改
* 對於各參數的詳細介紹請參考:
* https://github.com/Tencent/tinker/wiki/Tinker-%E6%8E%A5%E5%85%A5%E6%8C%87%E5%8D%97
*/
tinkerPatch {
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
}
}
第四步、 初始化 TinkerPatch SDK:
1. reflectApplication = true 的情況:
若我們使用 reflectApplication 模式,我們無需爲接入 Tinker 而改造我們的 Application 類。初始化 SDK 可參考 tinkerpatch-easy-sample 中的 SampleApplication 類.
public class SampleApplication extends Application {
...
@Override
public void onCreate() {
super.onCreate();
// 我們可以從這裏獲得Tinker加載過程的信息
tinkerApplicationLike = TinkerPatchApplicationLike.getTinkerPatchApplicationLike();
// 初始化TinkerPatch SDK, 更多配置可參照API章節中的,初始化SDK
TinkerPatch.init(tinkerApplicationLike)
.reflectPatchLibrary()
.setPatchRollbackOnScreenOff(true)
.setPatchRestartOnSrceenOff(true)
.setFetchPatchIntervalByHours(3);
// 每隔3個小時(通過setFetchPatchIntervalByHours設置)去訪問後臺時候有更新,通過handler實現輪訓的效果
TinkerPatch.with().fetchPatchUpdateAndPollWithInterval();
}
...
我們將 Tinker 加載補丁過程的結果存放在 TinkerPatchApplicationLike 中
2. reflectApplication = false 的情況 :
若我們已經完成了應用的 Application 改造,即將 Application 的邏輯移動到 ApplicationLike類中。我們可以參考 tinkerpatch-sample 中的 SampleApplicationLike 類.
public class SampleApplicationLike extends DefaultApplicationLike {
...
@Override
public void onCreate() {
super.onCreate();
// 初始化TinkerPatch SDK, 更多配置可參照API章節中的,初始化 SDK
TinkerPatch.init(this)
.reflectPatchLibrary()
.setPatchRollbackOnScreenOff(true)
.setPatchRestartOnSrceenOff(true)
.setFetchPatchIntervalByHours(3);
// 每隔3個小時(通過setFetchPatchIntervalByHours設置)去訪問後臺時候有更新,通過handler實現輪訓的效果
TinkerPatch.with().fetchPatchUpdateAndPollWithInterval();
}
...
}
注意:初始化的代碼建議緊跟 super.onCreate(),並且所有進程都需要初始化,已達到所有進程都可以被 patch 的目的
如果你確定只想在主進程中初始化 tinkerPatch,那也請至少在 :patch 進程中初始化,否則會有造成 :patch 進程crash,無法使補丁生效
使用reflectApplication = false 要自動生動生成application:
Tips:OnBaseContextAttached 和 OnCreate上下兩個方法裏的內容時重複的,用一個就行;自己的邏輯也一樣,放哪一個方法裏都可以!
第五步、編寫android頁面,或者方法,去觸發更新補丁包的操作:
第六步、 使用步驟
1、 運行 assembleRelease task 構建基準包(請在發佈前確保更新tinkerpatchSupport中的appVersion),
tinkerPatch會基於你填入的autoBackupApkPath自動備份基礎包信息到相應的文件夾,包含:apk文件、
R.txt文件和mapping.txt文件 (注:mapping.txt是proguard的產物,如果你沒有開啓proguard則不會有這個文件)
執行生成基礎包後的結果:
注意:測試機上要先安裝基準包,爲了測試
2 、若想發佈補丁包, 只需將自動保存下來的文件分別填到tinkerpatchSupport中的baseApkFile、baseProguardMappingFile 和baseResourceRFile 參數中;
//這裏配置對應的補丁包對應老的基礎包文件,我這裏爲了方便,把路徑和文件名稱改成了和基礎包相同的名字,用來測試。也可以自己指定文件路徑,然後對應的文件信息在 tinkerpatch.gradle中做好對應的匹配就行
def bakPath = file("${buildDir}/bakApk/")
def baseInfo = "app-1.0.0-1128-10-44-32"
def variantName = "release"
tinkerpatchSupport中的三個路徑配置:
3、運行 tinkerPatchRelease task 構建補丁包,補丁包將位於 build/outputs/tinkerPatch下
補丁包:patch_signed_7zip.apk
4、 在tinker官網平臺上,操作上傳發布補丁包:
tinker平臺代理管理:http://www.tinkerpatch.com/Apps/index
在自己的APP管理頁面,去添加要修復的版本號,然後上傳補丁包,確定無誤,對應發佈操作。
(上傳補丁包成功後,在基礎包的app 頁面,點擊文字去執行更新)
參考:https://blog.csdn.net/sw1995126/article/details/82683910
總結:第一次使用tinker有錯誤的地方請指出,謝謝! 其實官網已經寫得很詳細了,大家可以參考官網去操作,我這裏是爲了自己記錄一下,方便以後操作有個自己的思路。