Android之Tinker集成使用

前言：当前市面上为了实现不发新版本的前提下实现修改线上严重bug的目标而诞生的热补丁方案有很多，其中比较出名的有阿里的AndFix、美团的Robust以及腾讯的Tinker等等，但是其中用的比较广的还是腾讯的Tinker，所以在这里我也是选取了Tinker作为学习研究对象。

tinker之dex更新详解

tinker之资源更新详解

tinker之so更新详解

在文章开始之前先copy一个不同方案的对比图，就可以知道Tinker的强大之处：

虽然Tinker和其他方比较显得是很强大的，但是它也有自己的一些问题。由于原理与系统限制，Tinker有以下已知问题：

• Tinker不支持修改AndroidManifest.xml，Tinker不支持新增四大组件；

• 由于Google Play的开发者条款限制，不建议在GP渠道动态更新代码；

• 在Android N上，补丁对应用启动时间有轻微的影响；

• 不支持部分三星android-21机型，加载补丁时会主动抛出"TinkerRuntimeException:checkDexInstall failed"；

• 对于资源替换，不支持修改remoteView。例如transition动画，notification icon以及桌面图标；

在对Tinker有个简单了解后，下面我们就开始在项目中一步步集成Tinker了。

1.先去Tinker平台注册一个AppKey，后面会使用到。

Tinker注册地址

2.项目添加 gradle 远程仓库插件依赖。

buildscript {
    repositories {
        //mavenLocal()
        google()
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.0.1'
        //无需再单独引用tinker的其他库
        classpath "com.tinkerpatch.sdk:tinkerpatch-gradle-plugin:${TINKERPATCH_VERSION}"
    }
}

3.集成 TinkerPatch SDK 添加 denpendencies 依赖。

//若使用annotation需要单独引用,对于tinker的其他库都无需再引用
annotationProcessor("com.tinkerpatch.tinker:tinker-android-anno:${TINKER_VERSION}") { changing = true }
compileOnly("com.tinkerpatch.tinker:tinker-android-anno:${TINKER_VERSION}") { changing = true }
implementation("com.tinkerpatch.sdk:tinkerpatch-android-sdk:${TINKERPATCH_VERSION}") { changing = true }

4.新建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 = false
    /**
     * 是否开启加固模式，只能在APK将要进行加固时使用，否则会patch失败。
     * 如果只在某个渠道使用了加固，可使用多flavors配置
     **/
    protectedApp = false
    /**
     * 实验功能
     * 补丁是否支持新增 Activity (新增Activity的exported属性必须为false)
     **/
    supportComponent = true

    autoBackupApkPath = "${bakPath}"

    appKey = "f938475486f91936"

    /** 注意: 若发布新的全量包, 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.gradle放在app目录下。

为了简单方便，我们将 TinkerPatch 相关的配置都放于 tinkerpatch.gradle 中并在app的build.gradle中引入：

apply from: 'tinkerpatch.gradle'

tinkerpatch.gradle中的baseInfo和variantName可以先不用管，后面使用：

def bakPath = file("${buildDir}/bakApk/")
def baseInfo = "app-1.0.0-0115-14-59-51"
def variantName = "debug"

5.配置tinkerpatchSupport参数。

1.baseInfo和variantName参数先按照这个放着暂时不管

2.appKey请返回第一步拿到申请的appkey。

3.appVersion版本号一般对应你的versionName就行了。versionName改的话 这里就改，这里的appVersion对应tinker官网上传patch时的版本，切记！

具体的参数详解如下：

参数	默认值	描述
tinkerEnable	true	是否开启 tinkerpatchSupport 插件功能。
appKey	""	在 TinkerPatch 平台 申请的 appkey, 例如 sample 中的 'f828475486f91936'
appVersion	""	在 TinkerPatch 平台 输入的版本号, 例如 sample 中的 '1.0.0'。 注意，我们使用 appVersion 作为 TinkerId, 我们需要保证每个发布出去的基础安装包的 appVersion 都不一样。
reflectApplication	false	是否反射 Application 实现一键接入；一般来说，接入 Tinker 我们需要改造我们的 Application, 若这里为 true， 即我们无需对应用做任何改造即可接入。
autoBackupApkPath	""	将每次编译产生的 apk/mapping.txt/R.txt 归档存储的位置
baseApkFile	""	基准包的文件路径, 对应 tinker 插件中的 oldApk 参数;编译补丁包时，必需指定基准版本的 apk，默认值为空，则表示不是进行补丁包的编译。
baseProguardMappingFile	""	基准包的 Proguard mapping.txt 文件路径, 对应 tinker 插件 applyMapping 参数；在编译新的 apk 时候，我们希望通过保持基准 apk 的 proguard 混淆方式，从而减少补丁包的大小。这是强烈推荐的，编译补丁包时，我们推荐输入基准 apk 生成的 mapping.txt 文件。
baseResourceRFile	""	基准包的资源 R.txt 文件路径, 对应 tinker 插件 applyResourceMapping 参数；在编译新的apk时候，我们希望通基准 apk 的 R.txt 文件来保持 Resource Id 的分配，这样不仅可以减少补丁包的大小，同时也避免由于 Resource Id 改变导致 remote view 异常。
protectedApp	false	是否开启支持加固，注意：只有在使用加固时才能开启此开关
supportComponent	false	是否开启支持在补丁包中动态增加Activity 注意：新增Activity的Exported属性必须为false�
backupFileNameFormat	'${appName}-${variantName}'	格式化命名备份文件 这里请使用单引号

上述步骤 配置完之后 sync编译即可。

6.初始化 TinkerPatch SDK。

以上属性中有一个reflectApplication 属性，所以初始化 TinkerPatch SDK有两种方法：

1. reflectApplication = true 的情况：若我们使用 reflectApplication 模式，我们无需为接入 Tinker 而改造我们的 Application 类，相当于自己写一个Application。请看下面示例代码：

public class MyApplication extends Application {
    private ApplicationLike tinkerApplicationLike;

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

    /**
     * 我们需要确保至少对主进程跟patch进程初始化 TinkerPatch
     */
    private void initTinkerPatch() {
        if (BuildConfig.TINKER_ENABLE) {
            // 我们可以从这里获得Tinker加载过程的信息
            // 我们可以从这里获得Tinker加载过程的信息
            tinkerApplicationLike = TinkerPatchApplicationLike.getTinkerPatchApplicationLike();

            // 初始化TinkerPatch SDK, 更多配置可参照API章节中的,初始化SDK
            TinkerPatch.init(tinkerApplicationLike)
                    .reflectPatchLibrary()
                    .setPatchRollbackOnScreenOff(true)
                    .setPatchRestartOnSrceenOff(true)
                    .setFetchPatchIntervalByHours(3);

            // 每隔3个小时(通过setFetchPatchIntervalByHours设置)去访问后台时候有更新,通过handler实现轮训的效果
            TinkerPatch.with().fetchPatchUpdateAndPollWithInterval();
        }
    }
}

