Android集成Bugly热更新

热更新能力是Bugly为解决开发者紧急修复线上bug,而无需重新发版让用户无感知就能把问题修复的一项能力。Bugly目前采用微信Tinker的开源方案,开发者只需要集成Bugly提供的SDK就可以实现自动下载补丁包、合成、并应用补丁的功能,Bugly也提供了热更新管理后台让开发者对每个版本补丁进行管理。

参考:https://bugly.qq.com/docs/user-guide/instruction-manual-android-hotfix/

Google Play上架注意

由于Google Play政策限制,发布到Google Play上的版本必须在客户端上彻底屏蔽Tinker的热更新能力,请不要使用Tinker,否则可能被检测到违规而导致警告、下架甚至封禁账号等后果。

接入指南

添加插件依赖

工程根目录下build.gradle文件中添加:

1
2
3
4
5
6
7
8
9
10
buildscript {
repositories {
jcenter()
}
dependencies {
//tinkersupport插件
//https://jcenter.bintray.com/com/tencent/bugly/tinker-support/
classpath "com.tencent.bugly:tinker-support:1.2.1"
}
}

集成SDK

gradle配置

在app module的build.gradle文件中添加(示例配置):

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
android {
multiDexEnabled true
defaultConfig {
ndk {
//设置支持的SO库架构
abiFilters 'armeabi' //, 'x86', 'armeabi-v7a', 'x86_64', 'arm64-v8a'
}
}
}

dependencies {
implementation 'androidx.multidex:multidex:2.0.1' //多dex配置
//注释掉原有bugly的仓库
//implementation 'com.tencent.bugly:crashreport:latest.release'
//https://jcenter.bintray.com/com/tencent/bugly/crashreport_upgrade/
implementation 'com.tencent.bugly:crashreport_upgrade:1.4.5'
//指定tinker依赖版本(注:应用升级1.3.5版本起,不再内置tinker)
//https://jcenter.bintray.com/com/tencent/tinker/tinker-android-lib/
implementation 'com.tencent.tinker:tinker-android-lib:1.9.14.7'
//https://jcenter.bintray.com/com/tencent/bugly/nativecrashreport/
implementation 'com.tencent.bugly:nativecrashreport:3.7.471'
}

在app module的build.gradle文件中添加:

1
2
// 依赖插件脚本
apply from: 'tinker-support.gradle'

注:需要在同级目录下创建tinker-support.gradle

tinker-support.gradle配置

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
apply plugin: 'com.tencent.bugly.tinker-support'

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

/*
* 在本类中需要修改:
* 1.baseApkDir
* 2.baseApk
* 3.baseApkProguardMapping
* 4.baseApkResourceMapping
* 5.tinkerId 编号必须一致
*/

/**
* 此处填写每次构建生成的基准包目录
*/
def baseInfo = "app-0208-15-10-00"
def variantName = "debug"

/**
* 对于插件各参数的详细解析请参考
*/
tinkerSupport {

// 开启tinker-support插件,默认值true
enable = true

// 指定归档目录,默认值当前module的子目录tinker
autoBackupApkDir = "${bakPath}"

// 是否启用覆盖tinkerPatch配置功能,默认值false
// 开启后tinkerPatch配置不生效,即无需添加tinkerPatch
overrideTinkerPatchConfiguration = true

def pathPrefix = "${bakPath}/${baseInfo}/${variantName}/"
def name = "${project.name}-${variantName}"

// 编译补丁包时,必需指定基线版本的apk,默认值为空
// 如果为空,则表示不是进行补丁包的编译
// @{link tinkerPatch.oldApk }
baseApk = "${pathPrefix}/${name}.apk"

// 对应tinker插件applyMapping
baseApkProguardMapping = "${pathPrefix}/${name}-mapping.txt"

// 对应tinker插件applyResourceMapping
baseApkResourceMapping = "${pathPrefix}/${name}-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的分配
}
}

更详细的配置项参考 tinker-support配置说明

初始化SDK

enableProxyApplication = false 的情况

这是Tinker推荐的接入方式,一定程度上会增加接入成本,但具有更好的兼容性。

集成Bugly热更新SDK之后,我们需要按照以下方式自定义ApplicationLike来实现Application的代码(以下是示例):

自定义Application
1
2
3
4
5
6
public class SampleApplication extends TinkerApplication {
public SampleApplication() {
super(ShareConstants.TINKER_ENABLE_ALL, "cn.appblog.bugly.app.SampleApplicationLike",
"com.tencent.tinker.loader.TinkerLoader", false);
}
}

注意:这个类集成TinkerApplication类,这里面不做任何操作,所有Application的代码都会放到ApplicationLike继承类当中

