微信熱修復框架Tinker集成和使用，爬了不少坑後。帶你成功跑通項目！

時間 2019-11-08

原文原文鏈接

前言：在你上線項目的時候，出現一個小的代碼bug，或者遇到節假日時須要有節假日活動，增長用戶體驗了。除了從新打包發佈以外，此時熱更新，熱修復技術應運而生。雖然google是嚴令禁用包括蘋果。可是在android方面卻風生水起。java

網上不少文章都寫的很是好，可是比較古老。你會發現，你項目根本生成不了補丁apk。這也是這篇文章踩過了不少坑之後，才決定寫。因此這篇文章不會介紹的很是細，直接上乾貨。建議先了解，推薦文章（這篇文章思路和步驟都是對的，以及對Tinker的介紹，惟一的缺點是生成不了補丁apk）：熱修復——Tinker的集成與使用android

先看看咱們的實現效果吧（我這裏沒有作任何操做，就是提早把補丁包放在sd卡里，而後在容許權限的時候讓Tinker去加載補丁包。重所周知，Tinker不是當即生效，要重進app才生效）

1、Tinker框架依賴

對於熱更新，熱修復技術。聽上去很是高大上，且看一些文字也很是高端，讓人觸不可及。本篇博客直接帶你使用，並跑通你的項目。（若是歷來沒了解過的能夠去了解下大體原理，類加載，dex,elemnt數組插入等概念）git

項目build.gradle添加github

dependencies {
        ...
        classpath "com.tencent.tinker:tinker-patch-gradle-plugin:1.9.14"
    }
複製代碼

app的build.gradle，這裏比較複雜了，並且Tinker須要用到multidex，咱們一步一步來，添加依賴：後端

...
    api("com.tencent.tinker:tinker-android-lib:1.9.14") { changing = true }
    // Maven local cannot handle transist dependencies.
    implementation("com.tencent.tinker:tinker-android-loader:1.9.14") { changing = true }
    annotationProcessor("com.tencent.tinker:tinker-android-anno:1.9.14") { changing = true }
    compileOnly("com.tencent.tinker:tinker-android-anno:1.9.14") { changing = true }
    implementation "com.android.support:multidex:1.0.1"
複製代碼

在android標籤上加上api

android {
    ...
    dexOptions {
        //支持大型項目
        jumboMode = true
    }
}
複製代碼

在defaultConfig標籤上加上數組

defaultConfig {
        ...
        multiDexEnabled true
    }
複製代碼

這些作完之後，把下面這一大串一大串拷貝到你app的build.gradle的最下方，請相信你的眼睛微信

def bakPath = file("${buildDir}/bakApk/")

/** * you can use assembleRelease to build you base apk * use tinkerPatchRelease -POLD_APK= -PAPPLY_MAPPING= -PAPPLY_RESOURCE= to build patch * add apk from the build/bakApk */
ext {
    // 是否使用Tinker(當你的項目處於開發調試階段時，能夠改成false)
    tinkerEnabled = true
    // 基礎包文件路徑（名字這裏寫死爲old-app.apk。用於比較新舊app以生成補丁包，不論是debug仍是release編譯）
    tinkerOldApkPath = "${bakPath}/old-app.apk"
    // 基礎包的mapping.txt文件路徑（用於輔助混淆補丁包的生成，通常在生成release版app時會使用到混淆，因此這個mapping.txt文件通常只是用於release安裝包補丁的生成）
    tinkerApplyMappingPath = "${bakPath}/old-app-mapping.txt"
    // 基礎包的R.txt文件路徑（若是你的安裝包中資源文件有改動，則須要使用該R.txt文件來輔助生成補丁包）
    tinkerApplyResourcePath = "${bakPath}/old-app-R.txt"
    //only use for build all flavor, if not, just ignore this field
    tinkerBuildFlavorDirectory = "${bakPath}/flavor"
}


def getOldApkPath() {
    return hasProperty("OLD_APK") ? OLD_APK : ext.tinkerOldApkPath
}

def getApplyMappingPath() {
    return hasProperty("APPLY_MAPPING") ? APPLY_MAPPING : ext.tinkerApplyMappingPath
}

def getApplyResourceMappingPath() {
    return hasProperty("APPLY_RESOURCE") ? APPLY_RESOURCE : ext.tinkerApplyResourcePath
}

def getTinkerIdValue() {
    return hasProperty("TINKER_ID") ? TINKER_ID : android.defaultConfig.versionName
}

def buildWithTinker() {
    return hasProperty("TINKER_ENABLE") ? Boolean.parseBoolean(TINKER_ENABLE) : ext.tinkerEnabled
}

