一、说明
Tinker 是一个开源项目(Github链接),它是微信官方的 Android 热补丁解决方案,它支持动态下发代码、So 库以及资源,让应用能够在不需要重新安装的情况下实现更新,当前市面的热补丁方案有很多,其中比较出名的有阿里的 AndFix、美团的 Robust 以及 QZone 的超级补丁方案。但它们都存在无法解决的问题,这也是正是我推出 Tinker 的原因,这是官方的文档:http://www.tinkerpatch.com/Docs/SDK
tinker有这么多的优点, 那我们来看看如何使用它。
二、集成
1、添加权限
<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" />
2、在工程下的build.gradle加入:
buildscript {
repositories {
jcenter()
}
dependencies {
// TinkerPatch 插件
classpath "com.tinkerpatch.sdk:tinkerpatch-gradle-plugin:1.2.9"
}
}
3、在app的build.gradle中加入这两句来引入库:
dependencies {
compileOnly("com.tinkerpatch.tinker:tinker-android-anno:1.9.9")
implementation("com.tinkerpatch.sdk:tinkerpatch-android-sdk:1.2.9")
}
4、在app的build.gradle的顶部加上这句:
5、既然引进了tinkerpatch.gradle, 那就在app下创建该文件, 然后加入以下代码:
apply plugin: 'tinkerpatch-support'
/**
* TODO: 请按自己的需求修改为适应自己工程的参数
*/
def bakPath = file("${buildDir}/bakApk/")
def baseInfo = "app-1.0.0-0426-13-18-39"
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 = true
/**
* 是否开启加固模式,只能在APK将要进行加固时使用,否则会patch失败。
* 如果只在某个渠道使用了加固,可使用多flavors配置
**/
protectedApp = false
/**
* 实验功能
* 补丁是否支持新增 Activity (新增Activity的exported属性必须为false)
**/
supportComponent = true
autoBackupApkPath = "${bakPath}"
appKey = "f246c53b8fcb6bfb"
/** 注意: 若发布新的全量包, 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
}
}
tinkerpatchSupport里面都是我们需要配置的参数,全部参数的含义可以查看官网,上面都写的很清楚,在这里我们需要改的我介绍一下:
(1)tinkerEnable = true
开启热更新, 在调试的时候可以设置为false
(2)reflectApplication = true
是否通过反射来初始化,可以查看官网,有两种初始化方式,如果设置为false,就需要Application继承DefaultApplicationLike来初始化
(3)protectedApp = false
是否开启加固模式,只能在APK将要进行加固时使用,否则会patch失败。 如果只在某个渠道使用了加固,可使用多flavors配置
(4)supportComponent = true
补丁支持新增Activity,这个要设置成true,并且要activity的export="false"
(5)appKey = "f246c5xxxxb6bfb"
这个是在tinker平台注册应用时生成的appKey,每个应用要替换成自己的
(6)appVersion = "1.0.0"
这个是我们app发布的时候填的版本号(versionName),同一个版本的app可以打多个补丁,tinker会自动管理补丁的版本,这里appVersion = "1.0.0"表示当前补丁是打给1.0.0版本的
三、生成补丁和发布补丁
加入目前1.0.0版本已经发出去了,结果出现了bug,那我们要生成针对1.0.0版本的补丁包
1、首先拿到1.0.0版本的代码,然后运行,或者执行命令assembleRelease,这时候build下会出现bakApk目录,下面是刚才执行命令或者运行程序生成的apk,我们就是给它打补丁
2、tinkerpatch.gradle中这两个变量分别赋值为图片上1和2标识的目录名,这样就表示修改的bug是针对此版本的
def baseInfo = "app-1.0.0-0426-13-18-39"
def variantName = "debug"
3、修改bug, 修改你自己的bug, 然后双击(1)图片上画出来的命令,执行tinkerPatchRelease或者tinkerPatchDebug,生成补丁
4、到官网的补丁下发页面发布补丁
应用每次发布版本都要添加一个APP版本, 然后针对此版本下发补丁。
上传补丁,然后提交,这时候重启应用即可看到效果,初始化的时候要注意, 设置每次启动都要检测:
TinkerPatch.with().fetchPatchUpdate(true);
四、总结
1、tinkerpatch.gradle中的appVersion = "1.0.0"代表发布出去的app的版本,一个版本可以打多个补丁包, 比如目前线上的版本是1.0.0, 现在要给线上版本打补丁,那么appVersion就应该填1.0.0, 第一个补丁包bug没修改完, 再次打补丁包的话appVersion可以不用变,依然为1.0.0
2、打补丁包时先要用线上的代码打原始包, 然后把:def baseInfo="app-1.0.0-0425-18-02-37" 和 def vaiantName="debug"这两个变量换成刚才打包生成apk的文件夹名字:
3、添加修改bug的代码, 然后执行tinkerPatchDebug来打补丁包,最后发布补丁包
五、tinker对productFlavors的支持
1、比如目前有如下productFlavors
flavorDimensions 'default'
productFlavors {
protect {
dimension 'default'
applicationId 'com.tinkerpatch.easy_sample.protected'
matchingFallbacks = ['debug']
}
flavor1 {
dimension 'default'
applicationId 'com.tinkerpatch.easy_sample.flavor1'
matchingFallbacks = ['debug']
}
}
2、tinkerpatch.gradle要这么写:
import java.util.regex.Matcher
import java.util.regex.Pattern
apply plugin: 'tinkerpatch-support'
def bakPath = file("${buildDir}/bakApk/")
def baseInfo = "app-1.0.0-0426-15-27-00"
def variantName = "debug"
/**
* 对于插件各参数的详细解析请参考
* http://tinkerpatch.com/Docs/SDK
*/
tinkerpatchSupport {
/** 可以在debug的时候关闭 tinkerPatch **/
tinkerEnable = true
reflectApplication = true
/**
* 是否开启加固模式,只能在APK将要进行加固时使用,否则会patch失败。
* 如果只在某个渠道使用了加固,可使用多flavors配置
**/
protectedApp = false
/**
* 实验功能
* 补丁是否支持新增 Activity (新增Activity的exported属性必须为false)
**/
supportComponent = true
autoBackupApkPath = "${bakPath}"
appKey = "f938475486f91936"
/** 注意: 若发布新的全量包, appVersion一定要更新 **/
appVersion = "1.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需求,可在flavors中覆盖以下参数
* 你也可以直接通过tinkerPatchAllFlavorDebug/tinkerPatchAllFlavorRelease, 一次编译所有的flavor补丁包
* 注意的是:除非你不同的flavor代码是不一样的,不然建议采用zip comment或者文件方式生成渠道信息
**/
productFlavors {
flavor {
flavorName = "protect"
appVersion = "${tinkerpatchSupport.appVersion}_${flavorName}"
pathPrefix = "${bakPath}/${baseInfo}/${flavorName}-${variantName}/"
name = "${project.name}-${flavorName}-${variantName}"
baseApkFile = "${pathPrefix}/${name}.apk"
baseProguardMappingFile = "${pathPrefix}/${name}-mapping.txt"
baseResourceRFile = "${pathPrefix}/${name}-R.txt"
/** 开启加固开关,上传此flavor的apk到加固网站进行加固 **/
protectedApp = true
}
flavor {
flavorName = "flavor1"
appVersion = "${tinkerpatchSupport.appVersion}_${flavorName}"
pathPrefix = "${bakPath}/${baseInfo}/${flavorName}-${variantName}/"
name = "${project.name}-${flavorName}-${variantName}"
baseApkFile = "${pathPrefix}/${name}.apk"
baseProguardMappingFile = "${pathPrefix}/${name}-mapping.txt"
baseResourceRFile = "${pathPrefix}/${name}-R.txt"
}
}
}
/**
* 用于用户在代码中判断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
}
}
/**
* 如果只想在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;
}
}
3、同步工程,会出现几个命令:
assembleFlavor1可以打flavor1的debug和release包, assembleProtect可以打protect的debug和release包
下面tinkerPatchAllFlavorsDebug等是打不同flavor的补丁, 例如flavor1的补丁:
打补丁的时候跟上面讲的相同,选择一个变量,然后通过assembleFlavor1命令打一个flavor包,然后跟上面讲的一样填入这两个值:
def baseInfo = "app-1.0.0-0426-15-27-00"
def variantName = "debug"
注意def variantName只需要填debug或者release就可以了,不需要把全部文件名flavor1-debug写出来,其他的不需要做什么了,然后点击tinkerPatchFlavor1Debug命令来生成补丁。
前面讲过一套代码打包多个工程,通过productFlavors变量来区分, 这里我还是习惯通过变量区分后,再打此变量工程的补丁。
六、对加固的支持
protectedApp = false设置为false表示不支持加固, 设置为true就表示我们线上发布的包必须加固,这个参数设置为true就好,360和应用宝需要加固,其他市场直接上传加固后的包即可。