参数解析

  • 参数1:tinkerFlags表示Tinker支持的类型dex onlylibrary only or all suuport,default: TINKER_ENABLE_ALL
  • 参数2:delegateClassName Application代理类,这里填写自定义的ApplicationLike
  • 参数3:loaderClassName Tinker的加载器,使用默认即可
  • 参数4:tinkerLoadVerifyFlag 加载dex或者lib是否验证md5,默认为false

记得在AndroidManifest.xml中注册Applicaton配置为继承TinkerApplication的类

1
2
<application
android:name=".app.SampleApplication"
自定义ApplicationLike
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
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);
}
}

注意:Tinker需要开启MultiDex,SampleApplicationLike这个类是Application的代理类,以前所有在Application的实现必须要全部拷贝到这里,在onCreate方法调用SDK的初始化方法,在onBaseContextAttached中调用Beta.installTinker(this)

enableProxyApplication = true 的情况

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
public class MyApplication extends Application {

@Override
public void onCreate() {
super.onCreate();
// 这里实现SDK初始化,appId替换成你的在Bugly平台申请的appId
// 调试时,将第三个参数改为true
Bugly.init(this, "900029763", false);
}

@Override
protected void attachBaseContext(Context base) {
super.attachBaseContext(base);
// you must install multiDex whatever tinker is installed!
MultiDex.install(base);

// 安装tinker
Beta.installTinker();
}

}

注:无须改造Application,主要是为了降低接入成本,Bugly插件会动态替换AndroidMinifest文件中的Application为我们定义好用于反射真实Application的类(需要接入SDK 1.2.2版本 和 插件版本 1.0.3以上)

AndroidManifest.xml配置

AndroidMainfest.xml中进行以下配置:

权限配置

1
2
3
4
5
6
<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配置

1
2
3
4
<activity
android:name="com.tencent.bugly.beta.ui.BetaActivity"
android:configChanges="keyboardHidden|orientation|screenSize|locale"
android:theme="@android:style/Theme.Translucent" />

配置FileProvider

注意:如果APP想兼容Android N或者以上的设备,必须要在AndroidManifest.xml文件中配置FileProvider来访问共享路径的文件

1
2
3
4
5
6
7
8
9
<provider
android:name="androidx.core.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类来解决合并冲突的问题,示例如下:

1
2
3
4
5
6
7
8
9
10
11
<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>

这里要注意一下,FileProvider类是在androidx.appcompat:appcompatsupport-v4包中的,检查工程是否引入该类库

在res目录新建xml文件夹,创建provider_paths.xml文件如下:

1
2
3
4
5
6
7
<?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>

这里配置的两个外部存储路径是升级SDK下载的文件可能存在的路径,一定要按照上面格式配置,不然可能会出现错误

注:1.3.1及以上版本,可以不用进行以上配置,aar已经在AndroidManifest配置,并且包含了对应的资源文件

使用详解

