Tinker是腾讯推出的一种热修方案,下面介绍一下Tinker的接入步骤。
一、在工程的 build.gradle添加远程仓库依赖 jcenter
buildscript {
repositories {
jcenter()
}
dependencies {
// TinkerPatch 插件
classpath "com.tinkerpatch.sdk:tinkerpatch-gradle-plugin:1.2.2"
}
}
二、在app/build.gradle引用Tinker的sdk
dependencies {
// 若使用annotation需要单独引用,对于tinker的其他库都无需再引用
implementation "com.android.support:multidex:1.0.1"
provided("com.tinkerpatch.tinker:tinker-android-anno:1.9.5")
compile("com.tinkerpatch.sdk:tinkerpatch-android-sdk:1.2.5")
}
android {
defaultConfig {
//为热修复添加
javaCompileOptions { annotationProcessorOptions { includeCompileClasspath = true } }
}
}
三、在app/build.gradle同级目录下新建一个tinkerpatch.gradle文件,用于热修复配置。
apply plugin: 'tinkerpatch-support'
/**
* TODO: 请按自己的需求修改为适应自己工程的参数
*/
//bakPath:基包路径
//baseInfo:基包文件夹名(打补丁包的时候,需要修改)
//variantName:具体文件夹名(存放apk文件)
def bakPath = file("${buildDir}/bakApk/")
def baseInfo = "app-1.0.0-0328-17-53-06"
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 = false
autoBackupApkPath = "${bakPath}"
appKey = "应用的appKey"
/** 注意: 若发布新的全量包, 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"
/**
* (可选)重命名备份文件的格式化字符串,默认为'${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;
}
}
四、在app/build.gradle中引入tinkerpatch.gradle
//热修复
apply from: 'tinkerpatch.gradle'
五、在app/build.gradle中配置打包的签名文件相关信息
signingConfigs {
debug {
storeFile file("text.jks")
storePassword "123456"
keyAlias "text"
keyPassword "123456"
v2SigningEnabled false
}
release {
storeFile file("text.jks")
storePassword "123456"
keyAlias "text"
keyPassword "123456"
v2SigningEnabled false
}
}
六、在AndroidMainfest.xml中声明必要的权限
七、在Application类中初始化Tinker组件
/**
* 我们需要确保至少对主进程跟patch进程初始化 TinkerPatch
*/
private void initTinkerPatch() {
// 我们可以从这里获得Tinker加载过程的信息
tinkerApplicationLike = TinkerPatchApplicationLike.getTinkerPatchApplicationLike();
// 初始化TinkerPatch SDK, 更多配置可参照API章节中的,初始化SDK
TinkerPatch.init(tinkerApplicationLike)
.reflectPatchLibrary()
.setPatchRollbackOnScreenOff(true)
.setPatchRestartOnSrceenOff(true)
.setFetchPatchIntervalByHours(3);
// 每隔3个小时(通过setFetchPatchIntervalByHours设置)去访问后台时候有更新,通过handler实现轮训的效果
TinkerPatch.with().fetchPatchUpdateAndPollWithInterval();
}
八、正常打包会在app/build/bakApk目录下生成基础包(生成补丁的基础)
基包位置如下图所示,在上线后需要对基包文件夹进行备份,后续生成补丁包需要用到
image
九、生成补丁包
在Gradle中找到tinkerPatchRelease执行生成补丁包
image
补丁包位置如下图
image
十、发布补丁包
添加版本
image
image
上传补丁包
image
至此整个的Tinker热修复从集成到发布补丁的简要过程已经全部完成了,更详细的过程请参考Tinker官方文档