手把手教你使用騰訊的熱修復(fù)框架-Tinker

TinkerTest

演示如何使用騰訊的熱修復(fù)框架-Tinker

項(xiàng)目地址

Tinker熱更新演示（請(qǐng)star支持）

image

演示demo下載

演示apk下載

補(bǔ)丁包下載

Tinker簡(jiǎn)介

Tinker是微信官方的Android熱補(bǔ)丁解決方案，它支持動(dòng)態(tài)下發(fā)代碼、So庫以及資源，讓應(yīng)用能夠在不需要重新安裝的情況下實(shí)現(xiàn)更新。當(dāng)然，你也可以使用Tinker來更新你的插件。

相關(guān)鏈接

Tinker已知問題

由于原理與系統(tǒng)限制，Tinker有以下已知問題:

  • Tinker不支持修改AndroidManifest.xml，Tinker不支持新增四大組件(1.9.0支持新增非export的Activity)；
  • 由于Google Play的開發(fā)者條款限制，不建議在GP渠道動(dòng)態(tài)更新代碼；
  • 在Android N上，補(bǔ)丁對(duì)應(yīng)用啟動(dòng)時(shí)間有輕微的影響；
  • 不支持部分三星android-21機(jī)型，加載補(bǔ)丁時(shí)會(huì)主動(dòng)拋出"TinkerRuntimeException:checkDexInstall failed"；
  • 對(duì)于資源替換，不支持修改remoteView。例如transition動(dòng)畫，notification icon以及桌面圖標(biāo)。

官方說明請(qǐng)點(diǎn)擊查看.

Tinker接入

添加依賴

  1. 在Project的根目錄的build.gradle下添加tinkerpatch插件：

buildscript {
    ...
    dependencies {
        ...
        classpath "com.tinkerpatch.sdk:tinkerpatch-gradle-plugin:1.2.8"
    }
}
  1. 在module的build.gradle下增加Tinker的依賴。
dependencies {
    implementation 'com.android.support:multidex:1.0.3'
    //若使用annotation需要單獨(dú)引用,對(duì)于tinker的其他庫都無需再引用
    annotationProcessor 'com.tinkerpatch.tinker:tinker-android-anno:1.9.8'
    compileOnly 'com.tinkerpatch.tinker:tinker-android-anno:1.9.8'
    implementation 'com.tinkerpatch.sdk:tinkerpatch-android-sdk:1.2.8'
}
  1. 配置代碼混淆和打包配置。其中tinkerMultidexKeep.pro和proguardRules.pro可參考我的demo工程。
android {
    compileSdkVersion 27

    defaultConfig {
        applicationId "com.xuexiang.tinkertest"
        minSdkVersion 14
        targetSdkVersion 27
        versionCode 1
        versionName "1.0"

        multiDexEnabled true
        multiDexKeepProguard file("tinkerMultidexKeep.pro") //keep specific classes using proguard syntax

    }

    signingConfigs {
        release {
            //配置你的storekey
            storeFile file(app_release.storeFile)
            storePassword app_release.storePassword
            keyAlias app_release.keyAlias
            keyPassword app_release.keyPassword
        }
    }

    buildTypes {
        release {
            minifyEnabled true
            shrinkResources true
            signingConfig signingConfigs.release
            proguardFiles 'proguardRules.pro', getDefaultProguardFile('proguard-android.txt')
        }
        debug {
            debuggable true
            minifyEnabled false
        }
    }

    sourceSets {
        main {
            jniLibs.srcDirs = ['libs']
        }
    }
}
  1. 引用tinkerpatch.gradle執(zhí)行腳本.
apply from: 'tinkerpatch.gradle'
  1. 配置tinkerpatch.gradle執(zhí)行腳本.對(duì)于腳本的詳細(xì)說明請(qǐng)參考官方文檔。

這里我只想說幾個(gè)比較關(guān)鍵的配置：

  • bakPath: 這里存放的是每次我們打包生成的apk目錄，作為生成補(bǔ)丁包的參考包路徑。（一般配置了就不用動(dòng)了）

  • baseInfo: 這里設(shè)置的是，本次打補(bǔ)丁包參照的apk包所在文件夾路徑，也就是舊APK的目錄。（每次打補(bǔ)丁包的時(shí)候，都需要手動(dòng)去更新）

  • variantName: 設(shè)置打補(bǔ)丁包的類型是release還是debug。

  • AppKey: 這是從Tinker Platform上注冊(cè)獲得的應(yīng)用的appkey。

  • AppVersion: 這也是在Tinker Platform上，每次上傳補(bǔ)丁包時(shí)都需要填寫的應(yīng)用版本，并且必須是唯一的。

【注意】：AppKey和AppVersion都是用于Tinker Platform自定發(fā)布補(bǔ)丁包所需要的。如果你不使用Tinker Platform來管理你的熱更新的話，可以隨便設(shè)置。

以下是tinkerpatch.gradle的配置樣例：

apply plugin: 'tinkerpatch-support'

/**
 * TODO: 請(qǐng)按自己的需求修改為適應(yīng)自己工程的參數(shù)
 */
def bakPath = file("${buildDir}/bakApk/")
/** 每次在打補(bǔ)丁包的時(shí)候，需要更新這里的舊包的位置  **/
def baseInfo = "app-1.0.0-0810-17-28-31"
def variantName = "release"

def AppKey = "4c118de195c79b14"
def AppVersion = "1.0.0"

