首页 > 程序开发 > 移动开发 > Android >

Android热修复框架Tinker的集成和遇到的问题

2017-04-19

Android热修复框架Tinker的集成和遇到的问题。移动app开发的一个痛点就是遇到了bug只能重新打包,上传各个市场,审核,客户使用app后还会检查更新下载,这样为了修复一个bug而进行的这一套繁琐的操作,成本很高,不管对企业还是对用户都很烦恼。

Android热修复框架Tinker的集成和遇到的问题。移动app开发的一个痛点就是遇到了bug只能重新打包,上传各个市场,审核,客户使用app后还会检查更新下载,这样为了修复一个bug而进行的这一套繁琐的操作,成本很高,不管对企业还是对用户都很烦恼;热修复的需求是很迫切的,近几年热修复的发展也很快,各个龙头企业都推出自己的热修复框架,之前了解过阿里的Dexposed,Andfix,QQ空间团队的Nuwa等等,都有很多不成熟的地方;

什么是 Tinker

Tinker是微信官方的 Android 热补丁解决方案,它支持动态下发代码、So 库以及资源,让应用能够在不需要重新安装的情况下实现更新。Github地址

当前市面的热补丁方案有很多,其中比较出名的有阿里的 AndFix、美团的 Robust 以及 QZone 的超级补丁方案。但它们都存在无法解决的问题,这也是正是我们推出 Tinker 的原因;Tinker热补丁方案不仅支持类、So 以及资源的替换,它还是2.X-7.X的全平台支持。利用Tinker我们不仅可以用做 bugfix,甚至可以替代功能的发布。Tinker 已运行在微信的数亿 Android 设备上,那么为什么你不使用 Tinker 呢?---来自tinker官方介绍(牛**)

接下来是来自官方的截图:

引用块内容

看到这个对比,瞬间就像试一把。

Tinker的集成

添加 gradle 插件依赖

buildscript {

repositories {

jcenter()

}

dependencies {

classpath 'com.android.tools.build:gradle:2.2.2'

classpath "com.tencent.tinker:tinker-patch-gradle-plugin:${TINKER_VERSION}"

// NOTE: Do not place your application dependencies here; they belong

// in the individual module build.gradle files

}

}

${TINKER_VERSION}在gradle.properties中配置

TINKER_VERSION=1.7.7

然后在模块中的gradle添加配置:

apply plugin: 'com.android.application'

dependencies {

compile fileTree(dir: 'libs', include: ['*.jar'])

testCompile 'junit:junit:4.12'

compile "com.android.support:appcompat-v7:23.1.1"

compile("com.tencent.tinker:tinker-android-lib:${TINKER_VERSION}") { changing = true }

provided("com.tencent.tinker:tinker-android-anno:${TINKER_VERSION}") { changing = true }

compile "com.android.support:multidex:1.0.1"

//use to test multiDex

// compile group: 'com.google.guava', name: 'guava', version: '19.0'

// compile "org.scala-lang:scala-library:2.11.7"

//use for local maven test

// compile("com.tencent.tinker:tinker-android-loader:${TINKER_VERSION}") { changing = true }

// compile("com.tencent.tinker:aosp-dexutils:${TINKER_VERSION}") { changing = true }

// compile("com.tencent.tinker:bsdiff-util:${TINKER_VERSION}") { changing = true }

// compile("com.tencent.tinker:tinker-commons:${TINKER_VERSION}") { changing = true }

}

def gitSha() {

try {

// String gitRev = 'git rev-parse --short HEAD'.execute(null, project.rootDir).text.trim()

String gitRev ="1.0.0"

if (gitRev == null) {

throw new GradleException("can't get git rev, you should add git to system path or just input test value, such as 'testTinkerId'")

}

return gitRev

} catch (Exception e) {

throw new GradleException("can't get git rev, you should add git to system path or just input test value, such as 'testTinkerId'")

}

}

def javaVersion = JavaVersion.VERSION_1_7