def getTinkerBuildFlavorDirectory() {
    return ext.tinkerBuildFlavorDirectory
}

if (buildWithTinker()) {
    apply plugin: 'com.tencent.tinker.patch'

    tinkerPatch {
        /** * necessary，default 'null' * the old apk path, use to diff with the new apk to build * add apk from the build/bakApk */
        oldApk = getOldApkPath()
        /** * optional，default 'false' * there are some cases we may get some warnings * if ignoreWarning is true, we would just assert the patch process * case 1: minSdkVersion is below 14, but you are using dexMode with raw. * it must be crash when load. * case 2: newly added Android Component in AndroidManifest.xml, * it must be crash when load. * case 3: loader classes in dex.loader{} are not keep in the main dex, * it must be let tinker not work. * case 4: loader classes in dex.loader{} changes, * loader classes is ues to load patch dex. it is useless to change them. * it won't crash, but these changes can't effect. you may ignore it * case 5: resources.arsc has changed, but we don't use applyResourceMapping to build */
        ignoreWarning = false

        /** * optional，default 'true' * whether sign the patch file * if not, you must do yourself. otherwise it can't check success during the patch loading * we will use the sign config with your build type */
        useSign = true

        /** * optional，default 'true' * whether use tinker to build */
        tinkerEnable = buildWithTinker()

        /** * Warning, applyMapping will affect the normal android build! */
        buildConfig {
            /** * optional，default 'null' * if we use tinkerPatch to build the patch apk, you'd better to apply the old * apk mapping file if minifyEnabled is enable! * Warning: * you must be careful that it will affect the normal assemble build! */
            applyMapping = getApplyMappingPath()
            /** * optional，default 'null' * It is nice to keep the resource id from R.txt file to reduce java changes */
            applyResourceMapping = getApplyResourceMappingPath()

            /** * necessary，default 'null' * because we don't want to check the base apk with md5 in the runtime(it is slow) * tinkerId is use to identify the unique base apk when the patch is tried to apply. * we can use git rev, svn rev or simply versionCode. * we will gen the tinkerId in your manifest automatic */
            tinkerId = getTinkerIdValue()

            /** * if keepDexApply is true, class in which dex refer to the old apk. * open this can reduce the dex diff file size. */
            keepDexApply = false

            /** * optional, default 'false' * Whether tinker should treat the base apk as the one being protected by app * protection tools. * If this attribute is true, the generated patch package will contain a * dex including all changed classes instead of any dexdiff patch-info files. */
            isProtectedApp = false

            /** * optional, default 'false' * Whether tinker should support component hotplug (add new component dynamically). * If this attribute is true, the component added in new apk will be available after * patch is successfully loaded. Otherwise an error would be announced when generating patch * on compile-time. * * <b>Notice that currently this feature is incubating and only support NON-EXPORTED Activity</b> */
            supportHotplugComponent = false
        }

        dex {
            /** * optional，default 'jar' * only can be 'raw' or 'jar'. for raw, we would keep its original format * for jar, we would repack dexes with zip format. * if you want to support below 14, you must use jar * or you want to save rom or check quicker, you can use raw mode also */
            dexMode = "jar"

            /** * necessary，default '[]' * what dexes in apk are expected to deal with tinkerPatch * it support * or ? pattern. */
            pattern = ["classes*.dex",
                       "assets/secondary-dex-?.jar"]
            /** * necessary，default '[]' * Warning, it is very very important, loader classes can't change with patch. * thus, they will be removed from patch dexes. * you must put the following class into main dex. * Simply, you should add your own application {@code tinker.sample.android.SampleApplication} * own tinkerLoader, and the classes you use in them * */
// loader = [
// //use sample, let BaseBuildInfo unchangeable with tinker
// "tinker.sample.android.app.BaseBuildInfo"
// ]
        }

        lib {
            /** * optional，default '[]' * what library in apk are expected to deal with tinkerPatch * it support * or ? pattern. * for library in assets, we would just recover them in the patch directory * you can get them in TinkerLoadResult with Tinker */
            pattern = ["lib/*/*.so"]
        }

        res {
            /** * optional，default '[]' * what resource in apk are expected to deal with tinkerPatch * it support * or ? pattern. * you must include all your resources in apk here, * otherwise, they won't repack in the new apk resources. */
            pattern = ["res/*", "assets/*", "resources.arsc", "AndroidManifest.xml"]

            /** * optional，default '[]' * the resource file exclude patterns, ignore add, delete or modify resource change * it support * or ? pattern. * Warning, we can only use for files no relative with resources.arsc */
            ignoreChange = ["assets/sample_meta.txt"]

            /** * default 100kb * for modify resource, if it is larger than 'largeModSize' * we would like to use bsdiff algorithm to reduce patch file size */
            largeModSize = 100
        }

        packageConfig {
            /** * optional，default 'TINKER_ID, TINKER_ID_VALUE' 'NEW_TINKER_ID, NEW_TINKER_ID_VALUE' * package meta file gen. path is assets/package_meta.txt in patch file * you can use securityCheck.getPackageProperties() in your ownPackageCheck method * or TinkerLoadResult.getPackageConfigByName * we will get the TINKER_ID from the old apk manifest for you automatic, * other config files (such as patchMessage below)is not necessary */
            configField("patchMessage", "tinker is sample to use")
            /** * just a sample case, you can use such as sdkVersion, brand, channel... * you can parse it in the SamplePatchListener. * Then you can use patch conditional! */
            configField("platform", "all")
            /** * patch version via packageConfig */
            configField("patchVersion", "1.0")
        }
        //or you can add config filed outside, or get meta value from old apk
        //project.tinkerPatch.packageConfig.configField("test1", project.tinkerPatch.packageConfig.getMetaDataFromOldApk("Test"))
        //project.tinkerPatch.packageConfig.configField("test2", "sample")

        /** * if you don't use zipArtifact or path, we just use 7za to try */
        sevenZip {
            /** * optional，default '7za' * the 7zip artifact path, it will use the right 7za with your platform */
            zipArtifact = "com.tencent.mm:SevenZip:1.1.10"
            /** * optional，default '7za' * you can specify the 7za path yourself, it will overwrite the zipArtifact value */
// path = "/usr/local/bin/7za"
        }
    }

    List<String> flavors = new ArrayList<>();
    project.android.productFlavors.each { flavor ->
        flavors.add(flavor.name)
    }
    boolean hasFlavors = flavors.size() > 0
    def date = new Date().format("MMdd-HH-mm-ss")

    /** * bak apk and mapping */
    android.applicationVariants.all { variant ->
        /** * task type, you want to bak */
        def taskName = variant.name

        tasks.all {
            if ("assemble${taskName.capitalize()}".equalsIgnoreCase(it.name)) {

                it.doLast {
                    copy {
                        def fileNamePrefix = "${project.name}-${variant.baseName}"
                        def newFileNamePrefix = hasFlavors ? "${fileNamePrefix}" : "${fileNamePrefix}-${date}"

                        def destPath = hasFlavors ? file("${bakPath}/${project.name}-${date}/${variant.flavorName}") : bakPath if (variant.metaClass.hasProperty(variant, 'packageApplicationProvider')) {
                            def packageAndroidArtifact = variant.packageApplicationProvider.get()
                            if (packageAndroidArtifact != null) {
                                try {
                                    from new File(packageAndroidArtifact.outputDirectory.getAsFile().get(), variant.outputs.first().apkData.outputFileName) } catch (Exception e) {
                                    from new File(packageAndroidArtifact.outputDirectory, variant.outputs.first().apkData.outputFileName) } } else {
                                from variant.outputs.first().mainOutputFile.outputFile
                            }
                        } else {
                            from variant.outputs.first().outputFile
                        }

                        into destPath
                        rename { String fileName ->
                            fileName.replace("${fileNamePrefix}.apk", "${newFileNamePrefix}.apk")
                        }

                        from "${buildDir}/outputs/mapping/${variant.dirName}/mapping.txt"
                        into destPath
                        rename { String fileName ->
                            fileName.replace("mapping.txt", "${newFileNamePrefix}-mapping.txt")
                        }

                        from "${buildDir}/intermediates/symbols/${variant.dirName}/R.txt"
                        from "${buildDir}/intermediates/symbol_list/${variant.dirName}/R.txt"
                        from "${buildDir}/intermediates/runtime_symbol_list/${variant.dirName}/R.txt"
                        into destPath
                        rename { String fileName ->
                            fileName.replace("R.txt", "${newFileNamePrefix}-R.txt")
                        }
                    }
                }
            }
        }
    }
    project.afterEvaluate {
        //sample use for build all flavor for one time
        if (hasFlavors) {
            task(tinkerPatchAllFlavorRelease) {
                group = 'tinker'
                def originOldPath = getTinkerBuildFlavorDirectory()
                for (String flavor : flavors) {
                    def tinkerTask = tasks.getByName("tinkerPatch${flavor.capitalize()}Release")
                    dependsOn tinkerTask
                    def preAssembleTask = tasks.getByName("process${flavor.capitalize()}ReleaseManifest")
                    preAssembleTask.doFirst {
                        String flavorName = preAssembleTask.name.substring(7, 8).toLowerCase() + preAssembleTask.name.substring(8, preAssembleTask.name.length() - 15)
                        project.tinkerPatch.oldApk = "${originOldPath}/${flavorName}/${project.name}-${flavorName}-release.apk"
                        project.tinkerPatch.buildConfig.applyMapping = "${originOldPath}/${flavorName}/${project.name}-${flavorName}-release-mapping.txt"
                        project.tinkerPatch.buildConfig.applyResourceMapping = "${originOldPath}/${flavorName}/${project.name}-${flavorName}-release-R.txt"

                    }

                }
            }

            task(tinkerPatchAllFlavorDebug) {
                group = 'tinker'
                def originOldPath = getTinkerBuildFlavorDirectory()
                for (String flavor : flavors) {
                    def tinkerTask = tasks.getByName("tinkerPatch${flavor.capitalize()}Debug")
                    dependsOn tinkerTask
                    def preAssembleTask = tasks.getByName("process${flavor.capitalize()}DebugManifest")
                    preAssembleTask.doFirst {
                        String flavorName = preAssembleTask.name.substring(7, 8).toLowerCase() + preAssembleTask.name.substring(8, preAssembleTask.name.length() - 13)
                        project.tinkerPatch.oldApk = "${originOldPath}/${flavorName}/${project.name}-${flavorName}-debug.apk"
                        project.tinkerPatch.buildConfig.applyMapping = "${originOldPath}/${flavorName}/${project.name}-${flavorName}-debug-mapping.txt"
                        project.tinkerPatch.buildConfig.applyResourceMapping = "${originOldPath}/${flavorName}/${project.name}-${flavorName}-debug-R.txt"
                    }

                }
            }
        }
    }
}



