微信热修复框架Tinker集成

什么是Tinker

Tinker 是一个开源项目(Github：https://github.com/Tencent/tinker )，它是微信官方的 Android 热补丁解决方案，它支持动态下发代码、So 库以及资源，让应用能够在不需要重新安装的情况下实现更新。当然，也可以使用Tinker来更新你的插件。

为什么使用 Tinker

当前市面的热补丁方案有很多，其中比较出名的有阿里的AndFix、美团的Robust以及QZone的超级补丁方案。但它们都存在无法解决的问题，这也正是推出Tinker的原因。

总的来说:

• AndFix作为native解决方案，首先面临的是稳定性与兼容性问题，更重要的是它无法实现类替换，它是需要大量额外的开发成本
• Robust兼容性与成功率较高，但是它与AndFix一样，无法新增变量与类只能用做的bugFix方案
• Qzone方案可以做到发布产品功能，但是它主要问题是插桩带来Dalvik的性能问题，以及为了解决Art下内存地址问题而导致补丁包急速增大

特别是在Android N之后，由于混合编译的inline策略修改，对于市面上的各种方案都不太容易解决。而Tinker热补丁方案不仅支持类、So以及资源的替换，它还是2.X－8.X(1.9.0以上支持8.X)的全平台支持。利用Tinker我们不仅可以用做bugfix，甚至可以替代功能的发布。Tinker已运行在微信的数亿Android设备上。

什么是 TinkerPatch 平台

平台功能：帮助监听补丁的下发，合成等情况，不用每次在把生成的补丁包放在根目录
平台使用：http://tinkerpatch.com/Docs/start

Tinker需要使用者有一个后台可以下发和管理补丁包，并且需要处理传输安全等部署工作，TinkerPatch平台帮你做了这些工作，提供了补丁后台托管，版本管理，保证传输安全等功能，让开发者无需搭建一个后台，无需关心部署操作，只需引入一个SDK即可立即使用Tinker。

此外，通过深入研究Tinker源码，TinkerTinkerPatch平台在Tinker的基础上加入了以下特性：

（1）一键傻瓜式接入：无需理解复杂的热修复原理，一行代码即可接入热修复。实现了自动反射Appliction与Library，使用者无需对自己的项目做任何的改动
（2）补丁管理：实现了热补丁的版本管理，补丁的自动重试与异常时自动回退等功能。同时我们可以简单实现条件下发补丁，在出现异常情况时，也可以快速回滚补丁
（3）编译优化：简化了Tinker的编译复杂度，实现了备份路径选择，功能开关等功能

SDK 接入

这里只是针对TinkerPatch SDK的使用说明，对于Tinker的基本用法，可参考Tinker 接入指南。

添加 gradle 插件依赖

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        // TinkerPatch 插件
        classpath "com.tinkerpatch.sdk:tinkerpatch-gradle-plugin:1.2.14.7"
    }
}

注意，TinkerPatch SDK使用fat打包的模式，不能再引入任何Tinker的相关依赖，否则会造成版本冲突

集成 TinkerPatch SDK

添加TinkerPatch SDK库的denpendencies依赖

dependencies {
    implementation 'androidx.multidex:multidex:2.0.1'

    // 若使用annotation需要单独引用,对于tinker的其他库都无需再引用
    //implementation 'com.tinkerpatch.tinker:tinker-android-anno:1.9.14.7'
    implementation 'com.tinkerpatch.sdk:tinkerpatch-android-sdk:1.2.14.7'
}

注意：若使用annotation自动生成Application，需要单独引入Tinker的tinker-android-anno库。除此之外，我们无需再单独引入Tinker的其他库

设置多分包支持

defaultConfig {
    ...
    multiDexEnabled true
}

配置 tinkerpatchSupport 参数

打开引入的tinkerpatch.gradle文件，它的具体参数如下：

apply plugin: 'tinkerpatch-support'

/**
 * TODO: 请按自己的需求修改为适应自己工程的参数
 */