android {

compileSdkVersion 23

buildToolsVersion "23.0.2"

compileOptions {

sourceCompatibility javaVersion

targetCompatibility javaVersion

}

//recommend

dexOptions {

jumboMode = true

}

signingConfigs {

release {

try {

storeFile file("./keystore/release.keystore")

storePassword "testres"

keyAlias "testres"

keyPassword "testres"

} catch (ex) {

throw new InvalidUserDataException(ex.toString())

}

}

debug {

storeFile file("./keystore/debug.keystore")

}

}

defaultConfig {

applicationId "tinker.sample.android"

minSdkVersion 10

targetSdkVersion 22

versionCode 1

versionName "1.0.0"

/**

* you can use multiDex and install it in your ApplicationLifeCycle implement

*/

multiDexEnabled true

/**

* buildConfig can change during patch!

* we can use the newly value when patch

*/

buildConfigField "String", "MESSAGE", "\"I am the base apk\""

// buildConfigField "String", "MESSAGE", "\"I am the patch apk\""

/**

* client version would update with patch

* so we can get the newly git version easily!

*/

buildConfigField "String", "TINKER_ID", "\"${getTinkerIdValue()}\""

buildConfigField "String", "PLATFORM", "\"all\""

}

// aaptOptions{

// cruncherEnabled false

// }

// //use to test flavors support

// productFlavors {

// flavor1 {

// applicationId 'tinker.sample.android.flavor1'

// }

//

// flavor2 {

// applicationId 'tinker.sample.android.flavor2'

// }

// }

buildTypes {

release {

minifyEnabled true

//signingConfig signingConfigs.release

proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'

}

debug {

debuggable true

minifyEnabled false

//signingConfig signingConfigs.debug

}

}

sourceSets {

main {

jniLibs.srcDirs = ['libs']

}

}

}

def bakPath = file("${buildDir}/bakApk/")

/**

* you can use assembleRelease to build you base apk

* use tinkerPatchRelease -POLD_APK= -PAPPLY_MAPPING= -PAPPLY_RESOURCE= to build patch

* add apk from the build/bakApk

*/

ext {

//for some reason, you may want to ignore tinkerBuild, such as instant run debug build?

tinkerEnabled = true

//for normal build

//old apk file to build patch apk

tinkerOldApkPath = "${bakPath}/app-debug-0418-16-34-14.apk"

//proguard mapping file to build patch apk

tinkerApplyMappingPath = "${bakPath}/app-debug-1018-17-32-47-mapping.txt"

//resource R.txt to build patch apk, must input if there is resource changed

tinkerApplyResourcePath = "${bakPath}/app-debug-0418-16-34-14-R.txt"

//only use for build all flavor, if not, just ignore this field

tinkerBuildFlavorDirectory = "${bakPath}/app-1018-17-32-47"

}

def getOldApkPath() {

return hasProperty("OLD_APK") ? OLD_APK : ext.tinkerOldApkPath

}

def getApplyMappingPath() {

return hasProperty("APPLY_MAPPING") ? APPLY_MAPPING : ext.tinkerApplyMappingPath

}

def getApplyResourceMappingPath() {

return hasProperty("APPLY_RESOURCE") ? APPLY_RESOURCE : ext.tinkerApplyResourcePath

}

def getTinkerIdValue() {

return hasProperty("TINKER_ID") ? TINKER_ID : gitSha()

}

def buildWithTinker() {

return hasProperty("TINKER_ENABLE") ? TINKER_ENABLE : ext.tinkerEnabled

}

def getTinkerBuildFlavorDirectory() {

return ext.tinkerBuildFlavorDirectory

}