task sortPublicTxt() {
    doLast {
        File originalFile = project.file("public.txt")
        File sortedFile = project.file("public_sort.txt")
        List<String> sortedLines = new ArrayList<>()
        originalFile.eachLine {
            sortedLines.add(it)
        }
        Collections.sort(sortedLines)
        sortedFile.delete()
        sortedLines.each {
            sortedFile.append("${it}\n")
        }
    }
}
複製代碼

2、初始化Tinker

首先打開個人項目，把tinker包拷貝到你項目裏。tinker包以下：app

在Application註冊下Tinker

這個TinkerApplicationLike只是Tinker框架內部用的，他註解方式會幫咱們生成@DefaultLifeCycle(application = "com.lihang.tinkerstu.MyApplication"的 application。這裏是包名點類名。生成之後，在清單文件的name裏必定要加上。框架

@SuppressWarnings("unused")
@DefaultLifeCycle(application = "com.lihang.tinkerstu.MyApplication",// application類名。只能用字符串，這個MyApplication文件是不存在的，但能夠在AndroidManifest.xml的application標籤上使用（name）
        flags = ShareConstants.TINKER_ENABLE_ALL,// tinkerFlags
        loaderClass = "com.tencent.tinker.loader.TinkerLoader",//loaderClassName, 咱們這裏使用默認便可!（可不寫）
        loadVerifyFlag = false)//tinkerLoadVerifyFlag
public class TinkerApplicationLike extends DefaultApplicationLike {
    private static final String TAG = "Tinker.SampleApplicationLike";

    public TinkerApplicationLike(Application application, int tinkerFlags, boolean tinkerLoadVerifyFlag, long applicationStartElapsedTime, long applicationStartMillisTime, Intent tinkerResultIntent) {
        super(application, tinkerFlags, tinkerLoadVerifyFlag, applicationStartElapsedTime, applicationStartMillisTime, tinkerResultIntent);
    }

    /** * install multiDex before install tinker * so we don't need to put the tinker lib classes in the main dex * * @param base */
    @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);

        SampleApplicationContext.application = getApplication();
        SampleApplicationContext.context = getApplication();
        TinkerManager.setTinkerApplicationLike(this);

        TinkerManager.initFastCrashProtect();
        //should set before tinker is installed
        TinkerManager.setUpgradeRetryEnable(true);

        //optional set logIml, or you can use default debug log
        TinkerInstaller.setLogIml(new MyLogImp());

        //installTinker after load multiDex
        //or you can put com.tencent.tinker.** to main dex
        TinkerManager.installTinker(this);
        Tinker tinker = Tinker.with(getApplication());
        // 能夠將以前自定義的Application中onCreate()方法所執行的操做搬到這裏...
    }

    @TargetApi(Build.VERSION_CODES.ICE_CREAM_SANDWICH)
    public void registerActivityLifecycleCallbacks(Application.ActivityLifecycleCallbacks callback) {
        getApplication().registerActivityLifecycleCallbacks(callback);
    }

}
複製代碼