2. reflectApplication = false 的情况：不需要自己写Application类，新建一个集成DefaultApplicationLike的类即可。

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();
    }
   ...
}

友情提示：setFetchPatchIntervalByHour(3) // 每隔3个小时(通过setFetchPatchIntervalByHours设置)去访问后台时候有更新,是通过handler实现轮训的效果。

7.在AndroidManifest.xml中完成配置。

将AndroidManifest.xml中的添加上相应的网络和SD的权限，还要在application中加上 android:name=".MyApplication"。

到现在tinker基本上已经集成完了。

8.开始体验一下。

1.首先我们要生成基准APK：

在命令行工具中输入gradlew assemblerelease命令,运行完毕后将old APK push到我们的手机上。

打开app目录下的build文件夹，结合之前build.gradle文件配置操作，我们看到tinker为我们生成了bakApk文件夹，在该文件夹下存放了基准文件相关信息。如下图所示：

2.接下来，我们打补丁包（模拟修复bug）。

首先到tinkerpatch.gradle里更改咱们先前介绍的两个参数：

• baseInfo:修改为上面生成的对应文件夹名（请修改为自己的）；
• variantName:因为打的debug包，所以传入debug即可；

/**
 * TODO: 请按自己的需求修改为适应自己工程的参数
 */
//基包路径
def bakPath = file("${buildDir}/bakApk/")
//基包文件夹名（打补丁包的时候，需要修改）
def baseInfo = "app-1.0.0-0116-11-22-29"(上图中的最后一个app-.....)
//版本名称
def variantName = "debug"

然后我们随便在某个xml中做一些布局效果的修改。

再然后打出差异包补丁，继续找到Gradle下的tinker目录，点击tinkerPatchDebug进行编译。如下图：

编译完成之后，到工程目录下app->outputs->查看生成的文件夹 tinkerPatch：

接下来，我们将图中箭头所指的patch_signed_7zip.apk上传至tinker官网（发布补丁）：

点击图中的补丁下发，然后将上面生成的patch_signed_7zip.apk上传至补丁文件处，点击提交。

退出应用，再次打开应用，显示的就是新的布局文件的内容。

然后到tinker官网，我们可以查看补丁下发进度及当前成功率。

到此为止，Tinker接入使用流程就结束了  see  you