【Android】热修复——Tinker

本文介绍了Tinker的接入方式，更加详细的内容可以查阅官方文档

Tinker是微信官方的Android热补丁解决方案，它支持动态下发代码、So库以及资源，让应用能够在不需要重新安装的情况下实现更新。当然，你也可以使用Tinker来更新你的插件。
Tinker所支持的功能如下

来自官方Github

Tinker热补丁方案·不仅支持类、So以及资源的替换，它还是2.X－7.X的全平台支持。

在项目的 build.gradle中

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        // TinkerPatch 插件
       

classpath "com.tinkerpatch.sdk:tinkerpatch-gradle-plugin:1.2.2"
    }
}

然后在 app的 gradle文件 app/build.gradle中

//若使用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
}

在gradle.properties添加版本号

 

TINKER_VERSION=1.9.2
TINKERPATCH_VERSION=1.2.2

在app目录下，创建tinkerpatch.gradle

将 TinkerPatch 相关的配置都放于 tinkerpatch.gradle中,然后在app的 gradle文件 app/build.gradle中还添加

apply from: 'tinkerpatch.gradle'

配置参数

打开之前创建的tinkerpatch.gradle添加

apply plugin: 'tinkerpatch-support'

/**
 * TODO: 请按自己的需求修改为适应自己工程的参数
 */
def bakPath = file("${buildDir}/bakApk/")
def baseInfo = "app-1.0.1-0315-13-43-15"    ///旧版包的位置 
def variantName = "release"

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

    autoBackupApkPath = "${bakPath}"

    appKey = "5c5c64561b4cdb58"

    /** 注意: 若发布新的全量包, appVersion一定要更新 **/
    appVersion = "1.0.2"

    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
    }


}

• 参数说明
• bakPath：基包路径
• baseInfo：基包文件夹名（打补丁包的时候，需要修改）
• appKey：进入官网注册一个账号，新增APP，得到对应的appKey。
  
  

  官方参数说明

其中appKey在新增的APP中可以看到

appKey

 

最后在记得在Manifest.xml中配置Application，还要给SD卡读写权限

<manifest >
    .....
    <uses-permission android:name="android.permission.INTERNET"/>
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
    
</manifest>

 在自定义Application中初始化

private void initThinker() {
    tinkerApplicationLike = TinkerPatchApplicationLike.getTinkerPatchApplicationLike();

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

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

每次开发完成后，开始打包。
打开 Studio右侧的 Gradle，选择 assemableRelease打正式包

 

完成后可以在文件夹 build中找到生成的文件（这里称为基包）

 

打开 build -> bakApk -> app-1.0.0-0330-21-40-52 (根据时间命名)

release文件夹中会出现我们刚打完的包。一个apk，对应一个txt文件。

将app-1.0.0-0330-21-40-52备份，打补丁包的时候需要用到。
多渠道打包时会根据渠道名分包，目录结构相似。

生成补丁包

这里模拟一个修补bug的场景，发一个热补丁，弹一个Toast。
注意：在打生产包的代码上做修改

Toast.makeText(this, "这是个补丁", Toast.LENGTH_SHORT).show();

• 将之前的备份好的基包复制到build/bakApk下，打开tinkerpatch.gradle修改baseInfo成对应的文件名
  

  

  修改baseInfo

• 修改tinkerpatch.gradle中的tinkerpatchSupport -> appVersion
  

  

  appVersion

• 完成后打开Gradle，如下选择tinkerPatchRelease
  

  

  Gradle
  
  补丁包将位于 build/outputs/tinkerPatch 中，这里只需要用到patch_signed_7zip.apk
  
  

  补丁包

发布

最后，只需要将刚生成的补丁包发布，然后静静等待即可。

• 进入官方网站，新增APP
  
  

  添加APP

• 选择对应的app，添加APP版本
  
  

  添加APP版本
  
  
  

  添加版本
  
  版本号对应tinkerpatch.gradle中的appVersion
• 选择patch_signed_7zip.apk文件，提交即可（更多下发选项，参考官方文档）
  
  

  发布补丁

• 提交后，查看补丁的下载数量以及成功应用数

  
  
  

  补丁详情

这时候重新打开app，等待补丁下载。下载完成后关闭app，再次打开，查看结果。就这样，整个热修复的流程就完成了。
注意：一定要关闭后打开，热修复才会生效。

结果

关于兼容多渠道包

关于渠道包的问题，若使用flavor编译渠道包，会导致不同的渠道包由于BuildConfig变化导致classes.dex差异。这里建议的方式有：

• 将渠道信息写在AndroidManifest.xml或文件中，例如channel.ini；
• 将渠道信息写在apk文件的zip comment中，这种是建议方式，例如可以使用项目packer-ng-plugin或者可使用V2 Scheme的walle；
• 若不同渠道存在功能上的差异，建议将差异部分放于单独的dex或采用相同代码不同配置方式实现；

已通过Walle实现：【Android】Walle多渠道打包&Tinker热修复

Tinker已知的问题：

1. Tinker不支持修改AndroidManifest.xml，Tinker不支持新增四大组件；
2. 由于Google Play的开发者条款限制，不建议在GP渠道动态更新代码；
3. 在Android N上，补丁对应用启动时间有轻微的影响；
4. 不支持部分三星android-21机型，加载补丁时会主动抛出TinkerRuntimeException:checkDexInstall failed；
5. 由于各个厂商的加固实现并不一致，在1.7.6以及之后的版本，tinker不再支持加固的动态更新；
   （在官方——对加固的支持看到相关的内容，说是支持多种加固，不过我没试过 2017.7.3）
6. 对于资源替换，不支持修改remoteView。例如transition动画，notification icon以及桌面图标。

Tips:

• dubug模式下，tinkerpatch.gradle —> tinkerpatchSupport—>tinkerEnable需要改为false
• 添加SD卡权限，
• 下载补丁后，杀掉进程重新打开，补丁才会生效
• 补丁非即时生效，需要等一会儿