Tinker和TinkerPatch的集成与使用
Tinker平台介绍
什么是Tinker？
Tinker 是一个开源项目(Github链接)，它是微信官方的 Android 热补丁解决方案，它支持动态下发代码、So 库以及资源，让应用能够在不需要重新安装的情况下实现更新。
市面上各种热更新平台对比图
什么是TinkerPatch平台
Tinker 需要使用者有一个后台可以下发和管理补丁包，并且需要处理传输安全等部署工作，TinkerPatch 平台帮你做了这些工作，提供了补丁后台托管，版本管理，保证传输安全等功能，让你无需搭建一个后台，无需关心部署操作，只需引入一个 SDK 即可立即使用 Tinker。
此外，通过深入研究 Tinker 源码，TinkerTinkerPatch 平台在 Tinker的基础上加入了以下特性：
一键傻瓜式接入；无需理解复杂的热修复原理，一行代码即可接入热修复。实现了自动反射 Appliction 与 Library，使用者无需对自己的项目做任何的改动；
补丁管理；实现了热补丁的版本管理，补丁的自动重试与异常时自动回退等功能。同时我们可以简单实现条件下发补丁，在出现异常情况时，我们也可以快速回滚补丁；
编译优化；简化了 Tinker 的编译复杂度，实现了备份路径选择，功能开关等功能。
TinkerPatch 平台在 Github 为大家提供了各种各样的 Sample，大家可点击前往 [TinkerPatch Github].
TinkerPatch SDK的接入
第一步 添加 gradle 依赖
在项目根目录 build.gradle中添加如下
buildscript {
repositories {
jcenter()
}
dependencies {
// TinkerPatch 插件
classpath "com.tinkerpatch.sdk:tinkerpatch-gradle-plugin:1.2.2"
}
}
注意，在这里 SDK 使用了 fat 打包的模式，我们不能再引入任何 Tinker 的相关依赖，否则会造成版本冲突。当前 SDK 是基于 tinker 1.7.11 内核开发的。
第二步 集成 TinkerPatch SDK
在 app 的 build.gradle 中添加如下依赖
dependencies {
// 若使用annotation需要单独引用,对于tinker的其他库都无需再引用
provided("com.tinkerpatch.tinker:tinker-android-anno:1.9.2")
compile("com.tinkerpatch.sdk:tinkerpatch-android-sdk:1.2.2")
}
注意,若使用 annotation 自动生成 Application， 需要单独引入 Tinker 的 tinker-android-anno 库。除此之外，我们无需再单独引入 tinker 的其他库。
第三步 配置 TinkerpatchSupport 参数
apply plugin: 'tinkerpatch-support'
import java.util.regex.Matcher
import java.util.regex.Pattern
/**
* TODO: 请按自己的需求修改为适应自己工程的参数
*/
def bakPath = file("release/")
def baseInfo = "app-1.0.4-0123-16-33-42"
def variantName = "release"
/**
* 对于插件各参数的详细解析请参考
* http://tinkerpatch.com/Docs/SDK
*/
tinkerpatchSupport {
/** 可以在debug的时候关闭 tinkerPatch, isRelease() 可以判断BuildType是否为Release **/
tinkerEnable = true
// 是否反射实现一键接入
reflectApplication = true
/**
* 是否开启加固模式，只能在APK将要进行加固时使用，否则会patch失败。
* 如果只在某个渠道使用了加固，可使用多flavors配置
**/
protectedApp = false
/**
* 实验功能
* 补丁是否支持新增 Activity (新增Activity的exported属性必须为false)
**/
supportComponent = true
autoBackupApkPath = "${bakPath}"
// TinkerPatch 管理后台的appId
appKey = "f5f7c50dd6820856"
/** 注意: 若发布新的全量包, appVersion一定要更新 **/
appVersion = "1.0.4"
def pathPrefix = "${bakPath}/${baseInfo}/${variantName}/"
def name = "${project.name}-${variantName}"
baseApkFile = "${pathPrefix}/${name}.apk"
baseProguardMappingFile = "${pathPrefix}/${name}-mapping.txt"
baseResourceRFile = "${pathPrefix}/${name}-R.txt"
/**
* （可选）重命名备份文件的格式化字符串，默认为'${appName}-${variantName}'
*
* Available vars:
* 1. projectName
* 2. appName
* 3. packageName
* 4. buildType
* 5. versionName
* 6. versionCode
* 7. buildTime
* 8. fileSHA1
* 9. flavorName
* 10. variantName
*
* default value: '${appName}-${variantName}'
* Note: plz use single-quotation wrapping this format string
*/
// 格式化命名备份文件 这里请使用单引号
backupFileNameFormat = '${appName}-${variantName}'
/**
* 若有编译多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
}
}
import java.util.regex.Matcher
import java.util.regex.Pattern
/**
* 如果只想在Release中打开tinker，可以把tinkerEnable赋值为这个函数的return
* @return 是否为release
*/
def isRelease() {
Gradle gradle = getGradle()
String tskReqStr = gradle.getStartParameter().getTaskRequests().toString()
Pattern pattern;
if (tskReqStr.contains("assemble")) {
println tskReqStr
pattern = Pattern.compile("assemble(\\w*)(Release|Debug)")
} else {
pattern = Pattern.compile("generate(\\w*)(Release|Debug)")
}
Matcher matcher = pattern.matcher(tskReqStr)
if (matcher.find()) {
String task = matcher.group(0).toLowerCase()
println("[BuildType] Current task: " + task)
return task.contains("release")
} else {
println "[BuildType] NO MATCH FOUND"
return true;
}
}
第四点 初始化 TinkerPatch SDK
-
在第三点的 TinkerPatch.gradle 配置中，设置了 reflectApplication = true ，所以我们无需因为接入 Tinker 而更改 Application，具体如下：
public class MyApplication extends Application { private static final String TAG = "Tinker.SampleApp"; private ApplicationLike tinkerApplicationLike; public MyApplication() { } @Override public void attachBaseContext(Context base) { super.attachBaseContext(base); } /** * 由于在onCreate替换真正的Application, * 我们建议在onCreate初始化TinkerPatch,而不是attachBaseContext */ @Override public void onCreate() { super.onCreate(); initTinkerPatch(); } /** * 我们需要确保至少对主进程跟 patch 进程初始化 TinkerPatch */ private void initTinkerPatch() { // 我们可以从这里获得Tinker加载过程的信息 if (BuildConfig.TINKER_ENABLE) { tinkerApplicationLike = TinkerPatchApplicationLike.getTinkerPatchApplicationLike(); // 初始化TinkerPatch SDK TinkerPatch.init(tinkerApplicationLike) .reflectPatchLibrary() .setPatchRollbackOnScreenOff(true) .setPatchRestartOnSrceenOff(true) .setFetchPatchIntervalByHours(3); // 获取当前的补丁版本 Log.d(TAG, "Current patch version is " + TinkerPatch.with().getPatchVersion()); // fetchPatchUpdateAndPollWithInterval 与 fetchPatchUpdate(false) // 不同的是，会通过handler的方式去轮询 // 每隔3个小时（通过setFetchPatchIntervalByHours设置）去访问后台是否有 patch 包更新,通过handler实现轮训的效果 TinkerPatch.with().fetchPatchUpdateAndPollWithInterval(); } } }
Tinker 加载 patch 包过程的结果存放于 TinkerPatchApplicationLike 中。
如果使用 reflectApplication = false，则使用 anno 生成 application，有如下两种方案：
1、创建 AppContextLike 类继承与 Tinker 的 ApplicationLike ，再加上相应的注解
@DefaultLifeCycle(
application = ".AppContext", flags = ShareConstants.TINKER_ENABLE_ALL )
public class AppContextLike extends ApplicationLike {
public AppContextLike(Application application, int tinkerFlags, boolean tinkerLoadVerifyFlag, long applicationStartElapsedTime, long applicationStartMillisTime, Intent tinkerResultIntent) {
super(application, tinkerFlags, tinkerLoadVerifyFlag, applicationStartElapsedTime, applicationStartMillisTime, tinkerResultIntent);
}
@Override
public void onCreate() {
super.onCreate();
initTinker();
}
private void initTinker() {
if (BuildConfig.TINKER_ENABLE) {
//开始检查是否有补丁，这里配置的是每隔访问3小时服务器是否有更新。
TinkerPatch.init(this)
.reflectPatchLibrary()
.setPatchRollbackOnScreenOff(true)
.setPatchRestartOnSrceenOff(true)
.setFetchPatchIntervalByHours(3);
// 获取当前的补丁版本
Log.d(TAG, "current patch version is " + TinkerPatch.with().getPatchVersion());
//每隔3个小时去访问后台时候有更新,通过handler实现轮训的效果
TinkerPatch.with().fetchPatchUpdateAndPollWithInterval();
}
}
}
ApplicationLike 并不是继承与 Application，而是类似于 Application 的一个类，所以不能将AppContextLike 作为Application直接配置到清单文件中。以上代码通过 @DefaultLifeCycle 注解会在编译其生成 AppContext 类，该类继承自Application，我们可以把 Application 需要做的事情放在中 AppContextLike，在清单文件中配置 AppContext，如下：
这样在程序启动时，就会相应的初始化 AppContextLike 类进而初始化 Tinker。
2、第二种方法，基本步骤同 1 ，不同点在于清单文件 Application 的配置，如果项目是后期才加入的 Tinker，而又不想去修改原有的 Application，可以使用项目中已存在的 Application 继承与 @DefaultLifeCycle 注解生成的 Application，清单文件中的配置还是使用之前的 Application.
为了方便使用，在 app 目录下创建 TinkerPatch.gradle 文件用于配置 TinkerPatch。在 build.gradle 中引入：
apply from: 'tinkerpatch.gradle'
第五步 生成并发布 patch 包
1、 使用 debug 或者 release 签名方式进行打包（这里使用release签名），打包成功后，会在app目录下生成 release 目录。
2、 打包成功后，会在 release 中生成 apk、mapping.txt、R.txt等（mapping.txt 时混淆的产物，开启混淆才会有该文件）。把这些文件的路径配置到 TinkerPatch.gradle 中：
def bakPath = file("release/")
def baseInfo = "app-1.0.4-0123-16-33-42"
def variantName = "release"
tinkerpatchSupport {
... // 略
def pathPrefix = "${bakPath}/${baseInfo}/${variantName}/"
def name = "${project.name}-${variantName}"
baseApkFile = "${pathPrefix}/${name}.apk"
baseProguardMappingFile = "${pathPrefix}/${name}-mapping.txt"
baseResourceRFile = "${pathPrefix}/${name}-R.txt"
...// 略
}
3、 接下来就是生成 patch 包了，这里需要注意一点，在 TinkerPatch.gradle 配置中有一个 appVersion，这个 appVersion 并不是指 app 的版本，而是在 TinkerPatch 平台添加新版本输入的版本号，Tinker 使用 appVersion 作为 TinkerId, 我们需要保证每个发布出去的基础安装包的 appVersion 都不一样。每更新一个基准包出去后，appVersion 必须往上升高。基于某个基准包（某个 appVersion 版本号）发布一个新的 patch 包后，该基准包在启动时就会检查 TinkerPatch 服务器中对应版本有没有新的 patch 包，有则下载并合成，下次启动项目就会是修复后的应用包。生成 patch 包的步骤如图：
生成的patch路劲如下：
4、 发布 patch 包到 TinkerPatch 平台。
在 TinkerPatch 管理后台对应应用添加一个APP版本，App 版本号和发布出去的基准包的 appVersion 保持一致，然后选定刚刚创立的版本上传 patch 包、补丁日志、下发类型（开发预览/全量下发/条件下发/灰度下发）等。最后提交就ok了。发布之后，我们可以在管理后台的补丁详情中查看到补丁的详细信息、更新时间、补丁大小、已下发个数（应用/合成/下载）等，实时掌握 patch 的下发状态。
