微信热修复框架Tinker集成和使用，爬了不少坑后。带你成功跑通项目！

前言：在你上线项目的时候，出现一个小的代码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包以下：markdown

在Application注册下Tinker

这个TinkerApplicationLike只是Tinker框架内部用的，他注解方式会帮咱们生成@DefaultLifeCycle(application = "com.lihang.tinkerstu.MyApplication"的 application。这里是包名点类名。生成之后，在清单文件的name里必定要加上。app

@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地址