Android Bugly全量更新、热修复集成
我的Androidstudio是最新的window-3.6.2,解决了各种项目问题(》-《),有不懂的可以一起讨论哈。首先明确下需求:1.bugly全量更新,2.热修复补丁更新(需要软件第二次打开合并补丁才能使代码有效)Bugly官网.以前在Mac下集成阿里的热修复感觉简单多了,就是要钱。。
(这里采用手动集成,刚到珠海格力履职,公司外网把很多网站都墙了,慢的很。。)
1.项目根build.gradle文件:
dependencies { classpath 'com.android.tools.build:gradle:3.6.2' classpath "com.tencent.bugly:tinker-support:1.1.5" }
在AndroidManifest.xml添加权限、fileProvider, android:networkSecurityConfig="@xml/network_security_config"
2.主module/app下的build.gradle文件关键代码(坑:依赖的版本号是一一对应的,而且不是所有的版本都有,这里1.1.5—》1.9.9):
apply plugin: 'com.android.application'
//添加插件
apply from: 'tinker-support.gradle'
dependencies {
implementation fileTree(dir: 'libs', include: ['*.jar'])
//崩溃上报-更新
implementation(name: 'bugly_crashreport_upgrade-1.4.2', ext: 'aar')
implementation "com.android.support:multidex:1.0.2" // 多dex配置
// 指定tinker依赖版本(注:应用升级1.3.5版本起,不再内置tinker)
implementation 'com.tencent.tinker:tinker-android-lib:1.9.9'
}
android {
compileSdkVersion 29
buildToolsVersion "29.0.3"
defaultConfig {
applicationId "com.rxutils.jason"
minSdkVersion 19
targetSdkVersion 29
versionCode 1
versionName "1.0.6"
multiDexEnabled true
ndk {
abiFilters "armeabi", "x86" //"armeabi-v7a",
}
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
}
// 签名设置
signingConfigs {
myConfig {
storeFile file("gree_pad_app.jks")
storePassword "888888"
keyAlias "gree"
keyPassword "888888"
}
}
/*//指定打包后应用名称--由于热更新他插件文件需要固定的包名,为了简单就不改了。
android.applicationVariants.all { variant ->
variant.outputs.all {
outputFileName = "GREE_PAD_${buildType.name}_${defaultConfig.versionName}.apk"
}
}*/
buildTypes {
release {
minifyEnabled true //是否开启混淆 如果是ture后面构建apk才会生成 app-release-mapping文件
debuggable false //是否开启日志输出
proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
signingConfig signingConfigs.myConfig
buildConfigField "boolean", "IS_DEBUG", "false" //是否是debug模式
}
debug {
minifyEnabled false
debuggable true
signingConfig signingConfigs.myConfig
buildConfigField "boolean", "IS_DEBUG", "true"
}
}
sourceSets {
main {
jniLibs.srcDirs = ['libs']
}
}
repositories {
flatDir {
dirs 'libs'
}
}
}
3.在app/build.gradle文件同级目录下proguard-rules.pro文件添加混淆
# bugly混淆
-dontwarn com.tencent.bugly.**
-keep public class com.tencent.bugly.**{*;}
# tinker混淆规则
-dontwarn com.tencent.tinker.**
-keep class com.tencent.tinker.** { *; }
-keep class android.support.**{*;}
#屏蔽某些检查,否则编译不过
-ignorewarnings
4.在与app/build.gradle文件同级目录下创建文件tinker-support.gradle:
(这里很重要,现在是为基准包做准备,解析下-》现在我们打release包,标号位置将T1处的基准包名置空,T2处有效且根据自己的app版本号设置,我的是versionName “1.0.6” ,所以是"base-1.0.6",T3处在基准包时无效注释掉,如果打debug包则还需要将T4、T5、T6的release字样改成debug,否则找到到基准包的)
apply plugin: 'com.tencent.bugly.tinker-support'
def bakPath = file("${buildDir}/bakApk/")
/**
* 此处填写每次构建生成的基准包目录,就是第一次运行到手机中
* 第一次可以为空
*/
def baseApkDir = "" //T1
// 用于生成基准包,为当前apk的版本号,生成补丁包时此内容要隐藏
def myTinkerId = "base-1.0.6" // 用于生成基准包(不用修改) //T2
// 用于生成补丁包(每次生成补丁包都要修改一次,当前版本号后代补丁包的递增序列号),生成基准包补丁包要隐藏
//def myTinkerId = "patch-1.0.6.0.1" //T3
/**
* 对于插件各参数的详细解析请参考
*/
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" //T4
// 对应tinker插件applyMapping
baseApkProguardMapping = "${bakPath}/${baseApkDir}/app-release-mapping.txt" //T5
// 对应tinker插件applyResourceMapping
baseApkResourceMapping = "${bakPath}/${baseApkDir}/app-release-R.txt" //T6
// 构建基准包和补丁包都要指定不同的tinkerId,并且必须保证唯一性
tinkerId = "${myTinkerId}"
// 构建多渠道补丁时使用
// // buildAllFlavorsDir = "${bakPath}/${baseApkDir}"
// 是否启用加固模式,默认为false.(tinker-spport 1.0.7起支持)本次试验没有加固
// isProtectedApp = true
// 是否开启反射Application模式,true-就是不需要继承的
enableProxyApplication = true
// 是否支持新增非export的Activity(注意:设置为true才能修改AndroidManifest文件)
supportHotplugComponent = true
}
/**
* 一般来说,我们无需对下面的参数做任何的修改
*/
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/添加/libs/文件夹,在官网下载资源包,添加在build.gradle文件下指定的签名文件,添加后:
5.创建RxApp类是继承Application,记得在AndroidManifest.xml文件下添加name,由于采用反射的方法去集成(enableProxyApplication = true,懒就是了),在类中添加两个初始化方法initBugly(),initTinker():
@Override
public void onCreate() {
super.onCreate();
initTinker();
initBugly();
}
private void initBugly() {
/**
* Beta高级设置
* true表示app启动自动初始化升级模块;
* false不好自动初始化
* 开发者如果担心sdk初始化影响app启动速度,可以设置为false
* 在后面某个时刻手动调用
* 每次杀后台就能弹窗,其他运行时要调用checkUpdate()
*/
Beta.autoInit = true;
/**
* true表示初始化时自动检查升级
* false表示不会自动检查升级,需要手动调用Beta.checkUpgrade()方法
*/
Beta.autoCheckUpgrade = true;
/**
* 设置升级周期为60s(默认检查周期为0s),60s内SDK不重复向后天请求策略
*/
Beta.upgradeCheckPeriod = 60 * 1000; //60
/**
* 设置启动延时为3s(默认延时3s),APP启动1s后初始化SDK,避免影响APP启动速度;
*/
Beta.initDelay = 3 * 1000;
/**
* 设置通知栏大图标,largeIconId为项目中的图片资源;
*/
Beta.largeIconId = R.mipmap.ic_launcher;
/**
* 设置状态栏小图标,smallIconId为项目中的图片资源id;
*/
Beta.smallIconId = R.mipmap.ic_launcher;
/**
* 设置sd卡的Download为更新资源保存目录;
* 后续更新资源会保存在此目录,需要在manifest中添加WRITE_EXTERNAL_STORAGE权限;
*/
Beta.storageDir = Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_DOWNLOADS);
/**
* 开启热更新能力
*/
Beta.enableHotfix = true;
/*设置是否显示消息通知*/
// Beta.enableNotification = true;
/*设置wifi下自动下载*/
// Beta.autoDownloadOnWifi = true;
/*设置是否显示弹窗中的apk信息*/
// Beta.canShowApkInfo = true;
/**
* 点击过确认的弹窗在APP下次启动自动检查更新时会再次显示;
*/
Beta.showInterruptedStrategy = false;
Beta.strUpgradeDialogCancelBtn = "下次再說"; //左右按鈕文字
Beta.strNetworkTipsConfirmBtn = "立即更新";
Beta.strUpgradeDialogVersionLabel = "版本";
Beta.strUpgradeDialogFileSizeLabel = "包大小";
Beta.strUpgradeDialogUpdateTimeLabel = "更新時間";
Beta.strUpgradeDialogFeatureLabel = "更新說明";
/**
* 只允许在MainActivity上显示更新弹窗,其他activity上不显示弹窗;
* 不设置会默认所有activity都可以显示弹窗;
*/
Beta.canShowUpgradeActs.add(LauncherAty.class);
//监听安装包下载状态
Beta.downloadListener = new DownloadListener() {
@Override
public void onReceive(DownloadTask downloadTask) {
GlobalCode.printLog("bugly_update_downloadListener receive apk file2");
}
@Override
public void onCompleted(DownloadTask downloadTask) {
ToastUtil.showToast("新的apk已下載完成,在通知欄處點擊安裝");
GlobalCode.printLog("bugly_update_downloadListener download apk file success3");
}
@Override
public void onFailed(DownloadTask downloadTask, int i, String s) {
GlobalCode.printLog("bugly_update_downloadListener download apk file fail");
}
};
//监听APP升级状态
Beta.upgradeStateListener = new UpgradeStateListener() {
@Override
public void onUpgradeFailed(boolean b) {
GlobalCode.printLog("bugly_update_upgradeStateListener upgrade fail");
}
@Override
public void onUpgradeSuccess(boolean b) {
GlobalCode.printLog("bugly_update_upgradeStateListener upgrade success1");
getAppUpdateInfo();
}
@Override
public void onUpgradeNoVersion(boolean b) {
GlobalCode.printLog("bugly_update_upgradeStateListener upgrade has no new version");
}
@Override
public void onUpgrading(boolean b) {
GlobalCode.printLog("bugly_update_upgradeStateListener upgrading");
}
@Override
public void onDownloadCompleted(boolean b) {
GlobalCode.printLog("bugly_update_upgradeStateListener download apk file success4");
}
};
/**
* 已经接入Bugly用户改用上面的初始化方法,不影响原有的crash上报功能;
* init方法会自动检测更新,不需要再手动调用Beta.checkUpdate(),如需增加自动检查时机可以使用Beta.checkUpdate(false,false);
* 参数1:applicationContext
* 参数2:appId
* 参数3:是否开启debug
*/
CrashReport.UserStrategy strategy = new CrashReport.UserStrategy(mContext);
/*** strategy.setCrashHandleCallback(new CrashReport.CrashHandleCallback() {
@Override
public synchronized Map onCrashHandleStart(int crashType, String errorType, String errorMessage, String errorStack) {
LinkedHashMap map = new LinkedHashMap();
String x5CrashInfo = WebView.getCrashExtraMessage(mContext);
map.put("x5", x5CrashInfo);
return map;
// return super.onCrashHandleStart(crashType, errorType, errorMessage, errorStack);
}
@Override
public synchronized byte[] onCrashHandleStart2GetExtraDatas(int crashType, String errorType, String errorMessage, String errorStack) {
try {
return "Extra data.".getBytes("UTF-8");
} catch (Exception e) {
e.printStackTrace();
return null;
}
// return super.onCrashHandleStart2GetExtraDatas(crashType, errorType, errorMessage, errorStack);
}
}
); **/ //这里是集成x5浏览器内核,无关代码已被注释
//统一初始化 调试时第三个参数=true
Bugly.init(getApplicationContext(), BUGLY_APPID, !BuildConfig.DEBUG, strategy);
}
private void initTinker() {
//设置是否提示用户重启,默认false,这样会在应用下次启动才应用成功
Beta.canNotifyUserRestart = true;
Beta.betaPatchListener = new BetaPatchListener() {
@Override
public void onPatchReceived(String s) {
GlobalCode.printLog("patchfile-" + s);
}
@Override
public void onDownloadReceived(long l, long l1) {
}
@Override
public void onDownloadSuccess(String s) {
GlobalCode.printLog("patch-" + s);
}
@Override
public void onDownloadFailure(String s) {
GlobalCode.printLog("patch-" + s);
}
@Override
public void onApplySuccess(String s) {
GlobalCode.printLog("patchapply-" + s);
}
@Override
public void onApplyFailure(String s) {
GlobalCode.printLog("patchapply-" + s);
}
@Override
public void onPatchRollback() {
}
};
// 设置开发设备,默认为false,上传补丁如果下发范围指定为“开发设备”,需要调用此接口来标识开发设备
Bugly.setIsDevelopmentDevice(getContext(), true);
Bugly.setUserId(this, "jason_GREE");
Bugly.setUserTag(this, 123456);
// Bugly.putUserData(this, SetConfig.CODE_USER_TOKEN, "jason_token");
// Bugly.setAppChannel(this, "bugly");
}
可能现在BuildConfig爆红,不要惊,这个类是运行时生成,只要rebuild下就行但是现在不要rebuild,每次rebuild都会生成一个基准包的会影响视觉。。
6.As菜单Build-》Clean project,删除/build文件夹,构建基准包要清,补丁包时不要清啊,清理了就要手动将基准包生成的文件夹拷贝回来才能去生成补丁包。所以生成的基准包要拷贝下来放到其他位置,为将来打补丁包时使用。/app/build/bakApk
7.在编译器右边找到Gradle(位置不固定)打基准包双击1处,打补丁包双击2处:
8.基准包构建成功,记得将基准包找个其他位置保存起来,因为项目clean下/build文件夹就没啦,这样就无法构建对应的补丁包.
9.此时编写新的代码,修复bug/添加新业务啦,编写好了我们打补丁包看下有没生效。修改文件tinker-support.gradle:将生成的基准包包名写入,每次构建补丁包都是改T1,T3,将T2注释;构建基准包T1置空,改T2,注释T3。以下代码
apply plugin: 'com.tencent.bugly.tinker-support'
def bakPath = file("${buildDir}/bakApk/")
/**
* 此处填写每次构建生成的基准包目录,就是第一次运行到手机中
* 第一次可以为空
*/
def baseApkDir = "app-0528-10-19-35" //T1
// 用于生成基准包,为当前apk的版本号,生成补丁包时此内容要隐藏
//def myTinkerId = "base-1.0.6" // 用于生成基准包(不用修改) //T2
// 用于生成补丁包(每次生成补丁包都要修改一次,当前版本号后代补丁包的递增序列号),生成基准包补丁包要隐藏
def myTinkerId = "patch-1.0.6.0.2" //T3
/**
* 对于插件各参数的详细解析请参考
*/
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 = "${myTinkerId}"
// 构建多渠道补丁时使用
// // buildAllFlavorsDir = "${bakPath}/${baseApkDir}"
// 是否启用加固模式,默认为false.(tinker-spport 1.0.7起支持)我们这里用乐固
// isProtectedApp = true
// 是否开启反射Application模式,true-就是不需要继承的
enableProxyApplication = true
// 是否支持新增非export的Activity(注意:设置为true才能修改AndroidManifest文件)
supportHotplugComponent = true
}
/**
* 一般来说,我们无需对下面的参数做任何的修改
*/
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的分配
}
}
10.找到gradle工具-》buildThinkPatchRelease.
上传补丁包,/app/build/outputs/patch/release/patch_signed_7zip.apk就是补丁包路径。这个就是需要上传的补丁包,我们双击它编译器会进入他的内容页,YAPATCH.MF有相关的版本信息,这时候要确保你有联网设备安装了基准包,否则上传补丁包会不合法,他要联网上报寻找对应的版本包。
成功后输出日志()截取前面做的日志
E/TAG: patchapply-
PatchResult:
isSuccess:true
rawPatchFilePath:/data/user/0/com.rxutils.jason/app_tmpPatch/tmpPatch.apk
costTime:11475
patchVersion:4606d4461f001411f0c77f74206e743a
2020-05-27 16:50:04.383 E/TAG: patchfile-https://s.beta.gtimg.com/rdmimg/hot_patch/53291f36e4/dc8b2f92-6967-4d29-85d3-078d0d6bd9d1.zip
2020-05-27 16:50:04.386 E/TAG: bugly_update_upgradeStateListener upgrade has no new version
2020-05-27 16:50:05.222 D/Tinker.TinkerManager: onDownloadSuccess.
2020-05-27 16:50:05.222 E/TAG: patch-/data/user/0/com.rxutils.jason/app_tmpPatch/tmpPatch.apk
2020-05-27 16:50:05.223 D/Tinker.TinkerManager: check if has new patch.
2020-05-27 16:50:05.231 D/Tinker.TinkerManager: has new patch.
2020-05-27 16:50:05.232 D/Tinker.TinkerManager: starting patch.
注意事项:1.插件文件 baseApkDir打基类包可以=null,打补丁包要写基类包的 /app/build/bakApk/app-0527-17-29的路径。。
2.debug包和release是不一样的。apk的名字改debug–>release.
3.上传补丁包前必须先有设备安装了基类包并上报了,他会在上传时网络接口匹配目标版本。否则上传不了的
4.编译器右边Gradle app/build/assembleRelease --构建基类包 app/tinker-support/buildTinkerPatchRelease —>构建补丁包(/patch/*7z.apk)
5.生成补丁包前–别忘了写修复代码,根据情况选择BuildVariants–debug/release,再进行打包构建。。
总结:1.我的依赖是bugly全量更新和热更新全套了,热更新中Beta.canNotifyUserRestart = true;这个会弹出窗口关闭软件,但是热更新必须要重启软件才能合并补丁,设置false就后台默默下次执行。2.全量更新有设置某个Activity弹出,我的经验是更新不是及时推送的,15分钟内一般都可以了。代码都给你们了动手试试吧,我在BuildVariants–更改debug/release两种模式下都进行了热更新的全过程都成功了,希望能帮到大家。
2020,心想事成!!! Jason-何伟杰