Bugly 热修复实操
1. 添加插件依赖
工程根目录下 build.gradle
文件中添加:
// tinkersupport插件, 其中lastest.release指拉取最新版本,也可以指定明确版本号,例如1.0.4
classpath "com.tencent.bugly:tinker-support:latest.release"
2. 集成 SDK
在 app module 的 build.gradle
文件中添加(示例配置):
android => defaultConfig 下面添加 ndk 依赖
ndk {
//设置支持的SO库架构
abiFilters 'armeabi' //, 'x86', 'armeabi-v7a', 'x86_64', 'arm64-v8a'
}
dependencies 下面添加库文件依赖
compile "com.android.support:multidex:1.0.1" // 多dex配置
//注释掉原有bugly的仓库
compile 'com.tencent.bugly:crashreport_upgrade:1.3.6'
// 指定tinker依赖版本(注:应用升级1.3.5版本起,不再内置tinker)
compile 'com.tencent.tinker:tinker-android-lib:1.9.9'
compile 'com.tencent.bugly:nativecrashreport:latest.release' //其中latest.release指代最新版本号,也可以指定明确的版本号,例如2.2.0
3. 创建 tinker-support.gradle
文件
apply plugin: 'com.tencent.bugly.tinker-support'
def bakPath = file("${buildDir}/bakApk/")
/**
* TODO 此处填写每次构建生成的基准包目录
*/
def baseApkDir = "app-0208-15-10-00"
/**
* 对于插件各参数的详细解析请参考
*/
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.1"
// 构建多渠道补丁时使用
// 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的分配
}
}
4. 在 app 的 gradle 文件中添加文件依赖
// 依赖插件脚本
apply from: 'tinker-support.gradle'
5. 创建项目的自定义 Application
在 enableProxyApplication = false 的情况下,自定义 Application,一定程度上会增加接入成本,但具有更好的兼容性。
public class SampleApplication extends TinkerApplication {
public SampleApplication() {
super(ShareConstants.TINKER_ENABLE_ALL, "xxx.xxx.SampleApplicationLike",
"com.tencent.tinker.loader.TinkerLoader", false);
}
}
TODO:
- 修改自定义的 Application 的名称
- 在 manifest 中声明自定义的 application
- 修改上述代码中的 ApplicationLike 的包名
6. 创建项目对应的 ApplicationLike
public class SampleApplicationLike extends DefaultApplicationLike {
public 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);
}
@Override
public void onCreate() {
super.onCreate();
// 这里实现SDK初始化,appId替换成你的在Bugly平台申请的appId
// 调试时,将第三个参数改为true
Bugly.init(getApplication(), "900029763", false);
}
@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);
}
}
TODO
- 修改项目中的
ApplicationLike
的名称 - 在
onCreate
方法中,需要填入自己在 bugly 官网申请的 appId - 在
onCreate
方法中,可以通过Bugly.setIsDevelopmentDevice
方法设置后台下发补丁所需要的设备类型;当然还有一些其他的设置也可以添加
7. AndroidManifest.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" />
Activity 配置
<activity
android:name="com.tencent.bugly.beta.ui.BetaActivity"
android:configChanges="keyboardHidden|orientation|screenSize|locale"
android:theme="@android:style/Theme.Translucent" />
配置 FileProvider
注意:如果您想兼容Android N或者以上的设备,必须要在AndroidManifest.xml文件中配置FileProvider来访问共享路径的文件。
<provider
android:name="android.support.v4.content.FileProvider"
android:authorities="${applicationId}.fileProvider"
android:exported="false"
android:grantUriPermissions="true">
<meta-data
android:name="android.support.FILE_PROVIDER_PATHS"
android:resource="@xml/provider_paths"/>
</provider>
如果你使用的第三方库也配置了同样的FileProvider, 可以通过继承FileProvider类来解决合并冲突的问题,示例如下:
<provider
android:name=".utils.BuglyFileProvider"
android:authorities="${applicationId}.fileProvider"
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"
tools:replace="name,resource"/>
</provider>
8. 混淆配置
# bugly 混淆规则
-dontwarn com.tencent.bugly.**
-keep public class com.tencent.bugly.**{*;}
# tinker混淆规则
-dontwarn com.tencent.tinker.**
-keep class com.tencent.tinker.** { *; }
# 如果使用了 support-v4 包
-keep class android.support.**{*;}
9. 附加操作
以上就是 bugly 的环境配置好了,下面增加一些附加操作,说明清楚 bugly 打补丁的附加步骤。
【声明前提:】,所谓 bugly 补丁,其实就是针对某个版本的 apk 的改进版本,这里我简单称呼需要修复
的版本为 A,修复后
的补丁为 B。
那么,因为 B 是基于 A 来改进的 ,所以 bugly 要求我们先给他 A 版本,然后它用工具给我们生成 B ;在下发 B 的时候,为了识别 A ,特意指定相同的 id。
为了得到 A 版本,我们一般采用的方法是 打基准包 ; 为了这个基准包是签名过的,采用的方法是 自动签名。
为了让 bugly 知道我们的 A 版本的文件位置,修改 tinker-support.gradle 文件中的基准包目录,即 baseApkDir 修改为基准包存放的目录名
为了下发 B 的时候准确识别 A ,要求 A 和 B 具有统一的 tinkerId ,因此修改并统一基准包和补丁的 tinkerId,一般来说使用版本号来写,其实随便叫个名字也行。
下面具体介绍达到上述目的的实操:
打基准包
打基准包前,先修改一下 tinkerId 的名字,这里设置为 tinkerId = "patch-1.0.1"
-
在 app 的 build.gradle 文件中配置 签名信息(android 括号下)
android { signingConfigs { config { keyAlias 'androidkey' keyPassword 'android' storeFile file('C:/Users/Administrator/Desktop/release.keystore') storePassword 'android' } } }
-
在 buildTypes => release 括号下
buildTypes { release { signingConfig signingConfigs.config } }
在 studio 的右侧有 gradle 工具,找到 app => build => assembleRelease ,双击即可生成已签名的 基准包。
如果 tinker-support.gradle 配置成功,则生成的 基准包 会在 app/build/bakApk 目录下,命名方式就是 app-0311-17-47-01 这种类型
打完基准包一定要在真机上联网运行一下,不然生成补丁包的时候会编译出错
修改 tinker-support.gradle 文件中的基准包目录
完成的基准包的目录是 app-0311-17-47-01 ,找到 tinker-support.gradle 文件中的
/**
* 此处填写每次构建生成的基准包目录
*/
def baseApkDir = "app-0208-15-10-00"
这行代码修改为 def baseApkDir = "app-0311-17-47-01"
统一 tinkerId
修改 tinker-support.gradle 文件中的 tinkerId,找到
// 构建基准包和补丁包都要指定不同的tinkerId,并且必须保证唯一性
tinkerId = "base-1.0.1"
因为打基准包时 设置的是 tinkerId = "patch-1.0.1"
,这里保持不变。
修改 bug
一定要 记得修改掉程序里面存在的 bug ,然后在打补丁包,我做测试的时候老容易忘...
打补丁包
在 studio 的右侧有 gradle 工具,找到 app => tinker-support => buildTinkerPatchRelease ,双击即可生成 补丁包。
正常生成的补丁包所在目录为 build/outputs/patch/release ,包的名称为 patch_signed_7zip.apk
,然后到 bugly 里面把 这个包上传就行。
注意:下发范围有三个选项,其中 全量设备 就是全部设备,开发设备 就是开发类型的设备(需要设置过 isDevelopment 属性的),自定义 就是指定 SDK 的运行版本,通过大于小于等于 版本号指定。