if (buildWithTinker()) {

apply plugin: 'com.tencent.tinker.patch'

tinkerPatch {

/**

* necessary,default 'null'

* the old apk path, use to diff with the new apk to build

* add apk from the build/bakApk

*/

oldApk = getOldApkPath()

/**

* optional,default 'false'

* there are some cases we may get some warnings

* if ignoreWarning is true, we would just assert the patch process

* case 1: minSdkVersion is below 14, but you are using dexMode with raw.

* it must be crash when load.

* case 2: newly added Android Component in AndroidManifest.xml,

* it must be crash when load.

* case 3: loader classes in dex.loader{} are not keep in the main dex,

* it must be let tinker not work.

* case 4: loader classes in dex.loader{} changes,

* loader classes is ues to load patch dex. it is useless to change them.

* it won't crash, but these changes can't effect. you may ignore it

* case 5: resources.arsc has changed, but we don't use applyResourceMapping to build

*/

ignoreWarning = false

/**

* optional,default 'true'

* whether sign the patch file

* if not, you must do yourself. otherwise it can't check success during the patch loading

* we will use the sign config with your build type

*/

useSign = true

/**

* optional,default 'true'

* whether use tinker to build

*/

tinkerEnable = buildWithTinker()

/**

* Warning, applyMapping will affect the normal android build!

*/

buildConfig {

/**

* optional,default 'null'

* if we use tinkerPatch to build the patch apk, you'd better to apply the old

* apk mapping file if minifyEnabled is enable!

* Warning:

* you must be careful that it will affect the normal assemble build!

*/

applyMapping = getApplyMappingPath()

/**

* optional,default 'null'

* It is nice to keep the resource id from R.txt file to reduce java changes

*/

applyResourceMapping = getApplyResourceMappingPath()

/**

* necessary,default 'null'

* because we don't want to check the base apk with md5 in the runtime(it is slow)

* tinkerId is use to identify the unique base apk when the patch is tried to apply.

* we can use git rev, svn rev or simply versionCode.

* we will gen the tinkerId in your manifest automatic

*/

tinkerId = getTinkerIdValue()

/**

* if keepDexApply is true, class in which dex refer to the old apk.

* open this can reduce the dex diff file size.

*/

keepDexApply = false

}

dex {

/**

* optional,default 'jar'

* only can be 'raw' or 'jar'. for raw, we would keep its original format

* for jar, we would repack dexes with zip format.

* if you want to support below 14, you must use jar

* or you want to save rom or check quicker, you can use raw mode also

*/

dexMode = "jar"

/**

* necessary,default '[]'

* what dexes in apk are expected to deal with tinkerPatch

* it support * or ? pattern.

*/

pattern = ["classes*.dex",

"assets/secondary-dex-?.jar"]

/**

* necessary,default '[]'

* Warning, it is very very important, loader classes can't change with patch.

* thus, they will be removed from patch dexes.

* you must put the following class into main dex.

* Simply, you should add your own application {@code tinker.sample.android.SampleApplication}

* own tinkerLoader, and the classes you use in them

*

*/

loader = [

//use sample, let BaseBuildInfo unchangeable with tinker

"tinker.sample.android.app.BaseBuildInfo"

]

}

lib {

/**

* optional,default '[]'

* what library in apk are expected to deal with tinkerPatch

* it support * or ? pattern.

* for library in assets, we would just recover them in the patch directory

* you can get them in TinkerLoadResult with Tinker

*/

pattern = ["lib/*/*.so"]

}

res {

/**

* optional,default '[]'

* what resource in apk are expected to deal with tinkerPatch

* it support * or ? pattern.

* you must include all your resources in apk here,

* otherwise, they won't repack in the new apk resources.

*/

pattern = ["res/*", "assets/*", "resources.arsc", "AndroidManifest.xml"]

/**

* optional,default '[]'

* the resource file exclude patterns, ignore add, delete or modify resource change

* it support * or ? pattern.

* Warning, we can only use for files no relative with resources.arsc

*/

ignoreChange = ["assets/sample_meta.txt"]

/**

* default 100kb

* for modify resource, if it is larger than 'largeModSize'

* we would like to use bsdiff algorithm to reduce patch file size

*/

largeModSize = 100

}

packageConfig {

/**

* optional,default 'TINKER_ID, TINKER_ID_VALUE' 'NEW_TINKER_ID, NEW_TINKER_ID_VALUE'

* package meta file gen. path is assets/package_meta.txt in patch file

* you can use securityCheck.getPackageProperties() in your ownPackageCheck method

* or TinkerLoadResult.getPackageConfigByName

* we will get the TINKER_ID from the old apk manifest for you automatic,

* other config files (such as patchMessage below)is not necessary

*/

configField("patchMessage", "tinker is sample to use")

/**

* just a sample case, you can use such as sdkVersion, brand, channel...

* you can parse it in the SamplePatchListener.

* Then you can use patch conditional!

*/

configField("platform", "all")

/**

* patch version via packageConfig

*/

configField("patchVersion", "1.0")

}

//or you can add config filed outside, or get meta value from old apk

//project.tinkerPatch.packageConfig.configField("test1", project.tinkerPatch.packageConfig.getMetaDataFromOldApk("Test"))

//project.tinkerPatch.packageConfig.configField("test2", "sample")

/**

* if you don't use zipArtifact or path, we just use 7za to try

*/

sevenZip {

/**

* optional,default '7za'

* the 7zip artifact path, it will use the right 7za with your platform

*/

zipArtifact = "com.tencent.mm:SevenZip:1.1.10"

/**

* optional,default '7za'

* you can specify the 7za path yourself, it will overwrite the zipArtifact value

*/

// path = "/usr/local/bin/7za"

}

}

List flavors = new ArrayList<>();

project.android.productFlavors.each {flavor ->

flavors.add(flavor.name)

}

boolean hasFlavors = flavors.size() > 0

/**

* bak apk and mapping

*/

android.applicationVariants.all { variant ->

/**

* task type, you want to bak

*/

def taskName = variant.name

def date = new Date().format("MMdd-HH-mm-ss")

tasks.all {

if ("assemble${taskName.capitalize()}".equalsIgnoreCase(it.name)) {

it.doLast {

copy {

def fileNamePrefix = "${project.name}-${variant.baseName}"

def newFileNamePrefix = hasFlavors ? "${fileNamePrefix}" : "${fileNamePrefix}-${date}"

def destPath = hasFlavors ? file("${bakPath}/${project.name}-${date}/${variant.flavorName}") : bakPath

from variant.outputs.outputFile

into destPath

rename { String fileName ->

fileName.replace("${fileNamePrefix}.apk", "${newFileNamePrefix}.apk")

}

from "${buildDir}/outputs/mapping/${variant.dirName}/mapping.txt"

into destPath

rename { String fileName ->

fileName.replace("mapping.txt", "${newFileNamePrefix}-mapping.txt")

}

from "${buildDir}/intermediates/symbols/${variant.dirName}/R.txt"

into destPath

rename { String fileName ->

fileName.replace("R.txt", "${newFileNamePrefix}-R.txt")

}

}

}

}

}

}

project.afterEvaluate {

//sample use for build all flavor for one time

if (hasFlavors) {

task(tinkerPatchAllFlavorRelease) {

group = &#39;tinker&#39;

def originOldPath = getTinkerBuildFlavorDirectory()

for (String flavor : flavors) {

def tinkerTask = tasks.getByName("tinkerPatch${flavor.capitalize()}Release")

dependsOn tinkerTask

def preAssembleTask = tasks.getByName("process${flavor.capitalize()}ReleaseManifest")

preAssembleTask.doFirst {

String flavorName = preAssembleTask.name.substring(7, 8).toLowerCase() + preAssembleTask.name.substring(8, preAssembleTask.name.length() - 15)

project.tinkerPatch.oldApk = "${originOldPath}/${flavorName}/${project.name}-${flavorName}-release.apk"

project.tinkerPatch.buildConfig.applyMapping = "${originOldPath}/${flavorName}/${project.name}-${flavorName}-release-mapping.txt"

project.tinkerPatch.buildConfig.applyResourceMapping = "${originOldPath}/${flavorName}/${project.name}-${flavorName}-release-R.txt"

}

}

}

task(tinkerPatchAllFlavorDebug) {

group = &#39;tinker&#39;

def originOldPath = getTinkerBuildFlavorDirectory()

for (String flavor : flavors) {

def tinkerTask = tasks.getByName("tinkerPatch${flavor.capitalize()}Debug")

dependsOn tinkerTask

def preAssembleTask = tasks.getByName("process${flavor.capitalize()}DebugManifest")

preAssembleTask.doFirst {

String flavorName = preAssembleTask.name.substring(7, 8).toLowerCase() + preAssembleTask.name.substring(8, preAssembleTask.name.length() - 13)

project.tinkerPatch.oldApk = "${originOldPath}/${flavorName}/${project.name}-${flavorName}-debug.apk"

project.tinkerPatch.buildConfig.applyMapping = "${originOldPath}/${flavorName}/${project.name}-${flavorName}-debug-mapping.txt"

project.tinkerPatch.buildConfig.applyResourceMapping = "${originOldPath}/${flavorName}/${project.name}-${flavorName}-debug-R.txt"

}

}

}

}

}

}