/**
 * 對(duì)于插件各參數(shù)的詳細(xì)解析請(qǐng)參考
 * http://tinkerpatch.com/Docs/SDK
 */
tinkerpatchSupport {

    /** 可以在debug的時(shí)候關(guān)閉 tinkerPatch **/
    /** 當(dāng)disable tinker的時(shí)候需要添加multiDexKeepProguard和proguardFiles,
        這些配置文件本身由tinkerPatch的插件自動(dòng)添加，當(dāng)你disable后需要手動(dòng)添加
        你可以copy本示例中的proguardRules.pro和tinkerMultidexKeep.pro,
        需要你手動(dòng)修改'tinker.sample.android.app'本示例的包名為你自己的包名, com.xxx前綴的包名不用修改
     **/
    tinkerEnable = true

    /** 是否使用一鍵接入功能  **/

    reflectApplication = true
    /**
     * 是否開啟加固模式，只能在APK將要進(jìn)行加固時(shí)使用，否則會(huì)patch失敗。
     * 如果只在某個(gè)渠道使用了加固，可使用多flavors配置
     **/
    protectedApp = false
    /**
     * 實(shí)驗(yàn)功能
     * 補(bǔ)丁是否支持新增 Activity (新增Activity的exported屬性必須為false)
     **/
    supportComponent = true

    /** 在tinkerpatch.com得到的appKey,改成你的應(yīng)用appKey **/

    appKey = "${AppKey}"

    /** 注意: 若發(fā)布新的全量包, appVersion一定要更新 **/
    appVersion = "${AppVersion}"

    autoBackupApkPath = "${bakPath}"

    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或者文件方式生成渠道信息（相關(guān)工具：walle 或者 packer-ng）
     **/
}

/**
 * 用于用戶在代碼中判斷tinkerPatch是否被使能
 */
android {
    defaultConfig {
        buildConfigField "boolean", "TINKER_ENABLE", "${tinkerpatchSupport.tinkerEnable}"
    }
}

/**
 * 一般來說,我們無需對(duì)下面的參數(shù)做任何的修改
 * 對(duì)于各參數(shù)的詳細(xì)介紹請(qǐng)參考:
 * 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
    }
}
  1. 最后就是配置Application了。因?yàn)槲以谏厦嬖O(shè)置reflectApplication = true使用了一鍵接入功能，所以就不需要進(jìn)行復(fù)雜的配置了，如下:
public class App extends Application {

    @Override
    public void onCreate() {
        super.onCreate();

        // 我們可以從這里獲得Tinker加載過程的信息
        ApplicationLike tinkerApplicationLike = TinkerPatchApplicationLike.getTinkerPatchApplicationLike();
        // 初始化TinkerPatch SDK, 更多配置可參照API章節(jié)中的,初始化SDK
        TinkerPatch.init(tinkerApplicationLike)
                .reflectPatchLibrary()
                .setPatchRollbackOnScreenOff(true)
                .setPatchRestartOnSrceenOff(true)
                .setPatchResultCallback(new ResultCallBack() {
                    @Override
                    public void onPatchResult(PatchResult patchResult) {
                        ToastUtils.toast("補(bǔ)丁修復(fù):" + (patchResult.isSuccess ? "成功" : "失敗"));
                    }
                })
                .setFetchPatchIntervalByHours(3);
        // 每隔3個(gè)小時(shí)(通過setFetchPatchIntervalByHours設(shè)置)去訪問后臺(tái)時(shí)候有更新,通過handler實(shí)現(xiàn)輪訓(xùn)的效果
        TinkerPatch.with().fetchPatchUpdateAndPollWithInterval();
    }

}

更多復(fù)雜的配置和高端自定義操作可參見官方文檔。

以上就完成了Tinker的接入工作。

如何使用Tinker進(jìn)行熱修復(fù)

  1. 先隨便在程序中寫一個(gè)bug，然后執(zhí)行./gradlew assembleRelease進(jìn)行打包。當(dāng)然你也可以直接在AS右側(cè)的Gradle中找到你的應(yīng)用，并在Tasks->build->assembleRelease找到assembleRelease的任務(wù)，雙擊執(zhí)行任務(wù)。
image

執(zhí)行完成后，你會(huì)在你模塊的build->bakApk下看到你打的apk包。

image

  1. 你將剛才生成apk的那個(gè)文件夾的名稱設(shè)置在之前說的tinkerpatch.gradle中的baseInfo。

  2. 將bug修復(fù)后，執(zhí)行./gradlew tinkerPatchRelease打補(bǔ)丁包。當(dāng)然你也可以直接在AS右側(cè)的Gradle中找到你的應(yīng)用，并在Tasks->tinker->tinkerPatchRelease找到tinkerPatchRelease的任務(wù)，雙擊執(zhí)行任務(wù)。

image

執(zhí)行完成后，你會(huì)在你模塊的build->outputs->apk->tinkerPatch->release下看到你需要的補(bǔ)丁包patch_signed_7zip.apk。

image
  1. 最后調(diào)用TinkerInstaller.onReceiveUpgradePatch(getApplicationContext(), path);, path傳入你補(bǔ)丁包的所在的路徑即可完成熱更新。

需要注意的是，執(zhí)行熱更新后，需要重啟程序才能生效！

聯(lián)系方式

image
最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

友情鏈接更多精彩內(nèi)容