def bakPath = file("${buildDir}/bakApk/")
def baseInfo = "app-1.0.0-0806-15-25-12"
def variantName = "debug"

/**
 * 对于插件各参数的详细解析请参考
 * http://tinkerpatch.com/Docs/SDK
 */
tinkerpatchSupport {
    /**
     * 当disable tinker的时候需要添加multiDexKeepProguard和proguardFiles
     * 这些配置文件本身由tinkerPatch的插件自动添加，当你disable后需要手动添加
     * 可以copy本示例中的proguardRules.pro和tinkerMultidexKeep.pro
     * 需要手动修改'tinker.sample.android.app'本示例的包名为自己的包名, com.xxx前缀的包名不用修改
     */
    /** 可以在debug的时候关闭 tinkerPatch **/
    tinkerEnable = true

    /**
     * 使用自己的Application时应为true
     */
    /** 是否使用一键接入功能  **/
    reflectApplication = true

    /**
     * 只能在APK将要进行加固时使用，否则会patch失败
     * 如果只在某个渠道使用了加固，可使用多flavors配置
     */
    /** 是否开启加固模式，只有在使用加固时才能开启此开关 **/
    protectedApp = false

    /**
     * 新增Activity的exported属性必须为false
     */
    /** 补丁是否支持新增 Activity (exported必须为false)**/
    supportComponent = true

    autoBackupApkPath = "${bakPath}"

    /** 在tinkerpatch.com得到的appKey **/
    appKey = "d859642a7d5e48f2"
    /** 注意: 若发布新的全量包, 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
    }
}

在build.gradle中引入tinkerpatch.gradle的配置

为了简单方便，我们将TinkerPatch相关的配置都放于tinkerpatch.gradle中，我们需要将其引入：

apply from: 'tinkerpatch.gradle'

初始化Tinker

在Application中进行初始化

测试

生成基线APP

在主页的布局中添加一个TextView，修改前显示的内容为“Hello World!”

运行APP到手机上后，查看目录app/build/bakApk/

app
  build
    bakApk
      app-1.0.0-0806-15-22-05
      app-1.0.0-0806-15-25-12
      app-1.0.0-0806-15-27-55

配置基线APP

修改tinkerpatch.gradle中的参数

def baseInfo = "app-1.0.0-0806-15-25-12"

修改代码

修改TextView的内容为“Tinker测试\nPowered by AppBlog.CN”

生成Patch包

点击Android Studio右侧的Gradle -> Tasks -> tinker -> tinkerPatchDebug

生成补丁文件如下：

app
  build
    outputs
      apk
        tinkerPatch
          debug
            app-debug-new
            app-debug-old
            tinker_result
            log.txt
            patch_signed.apk
            patch_signed_7zip.apk
            patch_unsigned.apk
            res_log.txt
            resources_out.zip

错误情况一

Execution failed for task ':app:tinkerProcessDebugResourceId'.
> java.io.FileNotFoundException: E:\Android-Project\TinkerPatch\app\build\intermediates\tinker_intermediates\values_backup

参考：https://github.com/Tencent/tinker/issues/961

解决方法：

• 基准文件备份下
• clean项目
• 打补丁包

错误情况二

Caused by: com.tencent.tinker.android.dex.DexException: Unexpected magic: [100, 101, 120, 10, 48, 51, 55, 0]

（1）基线版本问题

• 基线版本最好采用gradle assemble、gradle assembleDebug、gradle assembleRelease等生成
• 直接点击运行图标生成的apk貌似有问题

（2）确认Patch包与基线包之间是否更改过下列相关信息，如不一致则报错

minSdkVersion 16
targetSdkVersion 29
versionCode 1
versionName "1.0.0"

发布到tinkerpatch的官网

重新打开之前安装的应用，打开后关闭并清空后台程序，再次重新发开，可以发现更改成功

注意事项

• 需要打开网络及文件存储权限