完整接入流程

  • 打基准包安装并上报联网(注:填写唯一的tinkerId
  • 对基准包的bug修复(可以是Java代码变更,资源的变更)
  • 修改基准包路径、修改补丁包tinkerIdmapping文件路径(如果开启了混淆需要配置)、resId文件路径
  • 执行buildTinkerPatchRelease打Release版本补丁包
  • 选择app/build/outputs/patch目录下的补丁包并上传(注:不要选择tinkerPatch目录下的补丁包,不然上传会有问题
  • 编辑下发补丁规则,点击立即下发
  • 杀死进程并重启基准包,请求补丁策略(SDK会自动下载补丁并合成)
  • 再次重启基准包,检验补丁应用结果
  • 查看页面,查看激活数据的变化

Github Demo:https://github.com/BuglyDevTeam/Bugly-Android-Demo

普通打包

编译基准包

(1)配置基准包的tinkerId

配置基准包的tinkerId

tinkerId最好是一个唯一标识,例如Git版本号、versionName等等。如果要测试热更新,需要对基线版本进行联网上报。

这里强调一下,基线版本配置一个唯一的tinkerId,而这个基线版本能够应用补丁的前提是集成过热更新SDK,并启动上报过联网,这样我们后台会将这个tinkerId对应到一个目标版本,例如tinkerId = "bugly_1.0.0"对应了一个目标版本是1.0.0,基于这个版本打的补丁包就能匹配到目标版本。

(2)执行assembleRelease编译生成基准包:

编译基准包

这个会在build/outputs/bakApk路径下生成每次编译的基准包、混淆配置文件、资源Id文件,如下图所示:

基准包目录

实际应用中,请注意保存线上发布版本的基准apk包、mapping文件、R.txt文件,如果线上版本有bug,就可以借助tinker-support插件进行补丁包的生成

(3)启动apk,上报联网数据

我们每次冷启动都会请求补丁策略,会上报当前版本号和tinkerId,这样我们后台就能将这个唯一的tinkerId对应到一个版本,大家测试的时候可以打开logcat查看日志,如下图所示:

基线版本联网上报

如果看不到log,需要将bugly初始化的第三个参数设置为true才能看到。

对基线版本的bug修复

(1)未修复前

未修复前

这个类有一个会造成空指针的方法。

(2)修复后

修复后

对产生bug的类进行修复,作为补丁下次覆盖基线版本的类。

根据基线版本生成补丁包

(1)修改待修复apk路径、mapping文件路径、resId文件路径

修改基线信息

(2)执行构建补丁包的task

执行构建补丁包的task

如果要生成不同编译环境的补丁包,只需要执行TinkerSupport插件生成的task,比如buildTinkerPatchRelease就能生成Release编译环境的补丁包。注:TinkerSupport插件版本低于1.0.4的,需要使用tinkerPatchRelease来生成补丁包 。

生成的补丁包在build/outputs/patch目录下:

生成的补丁包

大家这里可能会有一个疑问,补丁版本是怎么匹配到目标版本的,可以双击patch包,Bugly提供的插件会在Tinker生成的patch包基础上插入一个MF文件:

patch日志

MF文件

上传补丁包到平台

上传补丁包到平台并下发编辑规则

发布新补丁

补丁选择

补丁发布

点击“发布新补丁”,上传前面生成的patch包,Bugly平台会自动匹配到目标版本,可以选择下发范围(开发设备、全量设备、自定义),填写完备注之后,点击立即下发让补丁生效,这样就可以在客户端当中收到我们的策略,SDK会自动把补丁包下到本地。

测试补丁应用效果

启动app应用patch

Bug演示

如果匹配到目标版本,后台就会下发补丁策略,可以在logcat看到如下日志:

补丁下发日志

下载成功之后,Bugly会立即去合成补丁,可以看到patch合成的日志:

patch合成日志

重启app查看效果

重启app查看效果

注:Bugly方案是基于Tinker方案的实现,需要下次启动才能让补丁生效。

多渠道打包

Bugly支持两种方式进行多渠道打包:

gradle配置productFlavors方式
多渠道打包工具打多渠道包方式(推荐)

方法1:gradle配置productFlavors方式

(1)配置productFlavors

1
2
3
4
5
6
7
8
9
10
11
12
13
14
android {
...

// 多渠道打包(示例配置)
productFlavors {
xiaomi {
}

yyb {
}
}

...
}

(2)执行assembleRelease生成基线apk

按照普通打包方式正常配置基线版本的tinkerId,然后执行assembleRelease生成不同渠道的apk,会在工程中build/bakApk/生成如下图所示文件:

多渠道打包

(3)打渠道补丁包配置

多渠道补丁包配置

(4)执行buildAllFlavorsTinkerPatchRelease生成所有渠道补丁包

如下图所示:

多渠道补丁包配置

(5)测试应用补丁包

与普通打包一致。

方法2:多渠道打包工具打多渠道包方式(推荐)

多渠道工具打包方式,参考这篇文章:Bugly多渠道热更新解决方案

加固打包

需要集成升级SDK版本1.3.0以上版本才支持加固。

经过测试的加固产品:

  • 腾讯乐固
  • 爱加密
  • 梆梆加固
  • 360加固(SDK 1.3.1之后版本支持)

其他产品需要大家进行验证。

(1)设置isProtectedApp参数

tinker-support配置中设置isProtectedApp = true,表示要打加固的apk。是否使用加固模式,仅仅将变更的类合成补丁。注意,这种模式仅仅可以用于加固应用中。

(2)将基准包进行加固

如果App需要进行加固,需要将打出的基准包上传到具体的加固平台进行加固,例如乐固,加固完成之后需要对apk进行重签名

1
jarsigner -verbose -keystore <YOUR_KEYSTORE> -signedjar <SIGNED_APK> <UNSIGNED_APK> <KEY_ALIAS>

以上命令说明:

  • -verbose:指定生成详细输出
  • -keystore:指定证书存储路径
  • -signedjar:改选项的三个参数分别为签名后的apk包、未签名的apk包、数字证书别名

示例:

1
jarsigner -verbose -keystore keystore/release.keystore -signedjar app-release-signed.apk app-release.encrypted.apk testres

如果使用的加固产品提供了GUI的加固和签名工具,可以通过工具来进行加固和签名。

(3)根据未加固的基准包生成补丁包

打patch包的操作跟普通打包方式一致。

注意:这里指定的基线版本是未加固的版本。

(4)测试验证

测试验证的版本是经过加固并且已经重签名后的apk,安装到测试设备并上报联网,其他操作与普通打包无异。

Powered by AppBlog.CN     浙ICP备14037229号

Copyright © 2012 - 2021 APP开发技术博客 All Rights Reserved.

访客数 : | 访问量 :