最后更新时间:2019-06-28 16:08:37
http://www.geekqian.com/post/77d53c85.html
项目接入了 Bugly
做 bug
收集分析, 发现 Bugly
还支持接入 Tinker
做热修复功能, 于是尝试接入, 经过测试效果不错, 记录一下.
官方文档地址:
- https://bugly.qq.com/docs/user-guide/instruction-manual-android-hotfix/?v=20180709165613
- https://bugly.qq.com/docs/user-guide/instruction-manual-android-hotfix-demo/?v=20181014122344
以下是接入步骤:
接入准备及配置
添加插件依赖
-
在项目根目录的
build.gradle
中加入依赖:buildscript {
repositories { google() jcenter() } dependencies { // tinkersupport插件, 其中lastest.release指拉取最新版本,也可以指定明确版本号,例如1.1.2 classpath "com.tencent.bugly:tinker-support:1.1.2" }
}
-
在
app module
的build.gradle
中加入以下依赖:// 加入tinker脚本 apply from: 'tinker-support.gradle' android { ... defaultConfig { ... ndk { //设置支持的SO库架构 'x86', 'armeabi-v7a', 'x86_64', 'arm64-v8a', 'armeabi' abiFilters "x86", "armeabi-v7a" } } } dependencies { // --- 热修复依赖 implementation "com.android.support:multidex:1.0.1" // 多dex配置 implementation 'com.tencent.tinker:tinker-android-lib:1.9.6' implementation 'com.tencent.bugly:nativecrashreport:latest.release' implementation 'com.tencent.bugly:crashreport_upgrade:1.3.5' }
-
在
app module
目录下创建文件tinker-support.gradle
, 并粘贴下列内容:apply plugin: 'com.tencent.bugly.tinker-support' def bakPath = file("${buildDir}/bakApk/") /** * 此处填写每次构建生成的基准包目录 */ def baseApkDir = "app-0627-17-57-43" /** * 对于插件各参数的详细解析请参考 */ tinkerSupport { // 开启tinker-support插件,默认值true enable = true // 指定归档目录,默认值当前module的子目录tinker autoBackupApkDir = "${bakPath}" // 是否启用覆盖tinkerPatch配置功能,默认值false // 开启后tinkerPatch配置不生效,即无需添加tinkerPatch overrideTinkerPatchConfiguration = true // 编译补丁包时,必需指定基线版本的apk,默认值为空 // 如果为空,则表示不是进行补丁包的编译 // @{link tinkerPatch.oldApk } baseApk = "${bakPath}/${baseApkDir}/app-release.apk" // 对应tinker插件applyMapping baseApkProguardMapping = "${bakPath}/${baseApkDir}/app-release-mapping.txt" // 对应tinker插件applyResourceMapping baseApkResourceMapping = "${bakPath}/${baseApkDir}/app-release-R.txt" // 构建基准包和补丁包都要指定不同的tinkerId,并且必须保证唯一性 tinkerId = "base_1.0.0" // 构建多渠道补丁时使用 // buildAllFlavorsDir = "${bakPath}/${baseApkDir}" // 是否启用加固模式,默认为false.(tinker-spport 1.0.7起支持) // isProtectedApp = true // 是否开启反射Application模式 enableProxyApplication = false // 是否支持新增非export的Activity(注意:设置为true才能修改AndroidManifest文件) supportHotplugComponent = true } /** * 一般来说,我们无需对下面的参数做任何的修改 * 对于各参数的详细介绍请参考: * https://github.com/Tencent/tinker/wiki/Tinker-%E6%8E%A5%E5%85%A5%E6%8C%87%E5%8D%97 */ tinkerPatch { //oldApk ="${bakPath}/${appName}/app-release.apk" 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 //tinkerId = "1.0.1-base" //applyMapping = "${bakPath}/${appName}/app-release-mapping.txt" // 可选,设置mapping文件,建议保持旧apk的proguard混淆方式 //applyResourceMapping = "${bakPath}/${appName}/app-release-R.txt" // 可选,设置R.txt文件,通过旧apk文件保持ResId的分配 } }
更详细的配置项参考tinker-support配置说明
初始化SDK
-
新建一个
DefaultApplication
并继承TinkerApplication
:package com.ingdan.foxsaasapp.app; import com.tencent.tinker.loader.app.TinkerApplication; import com.tencent.tinker.loader.shareutil.ShareConstants; /** * 描述: 默认继承 TinkerApplication 的 Application * 更新者: * 更新时间: * 更新描述: */ public class DefaultApplication extends TinkerApplication { public DefaultApplication() { // 第二个参数填写自己项目原来的 Application 的路径 super(ShareConstants.TINKER_ENABLE_ALL, "com.xxx.xxx.app.MyApplication", "com.tencent.tinker.loader.TinkerLoader", false); } }
-
把项目中原来的
Application
修改继承自DefaultApplicationLike
:public class MyApplication extends DefaultApplicationLike { public MyApplication(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(); ... // 设置是否为开发设备. 用于下发补丁包时的区分 Bugly.setIsDevelopmentDevice(getApplication(), Config.DEBUG); // 设置Bugly渠道收集, 这里使用的美团 String channel = WalleChannelReader.getChannel(getApplication()); Bugly.setAppChannel(getApplication(), channel); // 第三个参数为 true 则不上报, false 则实时上报 Bugly.init(getApplication(), Config.BUGLY_ID, Config.DEBUG); } @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); // 安装tinker // TinkerManager.installTinker(this); 替换成下面Bugly提供的方法 Beta.installTinker(this); } @TargetApi(Build.VERSION_CODES.ICE_CREAM_SANDWICH) public void registerActivityLifecycleCallback(Application.ActivityLifecycleCallbacks callbacks) { getApplication().registerActivityLifecycleCallbacks(callbacks); } }
-
在AndroidMainfest.xml中进行以下配置:
权限配置
<uses-permission android:name="android.permission.READ_PHONE_STATE" /> <uses-permission android:name="android.permission.INTERNET" /> <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" /> <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" /> <uses-permission android:name="android.permission.READ_LOGS" /> <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
Application配置
<application android:name="com.xxx.app.DefaultApplication" android:allowBackup="true" android:icon="@mipmap/ic_launcher" android:label="@string/app_name" android:theme="@style/AppTheme">
Activity配置
<activity android:name="com.tencent.bugly.beta.ui.BetaActivity" android:configChanges="keyboardHidden|orientation|screenSize|locale" android:theme="@android:style/Theme.Translucent" />
配置FileProvider
<provider android:authorities="${applicationId}.fileProvider" android:name=".provider.MyProvider" android:exported="false" android:grantUriPermissions="true" tools:replace="name,authorities,exported,grantUriPermissions"> <meta-data android:name="android.support.FILE_PROVIDER_PATHS" android:resource="@xml/provider_paths"/> </provider>
如果没有Provider的, 创建一个, 确保
build.gradle
中有加入v4
包依赖:implementation 'com.android.support:support-v4:28.0.0'
之后如下即可:
package com.xxx.provider; import android.support.v4.content.FileProvider; public class MyProvider extends FileProvider { }
-
在res目录新建
xml
文件夹,创建provider_paths.xml
文件, 粘贴内容如下:<?xml version="1.0" encoding="utf-8"?> <paths xmlns:android="http://schemas.android.com/apk/res/android"> <!-- /storage/emulated/0/Download/${applicationId}/.beta/apk--> <external-path name="beta_external_path" path="Download/"/> <!--/storage/emulated/0/Android/data/${applicationId}/files/apk/--> <external-path name="beta_external_files_path" path="Android/data/"/> </paths>
混淆配置
在 proguard-rules.pro
混淆文件中增加以下配置:
-dontwarn com.tencent.bugly.**
-keep public class com.tencent.bugly.**{*;}
# tinker混淆规则
-dontwarn com.tencent.tinker.**
-keep class com.tencent.tinker.** { *; }
-keep class android.support.**{*;}
实践使用
打基准包
在 tinker-support.gradle
文件中找到并修改下列参数 :
// 建议将这个id改为自己项目当前的版本号, 例如: base_2.1.1, 注意id必须是唯一 不可重复的.
tinkerId = "base_2.1.1"
然后使用多渠道打包工具打包, 这里使用美团的 Walle:
gradlew clean assembleReleaseChannels
生成渠道包后使用 adb
命令安装到测试机上:
adb -s emulator-5554 install -r F:\workspace\xxx\app\build\outputs\apk\xxx-v1.1.1-20190627-180127.apk
测试启动并确认正常运行成功后, 开始打补丁包.
打补丁包
先在 APP
首页加句代码弹一个 Toast :
CenterToast.show("已经修复bug的版本!");
接着找到下面的路径:
app/build/bakApk
打开后会看到一个目录, 例如 app-0628-14-28-51
, 如下图:
]
在 tinker-support.gradle
文件中找到并修改下列参数 :
// 把这个变量的值该为上面找到的目录
def baseApkDir = "app-0628-14-28-51"
// 把这个id改为一个不重复的补丁包id, 例如: patch_2.1.1_1
tinkerId = "patch_2.1.1_1"
执行构建补丁包的task, 找到 Android Studio
界面右侧 Gradle
点击打开面板, 找到项目下的 -> :app -> tinker-support -> buildTinkerPatchRelease
, 如图:
构建完成后在路径 app/build/outputs/patch/release
下会产生 3 个 apk
, 其中 patch_signed_7zip.apk
就是打出来的补丁包. 此时, 在 Bugly
管理后台中选择 应用升级 -> 热更新 -> 发布新补丁
:
]]
选择补丁文件上传后, 目标版本会自动识别到你要修复的版本, 再选择下发范围为全量设备, 此处测试过使用 “开发设备” 但是没有生效, 但是使用 “全量设备” 的下发策略生效了. 填写上备注后点击 “立即下发” 即可.
启动 APP , 页面没有发生改变, 这是因为 Tinker
的热更新不是即时的, 需要在检测到补丁包后的下次打开应用时才会生效. 此时再次重启 APP, 果然弹出 Toast
了.
到此接入 Tinker
结束.