Android-第三方开源框架：Bugly让热修复变得如此简单

最新推荐文章于 2024-08-04 19:46:43 发布

2401_84121980

最新推荐文章于 2024-08-04 19:46:43 发布

阅读量259

点赞数 5

分类专栏：程序员文章标签： android 开源

本文链接：https://blog.csdn.net/2401_84121980/article/details/138085694

版权

程序员专栏收录该内容

186 篇文章 0 订阅

订阅专栏

def baseApkDir = “tinker-bugly-1211-16-01-34”

def myTinkerId = “base-” + rootProject.ext.android.versionName // 用于生成基准包（不用修改）

//def myTinkerId = “patch-” + rootProject.ext.android.versionName + “.0.0” // 用于生成补丁包（每次生成补丁包都要修改一次，最好是 patch-${versionName}.x.x）

/**

对于插件各参数的详细解析请参考

tinkerSupport {

// 开启tinker-support插件，默认值true

enable = true

// 是否启用加固模式，默认为false.(tinker-spport 1.0.7起支持）

// isProtectedApp = true

// 是否开启反射Application模式

enableProxyApplication = true

// 是否支持新增非export的Activity（注意：设置为true才能修改AndroidManifest文件）

supportHotplugComponent = 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 = “${myTinkerId}”

// 构建多渠道补丁时使用

// buildAllFlavorsDir = “ ${bakPath}/$ {baseApkDir}”

}

/**

一般来说,我们无需对下面的参数做任何的修改
对于各参数的详细介绍请参考:
https://github.com/Tencent/tinker/wiki/Tinker-%E6%8E%A5%E5%85%A5%E6%8C%87%E5%8D%97

tinkerPatch {

…

}

1、overrideTinkerPatchConfiguration

当overrideTinkerPatchConfiguration = true时，tinkerPatch可以省略不写，Bugly会加载默认的Tinker配置。但请注意，如果你的so文件不是存放在libs目录下（与src目录同级），又或者资源文件的存放在你自定义的目录中，那么这时你要小心了，这些文件在制作补丁包时不会被检测，也就是说这些so文件和资源文件将不会被热修复，这种情况下就需要将overrideTinkerPatchConfiguration = false，并设置tinkerPatch的lib和res属性。

其它具体的配置与说明可以查看「Tinker-接入指南」。

2、baseApkDir

baseApkDir是基准包（也称基线包）的目录，在生产补丁时需要根据基准包在bakApk下具体文件夹名字修改，如：bakApk/xxxx，到时生成补丁包时要将baseApkDir的值改为xxxx。（xxxx是Tinker自动生成的，根据时间戳来命名）。

3、tinkerId

tinkerId是Bugly热修复方案最最重要的一个因素，一般取值为git版本号、versionName等等（我习惯用versionName），它会将补丁包与基准包产生对应关系，假设基准包的tinkerId为 base-1.0，则生成的补丁包中的YAPATCH.MF文件关系如下：

Bugly要求baseApk（基准包）的tinkerId与补丁包的tinkerId要不一样。所以，在生成基准包时，请用如下tinkerId：

def myTinkerId = “base-” + rootProject.ext.android.versionName // 用于生成基准包（不用修改）

当生成补丁包时，请使用如下tinkerId：

def myTinkerId = “patch-” + rootProject.ext.android.versionName + “.0.0” // 用于生成补丁包（每次生成补丁包都要修改一次，最好是 patch-${versionName}.x.x）

对于同一个基准包，我们可能会多次生成补丁包上传到Bugly的热修复管理后台，这时，这些补丁包的tinkerId也要不一样，不然的话，当客户手机上的App在获取补丁时，会错乱（亲测，当同个基准包的补丁包的tinkerId一样时，App每次重启都会获取不同的补丁包，导致tinkerId相同的补丁包轮流下发）。所以，“patch-” + rootProject.ext.android.versionName + “.0.0"中的”.0.0"（称为计数）就是为了区分每次生成的补丁包，如.0.1，.0.2等等，建议versionName更新时计数重置。

因为Tinker的配置放在了tinker-support.gradle文件中，与app的build.gradle不在同一个文件中，所以没办法通过android.defaultConfig.versionName直接获取App的versionName，这里我使用了config.gradle来提取共同的属性，rootProject.ext.android.versionName获取的是config.gradle中的versionName属性，详情请百度。

4、补丁新旧判定

def myTinkerId = “patch-” + rootProject.ext.android.versionName + “.0.0” // 用于生成补丁包（每次生成补丁包都要修改一次，最好是 patch-${versionName}.x.x）

对于一个基准包，可以在Bugly上发布多个补丁包（切记tinkerid不同），这里或许会让你误以为计数越大，表明补丁越新，这是错误的，这个计数仅仅只是区分不同的补丁包而已，它没有标记补丁新旧的作用，补丁新旧由Bugly来判定，最后上传的补丁便是最新的补丁，举个例子，我在昨天上传了tinkerid为"patch-1.0.0.9"的补丁1，在今天上传了tinkerid为"patch-1.0.0.1"的补丁2，虽然补丁2的计数比补丁1小，但补丁2比补丁1晚上传，所以补丁2是最新的补丁，即补丁新旧与计数无关。Bugly会下发并应用最新的补丁（即补丁2），但还是建议计数从小到大计算，这里仅仅只是说明Bugly如何判定补丁新旧罢了。

五、初始化SDK

========

Bugly的初始化工作需要在Application中完成，但对原生Tinker来说，默认的Application是无法实现热修复的。看过Tinker官方Wiki的人应该知道，Tinker针对Application无法热修复的问题，给予开发者两个选择，分别是：

使用「继承TinkerApplication + DefaultApplicationLike」。
使用「DefaultLifeCycle注解 + DefaultApplicationLike」。

这2种选择都需要对自定义的Application进行改造，对于自定义Application代码不多的情况来说还可以接受，但有些情况还是比较"讨厌"这2种选择的，对此，Bugly给出了它的2种解决方法，分别如下：

使用原来的自定义Application，Bugly通过反射为App动态生成新的Application。
使用「继承TinkerApplication + DefaultApplicationLike」。

DefaultLifeCycle注解在Bugly中被阉割了。

分别对应tinker-support.gradle文件中enableProxyApplication的值：true或false。

1、enableProxyApplication = true

Bugly将通过反射的方式针对项目中自定义的Application动态生成新的Application，下图是源码中的AndroidManifest.xml和编译好的apk中的AndroidManifest.xml：

既然将enableProxyApplication的值设置为true，那接下来的重点就是完成Bugly的初始化工作了。需要在自定义的Application的onCreate()中进行Bugly的配置，在attachBaseContext()中进行Bugly的安装：

public class MyApplication extends Application {

private Context mContext;

@Override

public void onCreate() {

super.onCreate();

mContext = getApplicationContext();

// 这里实现SDK初始化，appId替换成你的在Bugly平台申请的appId

// 调试时，将第三个参数改为true

configTinker();

}

@Override

protected void attachBaseContext(Context base) {

super.attachBaseContext(base);

// you must install multiDex whatever tinker is installed!

MultiDex.install(mContext);

// 安装tinker

// 此接口仅用于反射Application方式接入。

Beta.installTinker();

}

注意：

Bugly的安装必须在attachBaseContext()方法中，否则将无法从Bugly服务器获取最新补丁。

tinker需要你开启MultiDex,你需要在dependencies中进行配置compile "com.android.support:multidex:1.0.1"才可以使用MultiDex.install方法。

最后在清单文件中，声明使用我们自定义的Application即可：

<application

android:name=“com.lqr.MyApplication”

…>

2、enableProxyApplication = false

这是Bugly推荐的方式，稳定性有保障（因为第1种方式使用的是反射，可能会存在不稳定的因素），它需要对Application进行改造，首先就是继承TinkerApplication，然后在默认的构造函数中，将第2个参数修改为你项目中的ApplicationLike继承类的全限定名称：

public class SampleApplication extends TinkerApplication {

public SampleApplication() {

super(ShareConstants.TINKER_ENABLE_ALL, “com.lqr.SampleApplicationLike”,

“com.tencent.tinker.loader.TinkerLoader”, false);

}

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

参数解析

参数1：tinkerFlags 表示Tinker支持的类型 dex only、library only or all suuport，default: TINKER_ENABLE_ALL

参数2：delegateClassName Application代理类这里填写你自定义的ApplicationLike

参数3：loaderClassName Tinker的加载器，使用默认即可

参数4：tinkerLoadVerifyFlag 加载dex或者lib是否验证md5，默认为false

接着就是创建ApplicationLike继承类：

public class SampleApplicationLike extends DefaultApplicationLike {

public static final String TAG = “Tinker.SampleApplicationLike”;

private Application mContext;

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();

mContext = getApplication();

configTinker();

}

@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

Beta.installTinker(this);

}

@TargetApi(Build.VERSION_CODES.ICE_CREAM_SANDWICH)

public void registerActivityLifecycleCallback(Application.ActivityLifecycleCallbacks callbacks) {

getApplication().registerActivityLifecycleCallbacks(callbacks);

}

@Override

public void onTerminate() {

super.onTerminate();

Beta.unInit();

}

注意：

SampleApplicationLike这个类是Application的代理类，以前所有在Application的实现必须要全部拷贝到这里，在onCreate方法调用SDK的初始化方法，在onBaseContextAttached中调用Beta.installTinker(this)。

最后在清单文件中，声明改造好的Application（注意不是ApplicationLike）：

<application

android:name=“com.lqr.SampleApplication”

…>

3、配置Bugly

这是Bugly官方给出的配置，应有尽有，注释也很nice，请仔细看看，对项目的功能拓展与用户体验有帮助：

private void configTinker() {

// 设置是否开启热更新能力，默认为true

Beta.enableHotfix = true;

// 设置是否自动下载补丁，默认为true

Beta.canAutoDownloadPatch = true;

// 设置是否自动合成补丁，默认为true

Beta.canAutoPatch = true;

// 设置是否提示用户重启，默认为false

Beta.canNotifyUserRestart = true;

// 补丁回调接口

Beta.betaPatchListener = new BetaPatchListener() {

@Override

public void onPatchReceived(String patchFile) {

Toast.makeText(mContext, “补丁下载地址” + patchFile, Toast.LENGTH_SHORT).show();

}

@Override

public void onDownloadReceived(long savedLength, long totalLength) {

Toast.makeText(mContext,

String.format(Locale.getDefault(), “%s %d%%”,

Beta.strNotificationDownloading,

(int) (totalLength == 0 ? 0 : savedLength * 100 / totalLength)),

Toast.LENGTH_SHORT).show();

}

@Override

public void onDownloadSuccess(String msg) {

Toast.makeText(mContext, “补丁下载成功”, Toast.LENGTH_SHORT).show();

}

@Override

public void onDownloadFailure(String msg) {

Toast.makeText(mContext, “补丁下载失败”, Toast.LENGTH_SHORT).show();

}

@Override

public void onApplySuccess(String msg) {

Toast.makeText(mContext, “补丁应用成功”, Toast.LENGTH_SHORT).show();

}

@Override

public void onApplyFailure(String msg) {

Toast.makeText(mContext, “补丁应用失败”, Toast.LENGTH_SHORT).show();

}

@Override

public void onPatchRollback() {

}

};

// 设置开发设备，默认为false，上传补丁如果下发范围指定为“开发设备”，需要调用此接口来标识开发设备

Bugly.setIsDevelopmentDevice(mContext, false);

// 多渠道需求塞入

// String channel = WalleChannelReader.getChannel(getApplication());

// Bugly.setAppChannel(getApplication(), channel);

// 这里实现SDK初始化，appId替换成你的在Bugly平台申请的appId

Bugly.init(mContext, “e9d0b7f57f”, true);

}

这里就用到了一开始获取到的App ID了，将其传入Bugly.init()方法的第二个参数，切记，用你自己的App ID。

其中如下两个方法很重要：

Bugly.setIsDevelopmentDevice()

设置当前设备是不是开发设备，这跟Bugly上传补丁包时所选的"下发范围"有关。

Bugly.init(context, appid, isDebug)

这个方法除了设置App ID外，还可以设置是否输出Log，可以观察到Bugly在App启动时做了哪些联网操作。

六、AndroidManifest.xml

=====================

1、权限配置

2、Activity配置

<activity

android:name=“com.tencent.bugly.beta.ui.BetaActivity”

android:configChanges=“keyboardHidden|orientation|screenSize|locale”

android:theme=“@android:style/Theme.Translucent”/>

3、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”/>

如果你使用的第三方库也配置了同样的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”/>

4、升级SDK下载路径配置

在res目录新建xml文件夹，创建provider_paths.xml文件如下：

<?xml version="1.0" encoding="utf-8"?>

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

七、混淆

====

Bugly混淆规则

-dontwarn com.tencent.bugly.**

-keep public class com.tencent.bugly.**{*;}

避免影响升级功能，需要keep住support包的类

-keep class android.support.**{*;}

好了，集成完毕，接下来就是制作基准包、补丁包和上传补丁包了。

八、制作基准包

=======

在app编码完成并测试完成后，就是打包上线了，上线前打的包就是基准包啦，下面我们就来制作基准包，分3步：

打开app下的tinker-support.gradle文件。
将带"base"的tinkerId注释解开，并注释掉带"patch"的tinkerId。
双击运行build下的assembleRelease。

通常主Module的名字是"app"，但我这个Demo是"tinker-bugly"，所以你执行第3步时，要根据具体项目找到要制作基准包的主Module。

AS在执行assembleRelease指令时，就是在编译基准包了，当编译完成时，app的build目录下会自动生成基准包文件夹，以时间戳来命名的（也就是说，每次执行assembleRelease指令都会在build目录创建不同的基准包文件夹）。

这3个文件对之后制作补丁包来说是相当重要的，你需要做的就是将这3个文件保存好，可以保存到云盘、Git服务器上等等，但就不要让它就这么放着，因为在你执行clean Project时，app的build目录会被删除，这样基准包及mapping与R文件都会丢失。

到这里，你就可以把它（基准包：tinker-bugly-release.apk）上架到应用市场了。试下Demo：

tip:加固与多渠道打包

本篇不涉及具体的加固与多渠道打包。

1、加固

如果你的app需要加固，那就需要在制作基准包之前，将tinker-support.gradle文件的isProtectedApp = true的注释去掉，然后加固，重新签名，最后上架，它对加固平台也有一定的要求。

详情见「Bugly热更新使用范例文档最后：加固打包」部分。

2、多渠道打包

分「gradle配置productFlavors方式」与「多渠道打包工具打多渠道包方式（推荐）」。

详情见「Bugly热更新使用范例文档：多渠道打包」部分。

九、补丁包

=====

现在要动态修复App了，对于代码修复、so库修复、资源文件修复，分别对应Demo中的"say something"、“get string from .so”、“我的头像”，修复过程无非是改代码，替换so文件，替换资源文件，这里就不演示了，直接开始制作补丁包，先将tinker-support.gradle文件打开。

1、基准包命名

确保基准包及相关文件的命名与配置文件中的一致：

2、修改baseApkDir与tinkerId

修改baseApkDir的值为基准包所有文件夹的名字。
注释掉带"base"的tinkerId，取消带"patch"的tinkerId的注释（多次生成补丁时，记得修改"计数"，区分不同的补丁）。

3、执行编译，生成补丁

打开侧边的Gradle标签，找到项目的主Module，双击tinker-support下的buildTinkerPatchRelease指令，生成补丁包。

当编译完成后，在app的build/outputs/patch目录下会在"patch_singed_7zip.apk"文件，它就是补丁包，双击打开它，可以看到其中有一个YAPATCH.MF，里面记录了基准包与补丁包的tinkerId（两者是肯定不同，如果一样则说明配置有问题了）。

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数初中级Android工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则近万的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Android移动开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注：Android）

尾声

你不踏出去一步，永远不知道自己潜力有多大，千万别被这个社会套在我们身上的枷锁给捆住了，30岁我不怕，35岁我一样不怕，去做自己想做的事，为自己拼一把吧！不试试怎么知道你不行呢？

改变人生，没有什么捷径可言，这条路需要自己亲自去走一走，只有深入思考，不断反思总结，保持学习的热情，一步一步构建自己完整的知识体系，才是最终的制胜之道，也是程序员应该承担的使命。

附上：我们之前因为秋招收集的二十套一二线互联网公司Android面试真题（含BAT、小米、华为、美团、滴滴）和我自己整理Android复习笔记（包含Android基础知识点、Android扩展知识点、Android源码解析、设计模式汇总、Gradle知识点、常见算法题汇总。）

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！

开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。**

[外链图片转存中…(img-m7VP3gcz-1713779102455)]

[外链图片转存中…(img-xXeLqhel-1713779102456)]

[外链图片转存中…(img-s1rb89Ef-1713779102457)]

[外链图片转存中…(img-Xn1qXi90-1713779102458)]

[外链图片转存中…(img-p1zHNKXz-1713779102459)]

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注：Android）

[外链图片转存中…(img-opl1O1C1-1713779102460)]

尾声

附上：我们之前因为秋招收集的二十套一二线互联网公司Android面试真题（含BAT、小米、华为、美团、滴滴）和我自己整理Android复习笔记（包含Android基础知识点、Android扩展知识点、Android源码解析、设计模式汇总、Gradle知识点、常见算法题汇总。）

[外链图片转存中…(img-VesvZHDX-1713779102461)]

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！

2401_84121980

关注

5
点赞
踩
9

收藏

觉得还不错? 一键收藏
0
评论
Android-第三方开源框架：Bugly让热修复变得如此简单

/def myTinkerId = “base-” + rootProject.ext.android.versionName // 用于生成基准包（不用修改）//def myTinkerId = “patch-” + rootProject.ext.android.versionName + “.0.0” // 用于生成补丁包（每次生成补丁包都要修改一次，最好是 patch-${versionName}.x.x）/***/// 开启tinker-support插件，默认值true。
复制链接

扫一扫