清單文件裏application裏寫上咱們的application。註解生成的MyApplication,由於是註解生成，你不build下確定是報紅的，記得build
<application ... android:name="com.lihang.tinkerstu.MyApplication" > ... </application> 複製代碼

清單文件裏註冊下服務

其實這個服務能夠不要，他這裏坐的操做只是個回調，告訴你成功與失敗。我不在清單文件裏註冊頁照樣成功

<service android:name=".tinker.service.SampleResultService" android:permission="android.permission.BIND_JOB_SERVICE" android:exported="false"/> 複製代碼

3、測試，激動人心的時候。

咱們先模擬一個線上的apk，咱們打包下。彈出一個「我是小二郎」（這裏須要存儲和讀取權限，由於其實質是打包成補丁apk,放在你手機內存裏，而後Tinker去讀取，經過補丁apk知道要修改的類，而後插入到emlent數組裏，因爲類加的雙親機制，同一個類只會讀取一次，其實這個時候bug類還在apk內）。

首先是Activity裏的代碼：

public class MainActivity extends AppCompatActivity { private RxPermissions rxPermissions; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); // patch_signed_7zip.apk String path = "/sdcard/Tinker/"; File dir = new File(path); if (!dir.exists()) { dir.mkdirs(); } File file = new File(path, "patch_signed_7zip.apk"); if (file.exists()) { if (file.length() > 0) { TinkerInstaller.onReceiveUpgradePatch(MainActivity.this, file.getAbsolutePath()); } } findViewById(R.id.btn).setOnClickListener(new View.OnClickListener() { @Override public void onClick(View v) { Toast.makeText(MainActivity.this, "我是小二郎", Toast.LENGTH_SHORT).show(); } }); } } 複製代碼