注意你如果报了TinkerId找不到错误,问题可能出在这

def gitSha() {

try {

// String gitRev = &#39;git rev-parse --short HEAD&#39;.execute(null, project.rootDir).text.trim()

String gitRev ="1.0.0"

if (gitRev == null) {

throw new GradleException("can&#39;t get git rev, you should add git to system path or just input test value, such as &#39;testTinkerId&#39;")

}

return gitRev

} catch (Exception e) {

throw new GradleException("can&#39;t get git rev, you should add git to system path or just input test value, such as &#39;testTinkerId&#39;")

}

}

gitRev建议是版本号或者是git的版本号,tinkered跟你合并版本有关系

然后就是新建一个SampleApplicationLike继承DefaultApplicationLike

@SuppressWarnings("unused")

@DefaultLifeCycle(application = "com.test.tinkerbuffer.app.SampleApplication",

flags = ShareConstants.TINKER_ENABLE_ALL,

loadVerifyFlag = false)

public class SampleApplicationLike extends DefaultApplicationLike {

private static final String TAG = "Tinker.SampleApplicationLike";

public SampleApplicationLike(Application application, int tinkerFlags, boolean tinkerLoadVerifyFlag,

long applicationStartElapsedTime, long applicationStartMillisTime, Intent tinkerResultIntent) {

super(application, tinkerFlags, tinkerLoadVerifyFlag, applicationStartElapsedTime, applicationStartMillisTime, tinkerResultIntent);

}

/**

* install multiDex before install tinker

* so we don&#39;t need to put the tinker lib classes in the main dex

*

* @param base

*/

@TargetApi(Build.VERSION_CODES.ICE_CREAM_SANDWICH)

@Override

public void onBaseContextAttached(Context base) {

super.onBaseContextAttached(base);

//you must install multiDex whatever tinker is installed!

MultiDex.install(base);

TinkerInstaller.install(this);

}

@TargetApi(Build.VERSION_CODES.ICE_CREAM_SANDWICH)

public void registerActivityLifecycleCallbacks(Application.ActivityLifecycleCallbacks callback) {

getApplication().registerActivityLifecycleCallbacks(callback);

}

}

