其实网上已经有了很多关于Tinker的使用方法,不过或多或少都是CV大法写的,一看作者就没有用过,为了不误人子弟,亲自使用了一下,特留此文。
零、认识Tinker
阅读链接即可,不多做介绍关于Tinker。
一、注册Android 热更新服务平台
-
1.1 首先打开热更新服务平台,注册一个账号,会送你30天的标准版试用期,不限日请求量,只限流量10G。
-
1.2 注册后,创建一个应用找到自己对应的appKey之后有用。
二、引入插件
-
2.1 在root的build.gradle中添加Tinker插件。
dependencies {
classpath 'com.android.tools.build:gradle:3.0.1'
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
//tinker插件
classpath "com.tinkerpatch.sdk:tinkerpatch-gradle-plugin:1.2.13.3"
}
- 2.2 在app目录下,新建一个tinkerpatch.gradle文件,记得填写你的appKey,并代入如下代码:
apply plugin: 'tinkerpatch-support'
/**
* TODO: 请按自己的需求修改为适应自己工程的参数
* baseInfo之后需要根据基础包不同自己修改
* baseInfo之后需要根据基础包不同自己修改
* baseInfo之后需要根据基础包不同自己修改
*/
def bakPath = file("${buildDir}/bakApk/")
def baseInfo = "app-1.0.0-0903-16-10-28"
def variantName = "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
/**
* 是否使用一键接入功能 默认为false 是否反射 Application 实现一键接入;
* 一般来说,接入 Tinker 我们需要改造我们的 Application, 若这里为 true, 即我们无需对应用做任何改造即可接入。
*/
reflectApplication = false
/**
* 是否开启加固模式,只能在APK将要进行加固时使用,否则会patch失败。
* 如果只在某个渠道使用了加固,可使用多flavors配置
**/
protectedApp = true
/**
* 实验功能
* 补丁是否支持新增 Activity (新增Activity的exported属性必须为false)
**/
supportComponent = true
/**
* 将每次编译产生的 apk/mapping.txt/R.txt 归档存储的位置
*/
autoBackupApkPath = "${bakPath}"
/**
* Tinker平台中所建项目的appKey,
* 需要自己修改
* 需要自己修改
* 需要自己修改
*/
appKey = "5**********5"
/** 注意: 若发布新的全量包, appVersion一定要更新 **/
appVersion = "1.0.0"
def pathPrefix = "${bakPath}/${baseInfo}/${variantName}/"
def name = "app-release"
/**
* 基准包的文件路径, 对应 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
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
}
}
-
2.3 然后在app的build.gradle中引入文件和插件,由于没有用注解,所以没有引入anno,其中api等价于compile,其实这里用implementation也一样,只是因为短,顺手写的。
apply plugin: 'com.android.application'
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-android-extensions'
apply plugin: 'kotlin-kapt'
apply from: 'tinkerpatch.gradle'
android {
compileSdkVersion rootProject.ext.android.compileSdkVersion
buildToolsVersion rootProject.ext.android.buildToolsVersion
defaultConfig {
applicationId rootProject.ext.android.applicationId
minSdkVersion rootProject.ext.android.minSdkVersion
targetSdkVersion rootProject.ext.android.targetSdkVersion
versionName rootProject.ext.android.versionName
versionCode rootProject.ext.android.versionCode
ndk {
//设置支持的SO库架构
abiFilters 'armeabi-v7a' //, 'x86', 'armeabi-v7a', 'x86_64', 'arm64-v8a'
}
}
signingConfigs {
config {
storeFile file("./baseProject.jks")
keyAlias "****"
keyPassword "****"
storePassword "****"
}
}
buildTypes {
release {
// 不显示Log
buildConfigField "boolean", "LOG_DEBUG", "false"
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
signingConfig signingConfigs.config
}
debug {
// 不显示Log
buildConfigField "boolean", "LOG_DEBUG", "true"
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
signingConfig signingConfigs.config
}
}
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
}
dependencies {
implementation project(':lib_business')
implementation fileTree(dir: 'libs', include: ['*.jar'])
implementation "org.jetbrains.kotlin:kotlin-stdlib-jre7:$kotlin_version"
//黄油刀
implementation rootProject.ext.dependencies.butterknife
kapt rootProject.ext.dependencies.butterknifeCompiler
implementation rootProject.ext.dependencies.constraintLayout
// 若使用annotation需要单独引用,对于tinker的其他库都无需再引用
// provided("com.tinkerpatch.tinker:tinker-android-anno:1.9.13.3"){ changing = true }
api("com.tinkerpatch.sdk:tinkerpatch-android-sdk:1.2.13.3") { changing = true }
}
三、Application改造
- 3.1 插件都顺利引入后,建议reflectApplication设置为false,通过改造Application来接入Tinker,避免一些反射接入引起的异常。
/**
* 是否使用一键接入功能 默认为false 是否反射 Application 实现一键接入;
* 一般来说,接入 Tinker 我们需要改造我们的 Application,
* 若这里为 true, 即我们无需对应用做任何改造即可接入。
*/
reflectApplication = false
既然reflectApplication设置为false了,就需要改造自己的Application了,改造内容也不多,首先创建自己的自定义MyAppTinkerLike类继承于DefaultApplicationLike,可以把自己的Application初始化内容都搬到这个类中,
类代码如下:
package com.guyj.baseproject.application;
import android.annotation.TargetApi;
import android.app.Application;
import android.content.Context;
import android.content.Intent;
import android.os.Build;
import android.support.multidex.MultiDex;
import com.guyj.baseproject.BuildConfig;
import com.guyj.lib_common.utils.LogUtils;
import com.tencent.bugly.Bugly;
import com.tencent.tinker.entry.DefaultApplicationLike;
import com.tencent.tinker.lib.listener.DefaultPatchListener;
import com.tencent.tinker.lib.patch.UpgradePatch;
import com.tencent.tinker.lib.reporter.DefaultLoadReporter;
import com.tencent.tinker.lib.reporter.DefaultPatchReporter;
import com.tencent.tinker.lib.service.PatchResult;
import com.tinkerpatch.sdk.TinkerPatch;
import com.tinkerpatch.sdk.server.callback.ConfigRequestCallback;
import com.tinkerpatch.sdk.server.callback.RollbackCallBack;
import com.tinkerpatch.sdk.server.callback.TinkerPatchRequestCallback;
import com.tinkerpatch.sdk.tinker.callback.ResultCallBack;
import com.tinkerpatch.sdk.tinker.service.TinkerServerResultService;
import java.util.HashMap;
/**
* Created by guyj on 2019/7/24.
* 描述: 自定义Tinker App类
*/
public class MyAppTinkerLike extends DefaultApplicationLike {
public MyAppTinkerLike(Application application, int tinkerFlags, boolean tinkerLoadVerifyFlag, long applicationStartElapsedTime, long applicationStartMillisTime, Intent tinkerResultIntent) {
super(application, tinkerFlags, tinkerLoadVerifyFlag, applicationStartElapsedTime, applicationStartMillisTime, tinkerResultIntent);
}
@Override
public void onCreate() {
super.onCreate();
initTinker();
//此处引入了bugly
Bugly.init(getApplication(), "4******7", BuildConfig.DEBUG);
}
/**
* install multiDex before install tinker
* so we don't need to put the tinker lib classes in the main dex
*/
@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);
}
private void initTinker() {
if (BuildConfig.TINKER_ENABLE) {
//开始检查是否有补丁,这里配置的是每隔访问3小时服务器是否有更新。
TinkerPatch.init(this)
.reflectPatchLibrary()
.setPatchRollbackOnScreenOff(true)//支持锁屏时回滚补丁
.setPatchRestartOnSrceenOff(true)//支持锁屏时更新补丁
.setFetchPatchIntervalByHours(3);
// 获取当前的补丁版本
LogUtils.d("current patch version is " + TinkerPatch.with().getPatchVersion());
//每隔3个小时去访问后台时候有更新,通过handler实现轮训的效果
TinkerPatch.with().fetchPatchUpdateAndPollWithInterval();
}
}
/**
* 在这里给出TinkerPatch的所有接口解释,其实没有调用
* 更详细的解释请参考:http://tinkerpatch.com/Docs/api
*/
private void useSample() {
TinkerPatch.init(this)
//是否自动反射Library路径,无须手动加载补丁中的So文件
//注意,调用在反射接口之后才能生效,你也可以使用Tinker的方式加载Library
.reflectPatchLibrary()
//向后台获取是否有补丁包更新,默认的访问间隔为3个小时
//若参数为true,即每次调用都会真正的访问后台配置
.fetchPatchUpdate(false)
//设置访问后台补丁包更新配置的时间间隔,默认为3个小时
.setFetchPatchIntervalByHours(3)
//向后台获得动态配置,默认的访问间隔为3个小时
//若参数为true,即每次调用都会真正的访问后台配置
.fetchDynamicConfig(new ConfigRequestCallback() {
@Override
public void onSuccess(HashMap hashMap) {
}
@Override
public void onFail(Exception e) {
}
}, false)
//设置访问后台动态配置的时间间隔,默认为3个小时
.setFetchDynamicConfigIntervalByHours(3)
//设置当前渠道号,对于某些渠道我们可能会想屏蔽补丁功能
//设置渠道后,我们就可以使用后台的条件控制渠道更新
.setAppChannel("default")
//屏蔽部分渠道的补丁功能
.addIgnoreAppChannel("googleplay")
//设置tinkerpatch平台的条件下发参数
.setPatchCondition("test", "1")
//设置补丁合成成功后,锁屏重启程序
//默认是等应用自然重启
.setPatchRestartOnSrceenOff(true)
//我们可以通过ResultCallBack设置对合成后的回调
//例如弹框什么
.setPatchResultCallback(new ResultCallBack() {
@Override
public void onPatchResult(PatchResult patchResult) {
// Log.i(TAG, "onPatchResult callback here");
}
})
//设置收到后台回退要求时,锁屏清除补丁
//默认是等主进程重启时自动清除
.setPatchRollbackOnScreenOff(true)
//我们可以通过RollbackCallBack设置对回退时的回调
.setPatchRollBackCallback(new RollbackCallBack() {
@Override
public void onPatchRollback() {
// Log.i(TAG, "onPatchRollback callback here");
}
});
}
/**
* 自定义Tinker类的高级用法,一般不推荐使用,其实没有调用
* 更详细的解释请参考:http://tinkerpatch.com/Docs/api
*/
private void complexSample() {
TinkerPatch.Builder builder = new TinkerPatch.Builder(this);
//修改tinker的构造函数,自定义类
builder.listener(new DefaultPatchListener(getApplication())).loadReporter(new DefaultLoadReporter(getApplication())).patchReporter(new DefaultPatchReporter(getApplication())).resultServiceClass(TinkerServerResultService.class).upgradePatch(new UpgradePatch()).patchRequestCallback(new TinkerPatchRequestCallback());
TinkerPatch.init(builder.build());
}
}
-
3.2 接着在自己的自定义Application类中添加如下代码:
package com.guyj.baseproject.application;
import com.tencent.tinker.loader.app.TinkerApplication;
import com.tencent.tinker.loader.shareutil.ShareConstants;
/**
* Created by guyj on 2019/8/30.
* 描述:
*/
public class MyApplication extends TinkerApplication {
public MyApplication() {
super(ShareConstants.TINKER_ENABLE_ALL
, MyAppTinkerLike.class.getName()
, "com.tencent.tinker.loader.TinkerLoader"
, false);
}
}
四、Build基础包与补丁
-
4.1 以上步骤都顺利完成的话,如果不顺利就仔细看下文档或者谷歌下,此时我们打开as右侧的gradle找到root下的Tasks,点开build,找到assembleRelease双击,就会开始打app基础包。
-
4.2 基础包顺利打完,可以在如下目录找到你的apk基础包。
-
4.3 目录中的1.0.0对应的是你的版本,0904-14-09-06是你的打包时间,当你需要基于这个基础包打补丁包时,请到你app目录下的tinkerpatch.gradle进行修改,请参考下图不同颜色的箭头修改好对应的参数value,如果你是黑白屏幕,就看两两对应的箭头指向也行。
-
4.4 当你的tinkerpatch.gradle也按照上面的要求修改完参数后,再回到右侧的gradle面板,找到tinkerPatchRelease打补丁包。
-
4.5 如果补丁包顺利打完,找到如图所示对应位置的7zip包,这里就是你对应的补丁包。
-
4.6 现在基础包,补丁包都已经准备好了,打开热更新服务平台,进入自己的app管理页,选择补丁下发,添加APP版本。
-
4.7 这里的版本对应上文中基础包的appVersion=1.0.0。
-
4.8 点击你的1.0.0版本。
-
4.9 进入到发布补丁页面。
-
4.10 选择刚才的7zip.apk补丁包,并填写描述,选择对应的补丁下发方式,具体这里不表,可自行查看官方文档。
-
4.11 最终你的补丁就发布成功了,然后你可以强杀APP进程,或者根据你的实际配置锁屏后再点亮,就会热更新成功了
五、完结
希望上文对你有所帮助,顺便欢迎在上海的安卓开发,来我的Q群一起交流沟通开发与面试经验与互相内推,上海android互推面试 群号:465532338。