热更新--bugly集成及注意事项
本文主要是记录了为什么选择bugly, bugly集成过程，使用过程中出现的问题，以及需要注意的事项。
热更新就是动态下发代码，它可以使开发者在不发布新版本的情况下，修复 BUG 和发布功能的一个技术方案。
关于热更新更详细的解读，可以转到文末参考文章第一篇看看。
如何选择热更新方案？
当前市面的热补丁方案有很多，其中比较出名的有阿里的AndFix、阿里Hotfix最新版 (Sophix)、美团的Robust，QZone的超级补丁方案和微信的Tinker。 以下是各个方案的对比：
总的来说:
1. AndFix作为native解决方案，首先面临的是稳定性与兼容性问题，更重要的是它无法实现类替换，它是需要大量额外的开发成本的；
2. Robust兼容性与成功率较高，但是它与AndFix一样，无法新增变量与类只能用做的bugFix方案；
3. Qzone方案可以做到发布产品功能，但是它主要问题是插桩带来Dalvik的性能问题，以及为了解决Art下内存地址问题而导致补丁包急速增大的。
综合而言，阿里的Sophix和腾讯的Tinker是两大热门方案。
Tinker是腾讯开源的热更新方案，不仅支持类、So以及资源的替换，它还是2.X－8.X(1.9.0以上支持8.X)的全平台支持。他们的推荐理由：Tinker已运行在微信的数亿Android设备上，那么为什么你不使用Tinker呢？
Sophix是阿里推出的最新的热更新方案，其产品基于阿里巴巴首创hotpatch技术,提供最细粒度热修复能力，无需等待实时修复应用线上问题。推荐理由：傻瓜式接入，可以实现及时生效。
那我们该如何选择呢？
单单从热更新而言，Sophix可以实现补丁即时生效，不需要应用重启；对应用无侵入，几乎无性能损耗；傻瓜式接入。可以说是理想的选择。笔者也尝试集成Sophix，确实比较简单。具体集成步骤，可以参考阿里云官方文档。
笔者最终还是选择了基于Tinker的bugly进行集成，原因如下：
1.笔者项目中采用了腾讯的乐加固方案，与Tinker同处一系。
2.Tinker方案直接可以通过Android Stuido的gradle生成响应的补丁包，Sophix需要有专门的补丁工具进行生成。
3.基于Tinker的Bugly上传补丁包时会对于上线的基准包进行版本对比，不符合基准包版本的补丁包是不能够上传的（前提是及准备必须联网上报，否者不能上传补丁包）。
4.它是免费的！
基于以上原因，笔者最终选择了Tinker热更新方案，各位可以根据自己的实际情况进行选择。
Tinker简介
微信针对QQ空间超级补丁技术的不足提出了一个提供DEX差量包，整体替换DEX的方案。主要的原理是与QQ空间超级补丁技术基本相同，区别在于不再将patch.dex增加到elements数组中，而是差量的方式给出patch.dex，然后将patch.dex与应用的classes.dex合并，然后整体替换掉旧的DEX，达到修复的目的。
不足的地方：
1. Tinker不支持修改AndroidManifest.xml，Tinker不支持新增四大组件(1.9.0支持新增非export的Activity)；
2. 由于Google Play的开发者条款限制，不建议在GP渠道动态更新代码；
3. 在Android N上，补丁对应用启动时间有轻微的影响；
4. 不支持部分三星android-21机型，加载补丁时会主动抛出"TinkerRuntimeException:checkDexInstall failed"；
5. 对于资源替换，不支持修改remoteView。例如transition动画，notification icon以及桌面图标。
Bugly介绍
Bugly目前采用微信Tinker的开源方案，开发者只需要集成我们提供的SDK就可以实现自动下载补丁包、合成、并应用补丁的功能，我们也提供了热更新管理后台让开发者对每个版本补丁进行管理。 使用Bugly的几大理由： 1.无需关注Tinker是如何合成补丁的 2.无需自己搭建补丁管理后台 3.无需考虑后台下发补丁策略的任何事情 4.无需考虑补丁下载合成的时机，处理后台下发的策略 5.我们提供了更加方便集成Tinker的方式 6.我们通过HTTPS及签名校验等机制保障补丁下发的安全性 7.丰富的下发维度控制，有效控制补丁影响范围 8.我们提供了应用升级一站式解决方案Bugly集成
Bugly集成参考Bugly官方文档。
注：以下部分均来自bugly官网。
第一步：添加插件依赖
工程根目录下“build.gradle”文件中添加：buildscript {
repositories {
jcenter()
}
dependencies {
// tinkersupport插件, 其中lastest.release指拉取最新版本，也可以指定明确版本号，例如1.0.4
classpath "com.tencent.bugly:tinker-support:1.1.5"
}
}
注意：自tinkersupport 1.0.3版本起无需再配tinker插件的classpath。
版本对应关系:
tinker-support 1.1.5 对应 tinker 1.9.9
tinker-support 1.1.2 对应 tinker 1.9.6
tinker-support 1.1.1 对应 tinker 1.9.1
tinker-support 1.0.9 对应 tinker 1.9.0
tinker-support 1.0.8 对应 tinker 1.7.11
tinker-support 1.0.7 对应 tinker 1.7.9
tinker-support 1.0.4 对应 tinker 1.7.7
tinker-support 1.0.3 对应 tinker 1.7.6
tinker-support 1.0.2 对应 tinker 1.7.5（需配置tinker插件的classpath）
第二步：集成SDK
gradle配置 在app module的“build.gradle”文件中添加（示例配置）：android {
defaultConfig {
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:latest.release'//其中latest.release指代最新版本号，也可以指定明确的版本号，例如1.3.4
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
}
后续更新升级SDK时，只需变更配置脚本中的版本号即可。
由于ApplicationLike已彻底与Application隔离，为了避免AndroidNClassLoader继续将相关的类当成loader类而回滚到系统ClassLoader去加载，ApplicationLike、DefaultApplicationLike、ApplicationLifeCycle的包名也做了修改。升级到此版本后请将代码中对这三个类的全名引用中的包名从“com.tencent.tinker.loader.app.XXX”改成“com.tencent.tinker.entry.XXX"
注意： 升级SDK已经集成crash上报功能，已经集成Bugly的用户需要注释掉原来Bugly的jcenter库； 已经配置过符号表的Bugly用户保留原有符号表配置； Bugly SDK（2.1.5及以上版本）已经将Java Crash和Native Crash捕获功能分开，如果想使用NDK库，需要配置： compile 'com.tencent.bugly:nativecrashreport:latest.release'
笔者提示：此次官网又升级了SDK了，并且不再内置tinker了，这与前一个版本1.3.4是有区别的，需要多加注意。
在app module的“build.gradle”文件中添加：
// 依赖插件脚本
apply from: 'tinker-support.gradle'
tinker-support.gradle内容如下所示（示例配置）：
注：您需要在同级目录下创建tinker-support.gradle这个文件哦。
tinker-support.gradle的内容粘过去就行，需要注意的下面有说。
apply plugin: 'com.tencent.bugly.tinker-support'
def bakPath = file("${buildDir}/bakApk/")
/**
* 此处填写每次构建生成的基准包目录
*/
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的分配
}
}
第三步：初始化SDK
分为enableProxyApplication = false 的情况和enableProxyApplication = true 的情况 笔者为了节约改造成本选择了enableProxyApplication = true，即开启反射模式。public class UserApplication extends MultiDexApplication {
@Override
public void onCreate() {
super.onCreate();
initBugly();
}
private void initBugly() {
setStrictMode();
// 设置是否开启热更新能力，默认为true
Beta.enableHotfix = true;
// 设置是否自动下载补丁
Beta.canAutoDownloadPatch = true;
// 设置是否提示用户重启
Beta.canNotifyUserRestart = AppConstant.SHOW_LOG;
// 设置是否自动合成补丁
Beta.canAutoPatch = true;
/**
* 补丁回调接口，可以监听补丁接收、下载、合成的回调
*/
Beta.betaPatchListener = new BetaPatchListener() {
@Override
public void onPatchReceived(String patchFileUrl) {
if(AppConstant.SHOW_LOG) {
Toast.makeText(getApplicationContext(), patchFileUrl, Toast.LENGTH_SHORT).show();
}
}
@Override
public void onDownloadReceived(long savedLength, long totalLength) {
if(AppConstant.SHOW_LOG) {
Toast.makeText(getApplicationContext(), String.format(Locale.getDefault(),
"%s %d%%",
Beta.strNotificationDownloading,
(int) (totalLength == 0 ? 0 : savedLength * 100 / totalLength)), Toast.LENGTH_SHORT).show();
}
}
@Override
public void onDownloadSuccess(String patchFilePath) {
if(AppConstant.SHOW_LOG) {
Toast.makeText(getApplicationContext(), patchFilePath, Toast.LENGTH_SHORT).show();
}
// Beta.applyDownloadedPatch();
}
@Override
public void onDownloadFailure(String msg) {
if(AppConstant.SHOW_LOG) {
Toast.makeText(getApplicationContext(), msg, Toast.LENGTH_SHORT).show();
}
}
@Override
public void onApplySuccess(String msg) {
if(AppConstant.SHOW_LOG) {
Toast.makeText(getApplicationContext(), msg, Toast.LENGTH_SHORT).show();
}
}
@Override
public void onApplyFailure(String msg) {
if(AppConstant.SHOW_LOG) {
Toast.makeText(getApplicationContext(), msg, Toast.LENGTH_SHORT).show();
}
}
@Override
public void onPatchRollback() {
if(AppConstant.SHOW_LOG) {
Toast.makeText(getApplicationContext(), "onPatchRollback", Toast.LENGTH_SHORT).show();
}
//需要添加下面的代码才能实现后台的撤回操作
Beta.cleanTinkerPatch(true);
}
};
long start = System.currentTimeMillis();
// 设置开发设备，默认为false，上传补丁如果下发范围指定为“开发设备”，需要调用此接口来标识开发设备
if(BuildConfig.IS_DEVELOP) {
Bugly.setIsDevelopmentDevice(getApplication(), true);
}
// 这里实现SDK初始化，appId替换成你的在Bugly平台申请的appId,调试时将第三个参数设置为true
Bugly.init(this, BuildConfig.BUGLY_ID, AppConstant.SHOW_LOG);
long end = System.currentTimeMillis();
Log.e("init time--->", end - start + "ms");
}
@TargetApi(9)
protected void setStrictMode() {
StrictMode.setThreadPolicy(new StrictMode.ThreadPolicy.Builder().permitAll().build());
StrictMode.setVmPolicy(new StrictMode.VmPolicy.Builder().detectAll().penaltyLog().build());
}
@Override
protected void attachBaseContext(Context base) {
super.attachBaseContext(base);
MultiDex.install(this);
// 安装tinker
Beta.installTinker();
}
}
**注意：补丁回调接口Beta.betaPatchListener的回调方法onPatchRollback（），这里需要主动调用Beta.cleanTinkerPatch(true)才能实现补丁的回滚。
第四步：AndroidManifest.xml配置
在AndroidMainfest.xml中进行以下配置：- 权限配置
如果只是进行热更新，不进行版本升级，下面的就不需要进行配置。
2. Activity配置
- 配置FileProvider
注意：如果您想兼容Android N或者以上的设备，必须要在AndroidManifest.xml文件中配置FileProvider来访问共享路径的文件。
如果你使用的第三方库也配置了同样的FileProvider, 可以通过继承FileProvider类来解决合并冲突的问题，示例如下：
这里要注意一下，FileProvider类是在support-v4包中的，检查你的工程是否引入该类库。
在res目录新建xml文件夹，创建provider_paths.xml文件如下：
这里配置的两个外部存储路径是升级SDK下载的文件可能存在的路径，一定要按照上面格式配置，不然可能会出现错误。
注：1.3.1及以上版本，可以不用进行以上配置，aar已经在AndroidManifest配置了，并且包含了对应的资源文件。
第五步：混淆配置
为了避免混淆SDK，在Proguard混淆文件中增加以下配置：
在此需要提一下的是tinker-support.gradle文件。**
-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.**{*;}
以上就是集成bugly的主要步骤，同时也可以移步到官方提供的demo处看看：
Bugly Demo
打补丁包需要注意的事项
需要着重注意一下下方红色方框内圈住的地方
总而言之：就是打基准包时，将tinkerId修改为与版本号相关的名称，比如base-1.0.1；打补丁包时，baseApkDir路径修改为之前打的基准包的报名，并且还要将tinkerId修改，比如patch-1.0.1。目的就是要将补丁包patch-1.0.1最终指向要修复的基准包base-1.0.1。
只要搞清楚上面这点就能够很方便的打出相对应基准包的补丁包。
ps:上传补丁包之前，一定要确保基准包已经联网上报（只要一台手机上报过就可以额）。
至于构建多渠道包，就要放开buildAllFlavorsDir = "${bakPath}/${baseApkDir}"，官方也说了，对于渠道较少的可以采用，对于渠道较多的不建议如此采用，但是，目前Bugly只识别在app.gradle中的flavor构建的多渠道打包
// 多渠道打包（示例配置）
productFlavors {
xiaomi {
}
yyb {
}
}
如果你采用了其他多渠道打包框不行了，这点确实比较坑！
如何进行测试？
修复bug容易，关键是如何进行测试呢？ 以下是个人做法，如果有更好的办法，请留言告知，感激不尽。 1、申请两个appkey，一个用于测试，一个用于产品发布。 具体设置如下：buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
buildConfigField("String", "BUGLY_ID", '"aaaaaaaaaa"')//aaaaaaaaaa就是你申请的用于产品发布的appkey
signingConfig signingConfigs.release
}
debug {
buildConfigField("String", "BUGLY_ID", '"bbbbbbbbbb"')//bbbbbbbbbb就是你申请的用于测试的appkey
signingConfig signingConfigs.release
}
}
然后在需要appkey的地方，直接如下用就可以了。
Bugly.init(this, BuildConfig.BUGLY_ID, AppConstant.SHOW_LOG);
2、多渠道包中设置一个渠道的设备为开发设备，这个渠道专门用于产品测试。
具体设置如下：
productFlavors {
baidu {
buildConfigField("boolean", "IS_DEVELOP", "false");
}
//用于产品测试
develop {
buildConfigField("boolean", "IS_DEVELOP", "true");
}
productFlavors.all { flavor ->
//UMENG_CHANNEL_VALUE即为AndroidManifest.xml中的具体值，此值代表统计渠道
flavor.manifestPlaceholders = [UMENG_CHANNEL_VALUE: name]
}
}
然后在bugly初始化的地方进行如下设置：
if(BuildConfig.IS_DEVELOP) {
Bugly.setIsDevelopmentDevice(TinkerManager.getApplication(), true);
}
这样设置的话，我们就可以针对某个线上的基准包进行测试了。
如何对补丁进行撤回
bugly后台在状态与操作中有撤回操作，进行此操作的话，该补丁将不能进行任何编辑，而且已下发补丁的设备将回退到基准包状态。 但是，这个需要在前端，调用如下方法的Beta.cleanTinkerPatch(true);
在bugly给的补丁监听的onPatchRollback方法中调用上面的代码
/**
* 补丁回调接口，可以监听补丁接收、下载、合成的回调
*/
Beta.betaPatchListener = new BetaPatchListener() {
@Override
public void onPatchReceived(String patchFileUrl) {
if(AppConstant.SHOW_LOG) {
Toast.makeText(getApplicationContext(), patchFileUrl, Toast.LENGTH_SHORT).show();
}
}
@Override
public void onDownloadReceived(long savedLength, long totalLength) {
if(AppConstant.SHOW_LOG) {
Toast.makeText(getApplicationContext(), String.format(Locale.getDefault(),
"%s %d%%",
Beta.strNotificationDownloading,
(int) (totalLength == 0 ? 0 : savedLength * 100 / totalLength)), Toast.LENGTH_SHORT).show();
}
}
@Override
public void onDownloadSuccess(String patchFilePath) {
if(AppConstant.SHOW_LOG) {
Toast.makeText(getApplicationContext(), patchFilePath, Toast.LENGTH_SHORT).show();
}
}
@Override
public void onDownloadFailure(String msg) {
if(AppConstant.SHOW_LOG) {
Toast.makeText(getApplicationContext(), msg, Toast.LENGTH_SHORT).show();
}
}
@Override
public void onApplySuccess(String msg) {
if(AppConstant.SHOW_LOG) {
Toast.makeText(getApplicationContext(), msg, Toast.LENGTH_SHORT).show();
}
}
@Override
public void onApplyFailure(String msg) {
if(AppConstant.SHOW_LOG) {
Toast.makeText(getApplicationContext(), msg, Toast.LENGTH_SHORT).show();
}
}
@Override
public void onPatchRollback() {
if(AppConstant.SHOW_LOG) {
Toast.makeText(getApplicationContext(), "onPatchRollback", Toast.LENGTH_SHORT).show();
}
//需要添加下面的代码才能实现后台的撤回操作
Beta.cleanTinkerPatch(true);
}
};
紧盯Tinker
因为bugly是对tinker的进一步封装，所以当tinker有版本升级时，bugly也会进行相应的升级，但是从bugly官方的集成文档上不能及时反应，经过多次查看，发现bugly的官方demo会进行响应的升级，有升级需要的可以多关注bugly官方demo.
踩坑经过
本来集成了bugly，想着能够很高兴的玩耍了。没有想到，准备发第一个bugfix时，遭遇当头一棒，在android4.4.2的手机上报下面的异常：Class ref in pre-verified class resolved to unexpected implementation
...
这是什么鬼。。。
百度一下，有些文章说可能是分包的问题导致的，根据tinker官方给的出现这个问题的解决方法：如果出现Class ref in pre-verified class resolved to unexpected implementation异常, 请确认以下几点：Application中传入ApplicationLike的参数时是否采用字符串而不是Class.getName方式；新的Application是否已经加入到dex loader pattern中; 额外添加到dex loader pattern中类的引用类也需要加载到loader pattern中。
难道是自动分包时出现了问题，然后找dex loader pattern，找分包方案，都没有什么效果，由此我开始怀疑难道是bugly好久没有更新的原因吗？
但是，最终结果不是，还是在tinker的github上面我找到了答案：（加载patch包，出现pre-verified crash）原来是我在tinker-support.gradle设置了启用加固模式isProtectedApp = true，但是在测试时，没有进行加固，直接拿加固前的包进行测试的。改后，果然如此。。。
出现了问题去怎么解决？
因为bugly是对tinker的进一步封装，如果不是本身封装出问题的话，大家都应该去tinker的[github上的网站](https://github.com/Tencent/tinker)上去找找。
先在2标识的搜索框中搜一搜有没有类似的问题及解决方法，如果没有的话，再问tinker的维护人员吧。
注意事项
以下节选部分需要注意的事项，具体请看Bugly Android 热更新常见问题
Q： 是不是每次发版都要保留基准包、混淆配置文件、资源Id文件？
A：当然啦，你不保存基准包，我们打补丁怎么知道要基于哪个版本打补丁？所以建议大家每次发版注意保存基准apk包，还有对应编译生成的mapping文件和R.txt文件
Q：完整的测试流程是怎样的？
A：
* 打基准包安装并上报联网（注：填写唯一的tinkerId）
* 对基准包的bug修复（可以是Java代码变更，资源的变更）
* 修改基准包路径、修改补丁包tinkerId、mapping文件路径（如果开启了混淆需要配置）、resId文件路径
* 执行buildTinkerPatchRelease打Release版本补丁包
* 选择app/build/outputs/patch目录下的补丁包并上传（注：不要选择tinkerPatch目录下的补丁包，不然上传会有问题）
* 编辑下发补丁规则，点击立即下发
* 杀死进程并重启基准包，请求补丁策略（SDK会自动下载补丁并合成）
* 再次重启基准包，检验补丁应用结果
* 查看页面，查看激活数据的变化
Q: 日常调试需要使用instant run，怎么关闭tinker
A：这里分两种情况:
使用反射Application方式接入：可以直接在build.gradle中将apply from: 'tinker-support.gradle’注释掉。
改造Application方式接入：先将tinkerSupport中overrideTinkerPatchConfiguration设置为false 修改成将tinkerSupport中enable设置为false。
Q：你们是怎么定义开发设备的？
A：我们会提供接口Bugly.setIsDevelopmentDevice(getApplicationContext(), true);，我们后台就会将你当前设备识别为开发设备，如果设置为false则非开发设备，我们会根据这个配置进行策略控制。
官方demo
官方demo
参考文章
Android热修复技术原理详解（最新最全版本）
Android热修复技术选型——三大流派解
Android热更新技术的研究与实现
为什么选择tinker