前言
相信大家都有遇到过刚上传发布后的安装包或大或小的有个Bug需要及时的修复，但是如果重新打包上线到各大应用市场的话成本又很高，用户体验也是一方面，由此篇主接到个新需求----->接入热修复。
各大热修复之间的对比
在接到热修复功能需求后，篇主先是找相关热修复框架,现在市场上的热修复工具或者框架有很多很多，比较出名的有阿里的 AndFix、美团的 Robust 以及 QZone 的超级补丁方案。这几个方案各有利弊，下面这张图可以清晰地看到各个框架之间的区别，大家可以根据自身需求接入(本篇主要以微信Tinker接入为例)。
Tinker热补丁方案·不仅支持类、So以及资源的替换，它还是2.X－7.X的全平台支持。在官网上，介绍这个Tinker，用了一句话：Tinker 已运行在微信的数亿 Android 设备上，那么为什么你不使用 Tinker 呢？ ps：确实是，微信有多大的用户量，我们这才多少的用户量，不必过多的担心。
这篇文章，主要是和大家聊一下怎么集成这个Tinker，并不会设计很多原理的东西，如果需要了解更深入的原理性的东西，可以到官网看看。点击官网 http://tinkerpatch.com/Docs/intro
开始接入
废话少说，开工干活。
第一步；导入依赖
首先在项目根目录build.gradle中添加远程依赖
buildscript {
repositories {
google()
jcenter()
}
dependencies {
classpath 'com.android.tools.build:gradle:3.2.0'
classpath "com.tinkerpatch.sdk:tinkerpatch-gradle-plugin:1.2.13.3"
// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
}
}
第二步；集成 TinkerPatch SDK
在app中的build.gradle添加依赖
dependencies {
...
// 若使用annotation需要单独引用,对于tinker的其他库都无需再引用
compileOnly("com.tinkerpatch.tinker:tinker-android-anno:1.9.13.3")
implementation("com.tinkerpatch.sdk:tinkerpatch-android-sdk:1.2.13.3")
}
apply from: 'tinkerpatch.gradle'
第三步 配置 tinkerpatchSupport 参数
注意：tinkerpatch.gradle放到app目录下
打开tinkerpatch.gradle，将 TinkerPatch 相关的配置都放于tinkerpatch.gradle中（这样做也是为了方便区分）。
apply plugin: 'tinkerpatch-support'
/**
* TODO: 请按自己的需求修改为适应自己工程的参数
*/
//基包路径
def bakPath = file("${buildDir}/bakApk/")
//基包文件夹名（打补丁包的时候，需要修改）
def baseInfo = "app-1.0.0-0905-15-17-23"
//版本名称
def variantName = "debug"
/**
* 对于插件各参数的详细解析请参考
*
*/
tinkerpatchSupport {
//可以在debug的时候关闭 tinkerPatch
tinkerEnable = true
//是否使用一键接入功能 默认为false 是否反射 Application 实现一键接入；
// 一般来说，接入 Tinker 我们需要改造我们的 Application, 若这里为 true， 即我们无需对应用做任何改造即可接入。
reflectApplication = true
//将每次编译产生的 apk/mapping.txt/R.txt 归档存储的位置
autoBackupApkPath = "${bakPath}"
appKey = "cdacf3697ba3e6ea"// 注意！！！ 需要修改成你的appkey
/** 注意: 若发布新的全量包, appVersion一定要更新 **/
appVersion = "1.0.0"
/** 如果用了360加固或者其他之类的加固软件这个得打开，需要查看tinker官网是否支持你选用的加固工具 **/
protectedApp = false
def pathPrefix = "${bakPath}/${baseInfo}/${variantName}/"
def name = "${project.name}-${variantName}"
/**
* 基准包的文件路径, 对应 tinker 插件中的 oldApk 参数;编译补丁包时，
* 必需指定基准版本的 apk，默认值为空，则表示不是进行补丁包的编译
*/
baseApkFile = "${pathPrefix}/${name}.apk"
/**
* 基准包的 Proguard mapping.txt 文件路径, 对应 tinker 插件 applyMapping 参数；在编译新的 apk 时候，
* 我们希望通过保持基准 apk 的 proguard 混淆方式，
* 从而减少补丁包的大小。这是强烈推荐的，编译补丁包时，我们推荐输入基准 apk 生成的 mapping.txt 文件。
*/
baseProguardMappingFile = "${pathPrefix}/${name}-mapping.txt"
/**
* 基准包的资源 R.txt 文件路径, 对应 tinker 插件 applyResourceMapping 参数；在编译新的apk时候，
* 我们希望通基准 apk 的 R.txt 文件来保持 Resource Id 的分配，这样不仅可以减少补丁包的大小，
* 同时也避免由于 Resource Id 改变导致 remote view 异常
*/
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 //是否需要签名，打正式包如果这里是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
}
}
这里篇主从Tinker官网拉过来的一张图，是对tinkerpatch.gradle中的一些参数的配置定义
第四步 初始化 TinkerPatch SDK
官方给了我们两种方式来初始化TinkerPatch SDK，第一种是reflectApplication = true 的情况，另一种reflectApplication = false的情况，今天我们说reflectApplication = true这种情况，另一种情况，大家可以到官网中看看
简单来说一下这两种情况的区别啊，当reflectApplication = true这种情况是不需要更改我们项目的Application类，而reflectApplication = false的情况是需要改动Application这个类。
public class TinkerApplication extends Application {
private ApplicationLike tinkerApplicationLike;
@Override
public void onCreate() {
super.onCreate();
if (BuildConfig.TINKER_ENABLE) {
// 我们可以从这里获得Tinker加载过程的信息
tinkerApplicationLike = TinkerPatchApplicationLike.getTinkerPatchApplicationLike();
// 初始化TinkerPatch SDK, 更多配置可参照API章节中的,初始化SDK
TinkerPatch.init(tinkerApplicationLike)
.reflectPatchLibrary()
.setPatchRollbackOnScreenOff(true)
.setPatchRestartOnSrceenOff(true);
// 每隔3个小时去访问后台是否有更新,通过handler实现轮训的效果
new FetchPatchHandler().fetchPatchWithInterval(3);
}
}
}
FetchPatchHandler这个类是用来实现轮询
public class FetchPatchHandler extends Handler {
public static final long HOUR_INTERVAL = 3600 * 1000;
private long checkInterval;
/**
* 通过handler, 达到按照时间间隔轮训的效果
*/
public void fetchPatchWithInterval(int hour) {
//设置TinkerPatch的时间间隔
TinkerPatch.with().setFetchPatchIntervalByHours(hour);
checkInterval = hour * HOUR_INTERVAL;
//立刻尝试去访问,检查是否有更新
sendEmptyMessage(0);
}
@Override
public void handleMessage(Message msg) {
super.handleMessage(msg);
//这里使用false即可
TinkerPatch.with().fetchPatchUpdate(false);
//每隔一段时间都去访问后台, 增加10分钟的buffer时间
sendEmptyMessageDelayed(0, checkInterval + 10 * 60 * 1000);
}
}
最后需要在AndroidManifest.xml中的添加上相应的网络和SD的权限，还要在application中加上 android:name=".tinkerApplication"
<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"/>
<application
android:allowBackup="true"
android:icon="@mipmap/ic_launcher"
android:label="@string/app_name"
android:roundIcon="@mipmap/ic_launcher_round"
android:supportsRtl="true"
android:theme="@style/AppTheme"
android:name=".TinkerApplication">
<activity android:name=".MainActivity">
<intent-filter>
<action android:name="android.intent.action.MAIN" />
<category android:name="android.intent.category.LAUNCHER" />
</intent-filter>
</activity>
</application>
到这里，集成Tinker的相关接入以及配置基本上已经完成了，现在运行看看如图
双击assembleDebug就可以运行项目了，运行的过程中篇主遇到了此异常：
Annotation processors must be explicitly declared now. The following dependencies on the compile
classpath are found to contain annotation processor. Please add them to the annotationProcessor configuration.
- tinker-android-anno-1.9.13.3.jar (com.tinkerpatch.tinker:tinker-android-anno:1.9.13.3)
Alternatively, set android.defaultConfig.javaCompileOptions.annotationProcessorOptions.includeCompileClasspath = true to continue with previous behavior. Note that this option is deprecated and will be removed in the future.
See https://developer.android.com/r/tools/annotation-processor-error-message.html for more details.
此异常是由于Tinker用到了注解的形式，需要在app的build.gradle中声明一下
javaCompileOptions { annotationProcessorOptions { includeCompileClasspath = true } }
添加上声明后再次双击assembleDebug运行项目，上图说明：
生成的全量包在此目录下：
将此apk的安装包安装到模拟器上后：
接着我们打有补丁的包，打补丁的包之前，我们的改两个地方，在tinkerpatch.gradle中找到如图中的代码，我们需要将baseInfo，和variantName改成和自己的一直如图：
改完以后，我们就可以打补丁的包了，如图
改完之后我们就可以开始打补丁包了，此时我把TextView的text值从Hello World!改成了Tinker修复了某个Bug（方便一会区分），如图：
双击运行此任务，打出来的就是补丁包了
生成的补丁包默认是.apk结尾的文件格式，但是Tinker官网建议用其他格式的文件上传否则补丁包很容易被一些手机清理掉，因此我将.apk文件改成了.zip格式。
最后将我们的补丁包上传到tinker官网，就可以使用了，如图
此时需要杀掉进程才会生效（由于简书需要开通会员才能上传短视频，音频，所以就不给大家发模拟器的视频录制了，仅用一张图片代替补丁包的结果）
上传的补丁包如果没起效果的话可以从下面几点排查（前提是补丁包已经确认上传成功了）
1.将App杀进程再进，此时TinkerPatch页面有提示（[[应用/合成/下载]数： 0/1/1（查看详情）]），表示补丁包已经下载并且合成成功了，但是还没有应用到App中，只用再次杀进程再重新打开App即可，此时刷新TinkerPatch页面会提示（[[应用/合成/下载]数： 1/1/1（查看详情）]），表示补丁包已经奏效；
2.如果第一种方式没效果，可以卸载模拟器上的App，重新安装一下之前安装的哪个全量包，再次打开，杀进程重新打开，然后查看TinkerPatch页面的提示，看一下是否奏效；
3.以上方式都没效果，那么恭喜，跟我一样纳闷了许久，我是在40分钟以后才发现补丁包下载下来了，靠，延时这么久，来回看Tinker的官方文档，都快把文档背过了。
到此Tinker热修复的接入也就告一段落了，以上都是篇主的经验心得与一路踩过的坑，在这里与大家互相分享学习，也是为了给自己做一个笔记，有问题的朋友可以在下方评论提问，篇主尽量解答各位的问题，谢谢大家的支持，一起努力！！！
