TinkerSupport插件使用指南

如果你想使用我们的插件来配置的话,你可以不配置tinker插件的参数,而使用我们提供的参数,具体可以使用的配置项如下所示:

tinker-support插件配置

参数名 默认值 参数说明
enable true 开启tinker-support插件
autoGenerateTinkerId false 自动生成tinkerId
supportHotplugComponent false 是否支持新增activity
targetFileNamePrefix "" 指定输出文件前缀
autoBackupApkDir 'tinker' 指定归档目录,默认值当前module的子目录tinker
overrideTinkerPatchConfiguration false 是否启用覆盖tinkerPatch配置功能,开启后tinkerPatch配置不生效,即无需添加tinkerPatch
baseApk "" 对应tinker插件oldApk,编译补丁包时,必需指定基线版本的apk,默认值为空;如果为空,则表示不是进行补丁包的编译
ignoreWarning false 如果出现以下的情况,并且ignoreWarning为false,我们将中断编译。因为这些情况可能会导致编译出来的patch包带来风险:
1. minSdkVersion小于14,但是dexMode的值为"raw";
2. 新编译的安装包出现新增的四大组件(Activity, BroadcastReceiver...);
3. 定义在dex.loader用于加载补丁的类不在main dex中;
4. 定义在dex.loader用于加载补丁的类出现修改;
5. resources.arsc改变,但没有使用applyResourceMapping编译。
patchSigning true 对应tinker插件userSign, 在运行过程中,我们需要验证基准apk包与补丁包的签名是否一致,我们是否需要为你签名。
baseApkProguardMapping "" 对应tinker插件applyMapping, 可选参数;在编译新的apk时候,我们希望通过保持旧apk的proguard混淆方式,从而减少补丁包的大小。这个只是推荐的,但设置applyMapping会影响任何的assemble编译
baseApkResourceMapping "" 对应tinker插件applyResourceMapping, 可选参数;在编译新的apk时候,我们希望通过旧apk的R.txt文件保持ResId的分配,这样不仅可以减少补丁包的大小,同时也避免由于ResId改变导致remote view异常
tinkerId "" 在运行过程中,我们需要验证基准apk包的tinkerId是否等于补丁包的tinkerId。这个是决定补丁包能运行在哪些基准包上面,一般来说我们可以使用git版本号、versionName等等。
dexMode "jar" 只能是'raw'或者'jar'。
对于'raw'模式,我们将会保持输入dex的格式。
对于'jar'模式,我们将会把输入dex重新压缩封装到jar。如果你的minSdkVersion小于14,你必须选择‘jar’模式,而且它更省存储空间,但是验证md5时比'raw'模式耗时()。
dexPattern ["classes*.dex", "assets/secondary-dex-?.jar"] 需要处理dex路径,支持*、?通配符,必须使用'/'分割。路径是相对安装包的,例如/assets/...
dexLoader ["com.tencent.tinker.loader.*"] 这一项非常重要,它定义了哪些类在加载补丁包的时候会用到。这些类是通过Tinker无法修改的类,也是一定要放在main dex的类。
这里需要定义的类有:
1. 你自己定义的Application类;
2. Tinker库中用于加载补丁包的部分类,即com.tencent.tinker.loader.*;
3. 如果你自定义了TinkerLoader,需要将它以及它引用的所有类也加入loader中;
4. 其他一些你不希望被更改的类,例如Sample中的BaseBuildInfo类。这里需要注意的是,这些类的直接引用类也需要加入到loader中。或者你需要将这个类变成非preverify。
libPattern ["lib/armeabi/*.so"] 需要处理lib路径,支持*、?通配符,必须使用'/'分割。与dex.pattern一致, 路径是相对安装包的,例如/assets/...
resPattern ["res/", "assets/", "resources.arsc", "AndroidManifest.xml"] 需要处理res路径,支持*、?通配符,必须使用'/'分割。与dex.pattern一致, 路径是相对安装包的,例如/assets/...,务必注意的是,只有满足pattern的资源才会放到合成后的资源包
resIgnoreChange ["assets/*_meta.txt"] 支持*、?通配符,必须使用'/'分割。若满足ignoreChange的pattern,在编译时会忽略该文件的新增、删除与修改。 最极端的情况,ignoreChange与上面的pattern一致,即会完全忽略所有资源的修改。
resLargeModSize 100 对于修改的资源,如果大于largeModSize,我们将使用bsdiff算法。这可以降低补丁包的大小,但是会增加合成时的复杂度。默认大小为100kb
configField TINKER_ID, NEW_TINKER_ID configField("key", "value"), 默认我们自动从基准安装包与新安装包的Manifest中读取tinkerId,并自动写入configField。在这里,你可以定义其他的信息,在运行时可以通过TinkerLoadResult.getPackageConfigByName得到相应的数值。但是建议直接通过修改代码来实现,例如BuildConfig。
sevenZipArtifact "com.tencent.mm:SevenZip:1.1.10" 例如"com.tencent.mm:SevenZip:1.1.10",将自动根据机器属性获得对应的7za运行文件,推荐使用。
sevenZipExecutePath "/usr/local/bin/7za" 系统中的7za路径,例如"/usr/local/bin/7za"。path设置会覆盖zipArtifact,若都不设置,将直接使用7za去尝试。
isProtectedApp false 是否使用加固模式,仅仅将变更的类合成补丁。注意,这种模式仅仅可以用于加固应用中。
enableProxyApplication false 是否使用proxy/delegate application 模式