当前市面的热补丁方案有很多,其中比较出名的有阿里的 AndFix、美团的 Robust 以及 QZone 的超级补丁方案 今天简单陈述一下我对Tinker的使用之旅和其中遇到的各种问提希望对大家有些许帮助
一、集成 (官方地址 http://www.tinkerpatch.com/Docs/SDK)
1.插件添加
// TinkerPatch 插件
classpath "com.tinkerpatch.sdk:tinkerpatch-gradle-plugin:1.2.13"
2.集成 TinkerPatch SDK
//tinker的核心库
com.tinkerpatch.sdk:tinkerpatch-android-sdk:1.2.9
3. tinkerpatch.gradle 引入
本地项目 gradle 配置
apply plugin: 'tinkerpatch-support'
/**
* TODO: 请按自己的需求修改为适应自己工程的参数
*/
def bakPath = file("${buildDir}/tinker/")
def baseInfo = "app-2.0.0-0327-19-37-50"
def variantName = "app-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 = true
/**
* 实验功能
* 补丁是否支持新增 Activity (新增Activity的exported属性必须为false)
**/
supportComponent = true
autoBackupApkPath = "${bakPath}"
appKey = "自己项目在Tinker官网生成的 Appkey"
/** 注意: 若发布新的全量包, appVersion一定要更新 **/
appVersion = versions['version_name']
// def pathPrefix = "${bakPath}/${baseInfo}/${variantName}"
def pathPrefix = "${bakPath}\\${baseInfo}"
def name = "${project.name}-${variantName}"
// def pathPrefix = "app_fix"
// def name = "app-app-release"
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
}
}
注意: 此处配置最为关键关系到你热修复的补丁包是否能成功
1.appkey 替换为你自己的appkey
2.appVersion 要关联你项目的发行版本
3.线上发新的版本包一定要是 我们开始引入的tinker插件根据 此处配置的 baseApkFile 生成在这个目录下的apk
4. 我们目前对android进行新版的发布都会对 apk 进行加固操作 再次还有一个要注意的事项
protectedApp 参数在需要加固的时候启用 (发布的时候有加固操作 此项置为 true 打补丁包的时候也要保证为true )
否则会出现补丁包合成失败的情况
4.初始化Tinker
1.在项目的application中初始化即可
/**
* 初始化tinker
*/
private void initTinker() {
// 我们可以从这里获得Tinker加载过程的信息
ApplicationLike tinkerApplicationLike = TinkerPatchApplicationLike.getTinkerPatchApplicationLike();
// 初始化TinkerPatch SDK, 更多配置可参照API章节中的,初始化SDK
TinkerPatch.init(tinkerApplicationLike)
.reflectPatchLibrary()
.setPatchRestartOnSrceenOff(true)
.setFetchPatchIntervalByHours(3)
.setAppChannel(UserManage.getInstance().getChannelName())
.setPatchResultCallback(new ResultCallBack() {
@Override
public void onPatchResult(PatchResult patchResult) {
// ToastUtil.showToast("onPatchResult callback here");
}
});
// TinkerPatch.with().setPatchCondition();
// 每隔3个小时(通过setFetchPatchIntervalByHours设置)去访问后台时候有更新,通过handler实现轮训的效果
TinkerPatch.with().fetchPatchUpdateAndPollWithInterval();
}
2.在项目中合适的地方添加预设条件 最为上线后用来做条件下发的只用
如下我子项目中设置了UID为下发条件
TinkerPatch.with().setPatchCondition("userid", response.getResult().getUser().getId());
二、补丁包生成与发布
1.如上所述 我们tinker 集成成功后会在包的时候生成用来生成差异包的基础包目录
2.修复线上出现的bug后生成差异包
①.定位基础包的目录 上述tnkerPatch.gradle 文件中 头部有三个目录配置项
在此把上述的配置 根据自己基础包的文件目录和文件名字 进行一一对应 即可
② 生成差异包
android studio 集成Tinker 的插件后悔对应的 在Gradle 中生成对应的可视化打包工具
找到对应的渠道执行 即可
最后你会得到一个 目录
如图就是你要的得到的差异包
③补丁下发
补丁文件选择 刚刚生成的文件即可
下发方式选择一下即可下发
开发预览: 开发预览 是一种开发提前体验验证的一个方式 可以在要验证的手机 安装官方提供的apk 打开预览模式的开关即可
http://www.tinkerpatch.com/Docs/dev
条件下发可以根据 我们在上述初始化的条件中选择 以 key==value 的方式书写即可
④ 下发状态插件查看
下发状态合成状态 都可以实时监控
⑥生效
我们在初始化的时候有设置应用三个小时 去拉取一次补丁包 拉取到会在本地合成 这个时候 代码是不会生效的
只有下次启用应用的时候才会正式生效(当然我们测试的时候 可以通过应用重启 来规避三个小时的等待时间)
好了本次Tinker之旅就到这了 。