3.一、模擬生成線上有bug的apk。

按下如，點擊 assembleDebug

等待一段時間後，點開你的項目，來到app\build\bakApk文件下以下；把app-debug-0911-18-32-21.apk的名稱改爲old-app.apk。這個old-app.apk。就是咱們的原app。裝到手機上，點擊按鈕就會彈出「我是小二郎」。

3.二、修改咱們的toast內容，把「我是小二郎」改爲「我是熱修復技術！！」。以後，如圖點擊 tinkerPatchDebug

等待一段時間後來到咱們的app\build\outputs\apk\tinkerPatch\debug。這裏有3個apk：

patch_signed.apk 簽名補丁包

patch_signed_7zip.apk 簽名並用7Z壓縮的補丁包

patch_unsigned.apk 未簽名的補丁包

這裏咱們用patch_signed_7zip.apk

四、模擬放置補丁包

在模擬放補丁包以前，咱們先看看Tinker是怎麼裝補丁和卸載補丁的

請求打補丁

TinkerInstaller.onReceiveUpgradePatch(context, 補丁包的本地路徑); 複製代碼
卸載補丁

Tinker.with(getApplicationContext()).cleanPatch();// 卸載全部的補丁 Tinker.with(getApplicationContext()).cleanPatchByVersion(版本號)// 卸載指定版本的補丁複製代碼

回到主題！還記得咱們的main裏的代碼嗎：
//這個是我爲放補丁包建立的文件夾 String path = "/sdcard/Tinker/"; File dir = new File(path); if (!dir.exists()) { dir.mkdirs(); } //patch_signed_7zip.apk爲咱們要打的補丁包 File file = new File(path, "patch_signed_7zip.apk"); if (file.exists()) { if (file.length() > 0) { Log.e("我就想看看路徑", file.getAbsolutePath()); TinkerInstaller.onReceiveUpgradePatch(MainActivity.this, file.getAbsolutePath()); } } 複製代碼

而後經過手機助手，或者別的途徑把咱們的patch_signed_7zip.apk拷貝到/sdcard/Tinker/文件夾裏如：

作完一上步驟，恭喜你，搞定了。！由於Tinker不是即時的。因此須要退出關閉apk，從新進。那麼再次點擊按鈕的時候會彈出「我是熱修復技術！！」

五、Bugly讓熱修復變得如此簡單

我這裏簡單說下個人理解把。這個補丁包你能夠經過大家後端去下載。可是確定要作好版本管理。不可能2.0的版本還去打1.0的補丁包。可是Tinker官方有個Bugly後臺，繼承進去之後，就至關於這一步，微信官方幫你作了。！！！

微信熱修復Tinker demo。30分鐘不到，帶你上路。github地址