Bugly热更新是腾讯推出的热更新框架,热更新是指无需到应用市场重新下载安装app,只需要在app内下载补丁包即可实现app的更新,主要用于app的bug修复或者少量改动。 大家在使用app(特别是游戏app比较常见)的时候应该都有过类似经历:打开app时,一个弹框显示:有新的更新包,点击下载,只需要下载几百KB或几兆的补丁包,app就实现了更新,这就是使用的热更新技术。
官方文档参照:github.com/BuglyDevTea…
一、添加插件依赖
最新版本不需要在项目的根目录添加依赖,只需要在app模块添加依赖
dependencies {
// 多dex配置
implementation "com.android.support:multidex:1.0.1"
implementation 'com.tencent.bugly:crashreport_upgrade:latest.release'
//1. 指定tinker依赖版本(注:应用升级1.3.5版本起,不再内置tinker)
//2.为了便于解答问题,这里的tinker版本建议跟随此处demo设置,如果微信更新了tinker版本,bugly会定期同步更新
implementation 'com.tencent.tinker:tinker-android-lib:1.9.14.3'
implementation 'com.tencent.bugly:nativecrashreport:latest.release}二、新建tinker-support.gradle
apply plugin: 'com.tencent.bugly.tinker-support'def bakPath = file("${buildDir}/bakApk/")/** * 此处填写每次构建生成的基准包目录 */def baseApkDir = "app-0427-16-37-14"/** * 对于插件各参数的详细解析请参考,如果没有特殊需求下面的参数都可以不用更改;如果apk需要加固等可以参考具体描述设置参数 */tinkerSupport { // 开启tinker-support插件,默认值true enable = true // 指定归档目录,默认值当前module的子目录tinker autoBackupApkDir = "${bakPath}" //建议设置true,用户就不用再自己管理tinkerId的命名,插件会为每一次构建的base包自动生成唯一的tinkerId,默认命名规则是versionname.versioncode_时间戳 //具体参考https://github.com/BuglyDevTeam/Bugly-Android-Demo/wiki/Tinker-ID%E8%AF%A5%E6%80%8E%E4%B9%88%E8%AE%BE%E7%BD%AE autoGenerateTinkerId = true //tinkerId必须保证唯一性,如果两个base包的tinkerid是一样的,并且都联网激活了,那么后续补丁上传到后台的时候会出现匹配错误 tinkerId = "if autoGenerateTinkerId=true ,no need set here" // 是否启用覆盖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"// buildAllFlavorsDir = "${bakPath}/${baseApkDir}" // 是否开启加固模式,默认为false isProtectedApp = true enableProxyApplication = false 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-debug.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-patch" //applyMapping = "${bakPath}/${appName}/app-debug-mapping.txt" // 可选,设置mapping文件,建议保持旧apk的proguard混淆方式 //applyResourceMapping = "${bakPath}/${appName}/app-debug-R.txt" // 可选,设置R.txt文件,通过旧apk文件保持ResId的分配 }}建立完成后,在app module中的build.gradle文件中添加:
apply from: 'tinker-support.gradle'三、初始化SDK
先在Bugly管理平台:https://bugly.qq.com/v2/上申请appId,注册账户后登录,点击新建产品:
添加SampleApplicationLike.java文件
package com.tencent.bugly.hotfix;import android.annotation.TargetApi;import android.app.Application;import android.content.Context;import android.content.Intent;import android.os.Build;import android.support.multidex.MultiDex;import android.widget.Toast;//import com.meituan.android.walle.WalleChannelReader;import com.tencent.bugly.Bugly;import com.tencent.bugly.beta.Beta;import com.tencent.bugly.beta.interfaces.BetaPatchListener;import com.tencent.tinker.entry.DefaultApplicationLike;import com.tencent.tinker.entry.DefaultApplicationLike;import java.util.Locale;/** * 自定义ApplicationLike类. * * 注意:这个类是Application的代理类,以前所有在Application的实现必须要全部拷贝到这里<br/> * * @author wenjiewu * @since 2016/11/7 */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(); // 设置是否开启热更新能力,默认为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(getApplication(), "补丁下载地址" + patchFile, Toast.LENGTH_SHORT).show(); } @Override public void onDownloadReceived(long savedLength, long totalLength) { Toast.makeText(getApplication(), 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(getApplication(), "补丁下载成功", Toast.LENGTH_SHORT).show(); } @Override public void onDownloadFailure(String msg) { Toast.makeText(getApplication(), "补丁下载失败", Toast.LENGTH_SHORT).show(); } @Override public void onApplySuccess(String msg) { Toast.makeText(getApplication(), "补丁应用成功", Toast.LENGTH_SHORT).show(); } @Override public void onApplyFailure(String msg) { Toast.makeText(getApplication(), "补丁应用失败", Toast.LENGTH_SHORT).show(); } @Override public void onPatchRollback() { } }; // 设置开发设备,默认为false,上传补丁如果下发范围指定为“开发设备”,需要调用此接口来标识开发设备 Bugly.setIsDevelopmentDevice(getApplication(), true); // 多渠道需求塞入 // String channel = WalleChannelReader.getChannel(getApplication()); // Bugly.setAppChannel(getApplication(), channel); // 这里实现SDK初始化,appId替换成你的在Bugly平台申请的appId Bugly.init(getApplication(), "afe3b8814a", true); } @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); // TODO: 安装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(); }}更改为自己的BuglyId
添加SampleApplication引用SampleApplicationLike文件
package com.tencent.bugly.hotfix;import com.tencent.tinker.loader.app.TinkerApplication;import com.tencent.tinker.loader.shareutil.ShareConstants;/** * 自定义Application. * * 注意:这个类集成TinkerApplication类,这里面不做任何操作,所有Application的代码都会放到ApplicationLike继承类当中<br/> * <pre> * 参数解析: * 参数1:int tinkerFlags 表示Tinker支持的类型 dex only、library only or all suuport,default: TINKER_ENABLE_ALL * 参数2:String delegateClassName Application代理类 这里填写你自定义的ApplicationLike * 参数3:String loaderClassName Tinker的加载器,使用默认即可 * 参数4:boolean tinkerLoadVerifyFlag 加载dex或者lib是否验证md5,默认为false * </pre> * @author wenjiewu * @since 2016/11/15 */public class SampleApplication extends TinkerApplication { public SampleApplication() { super(ShareConstants.TINKER_ENABLE_ALL, "com.tencent.bugly.hotfix.SampleApplicationLike", "com.tencent.tinker.loader.TinkerLoader", false); }}四、AndroidManifest.xml配置
- 在AndroidMainfest.xml中进行以下配置:
<!--Bugly升级SDK权限配置开始--><uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/><uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/><uses-permission android:name="android.permission.INTERNET"/><uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/><uses-permission android:name="android.permission.READ_PHONE_STATE"/><uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/> - Activity配置
<!-- Bugly升级SDK配置开始 --><activity android:name="com.tencent.bugly.beta.ui.BetaActivity" android:configChanges="keyboardHidden|orientation|screenSize|locale" android:theme="@android:style/Theme.Translucent"/><!--API 24以上配置--><provider android:name="android.support.v4.content.FileProvider" android:authorities="com.tencent.bugly.hotfix.fileProvider" android:exported="false" android:grantUriPermissions="true"> <meta-data android:name="android.support.FILE_PROVIDER_PATHS" android:resource="@xml/provider_paths"/></provider> - 配置FileProvider
<?xml version="1.0" encoding="utf-8"?><paths xmlns:android="http://schemas.android.com/apk/res/android"> <!-- /storage/emulated/0/Download/com.bugly.upgrade.demo/.beta/apk--> <external-path name="beta_external_path" path="Download/"/> <!--/storage/emulated/0/Android/data/com.bugly.upgrade.demo/files/apk/--> <external-path name="beta_external_files_path" path="Android/data/"/></paths
五、混淆配置
# Bugly混淆规则-dontwarn com.tencent.bugly.**-keep public class com.tencent.bugly.**{*;}# tinker混淆规则-dontwarn com.tencent.tinker.**-keep class com.tencent.tinker.** { *; }# 避免影响升级功能,需要keep住support包的类-keep class android.support.**{*;}六、生成基准包
在手机联网状态下,安装此基准包,否则上传补丁包时会报错:
七、生成补丁包
先将tinker-support.gradle中的baseApkDir修改为第六步生成的apk文件夹名
app-0427-16-37-14然后点击
生成的补丁包在这里:
这里注意路径不要找错了,是patch/release文件夹下的patch_signed_7zip.apk,而不是apk/tinkerPatch/release文件夹下的patch_signed_7zip.apk,如果上传apk文件夹下的补丁包,Bugly管理平台会报错:“上传失败!补丁文件缺失必需字段:Created-Time、Created-By、YaPatchType、VersionName、VersionCode、From、To,请检查补丁文件后重试!”
八、上传补丁包,见证热更新
后我们静静等待热更新生效,生效时间大概十分钟!