这个类类似Application类,头部声明的application = “com.test.tinkerbuffer.app.SampleApplication”就是application的名字需要在AndroidManifest.xml配置

然后在MainActivity中翻一个按钮一个文本:设置button的点击事件

bt.setOnClickListener(new View.OnClickListener() {

@Override

public void onClick(View v) {

String path = Environment.getExternalStorageDirectory().getAbsolutePath()+ File.separator+"patch_signed_7zip.apk";

TinkerInstaller.onReceiveUpgradePatch(getApplicationContext(),path);

}

});

运行项目项目

修改MainActivity的文本显示内容,为更改最新内容内容

这里写图片描述

在build-bakApk多出最新的两个文件,然文件名替换到gradle中:

这里写图片描述

进到app 的目录下,cd app

然后执行 grade tinkerPatchDebug,这里需要配置gradle 环境变量(百度)

然后就会多出如下文件

\

在tinkerPatch输出目录build/outputs/tinkerPatch中,我们关心的文件有:

文件名 描述

patch_unsigned.apk 没有签名的补丁包

patch_signed.apk 签名后的补丁包

patch_signed_7zip.apk 签名后并使用7zip压缩的补丁包,也是我们通常使用的补丁包。但正式发布的时候,最好不要以.apk结尾,防止被运营商挟持。

log.txt 在编译补丁包过程的控制台日志

dex_log.txt 在编译补丁包过程关于dex的日志

so_log.txt 在编译补丁包过程关于lib的日志

tinker_result 最终在补丁包的内容,包括diff的dex、lib以及assets下面的meta文件

resources_out.zip 最终在手机上合成的全量资源apk,你可以在这里查看是否有文件遗漏

resources_out_7z.zip 根据7zip最终在手机上合成的全量资源apk

tempPatchedDexes 在Dalvik与Art平台,最终在手机上合成的完整Dex,我们可以在这里查看dex合成的产物。

patch_signed_7zip.apk就是我们需要的文件

将他放到手机SD卡的根目录下,adb push 电脑目录/patch_signed_7zip.apk /storage/emulated/0/patch_signed_7zip.apk

点击按钮,大概2、3秒后程序自己挂掉,然后重启,就发现文本内容改变了;

提示:之前一直更新失败 提示code=-1,发现是自己没有打包使用签名的缘故,配置签名文件后一切正常;

相关文章
最新文章
热点推荐