简述
热更新能力是Bugly为解决开发者紧急修复线上bug,无需重新发版让用户无感知就能把问题修复的一项能力。 通过管理后台发布补丁,进行的修复。
这里先给出Bugly Android热更新使用指南 文档,能力强的小伙伴们可以自己去过一遍。
老规矩先上图(感觉图片没有很好体现热修复的效果)
未修复前,点击提示按钮提示 1+1=3 的错误提示
发布补丁后 ,点击提示: 修复 1+1=2
采用的方案原理
微信Tinker热修复采用的是类加载方案,重启App后让ClassLoader重新加载新的类 ,故无法实时生效,得需要用户杀掉进程关掉APP后,重新启动进来才有效果。 由于已经有大佬对相关几种修复原理进行分析,咱们可以站在巨人肩膀上学习学习:这里直接贴刘望舒大佬传送门地址
开启代码之旅
开始之前先说说我的开发版本:
- gradle 版本 我测试过的3.3.0 和3.4.0 可以正常接入使用,但是接入3.6.1 就会出现提示
Gradle sync failed: No signature of method: org.gradle.api.internal.file.DefaultFilePropertyFactory$DefaultDirectoryVar.getFiles() is applicable for argument types: () values: []
此类错误本人暂无能力解决,有解决方案的小伙伴可以提出来,大家互相学习学习。
我这边是开启混淆,并且设置了混淆规则 接入方式用enableProxyApplication = false 的情况,这个是关闭映射官方推荐的方式(为true的成本低,文档也容易,就不重复写)
Bugly平台小伙伴们自己注册和创建,然后取创建项目的appid,这几个步骤相信不用贴出来,小伙伴们也能捣鼓清楚。
先按照开发文档,把我们需要的依赖的SDK配置进来
-
首先是项目下的gradle
在dependencies 中设置插件依赖
// tinkersupport插件, 其中lastest.release指拉取最新版本,也可以指定明确版本号,例如1.0.4
classpath "com.tencent.bugly:tinker-support:1.1.5"
-
在app 目录下的gradle 中集成SDK
implementation "com.android.support:multidex:1.0.1" // 多dex配置
//注释掉原有bugly的仓库
//compile 'com.tencent.bugly:crashreport:latest.release'//其中latest.release指代最新版本号,也可以指定明确的版本号,例如1.3.4
implementation 'com.tencent.bugly:crashreport_upgrade:1.3.6'
// 指定tinker依赖版本(注:应用升级1.3.5版本起,不再内置tinker)
implementation 'com.tencent.tinker:tinker-android-lib:1.9.9'
implementation 'com.tencent.bugly:nativecrashreport:latest.release'
//其中latest.release指代最新版本号,也可以指定明确的版本号,例如2.2.0
-
同步完成之前顺便把生成签名也设置了混淆(这边为了方便调试,把release 与 debug 同时配置为使用密钥,同时开启混淆 ,单纯只是为了写个测试的可以minifyEnabled 设置为false)
fix.jks密钥目录位置:
完整gradler如下:
apply plugin: 'com.android.application'
// 依赖插件脚本
apply from: 'tinker-support.gradle'
android {
compileSdkVersion 29
buildToolsVersion "29.0.3"
signingConfigs {
config {
keyAlias 'guo'
keyPassword 'g123456'
storeFile file("fix.jks")
storePassword 'g123456'
}
}
defaultConfig {
applicationId "com.mutou.fixapplication"
minSdkVersion 16
targetSdkVersion 29
versionCode 1
versionName "1.0.1"
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
ndk {
//设置支持的SO库架构
abiFilters 'armeabi', 'x86'//, 'x86', 'armeabi-v7a', 'x86_64', 'arm64-v8a'
}
}
buildTypes {
release {
minifyEnabled true
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
signingConfig signingConfigs.config
}
debug {
minifyEnabled true
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
//signingConfig signingConfigs.config
signingConfig signingConfigs.config
}
}
}
dependencies {
implementation fileTree(dir: 'libs', include: ['*.jar'])
implementation 'androidx.appcompat:appcompat:1.2.0'
implementation 'androidx.constraintlayout:constraintlayout:2.0.1'
testImplementation 'junit:junit:4.12'
androidTestImplementation 'androidx.test.ext:junit:1.1.2'
androidTestImplementation 'androidx.test.espresso:espresso-core:3.3.0'
implementation "com.android.support:multidex:1.0.1" // 多dex配置
//注释掉原有bugly的仓库
//compile 'com.tencent.bugly:crashreport:latest.release'//其中latest.release指代最新版本号,也可以指定明确的版本号,例如1.3.4
implementation 'com.tencent.bugly:crashreport_upgrade:1.3.6'
// 指定tinker依赖版本(注:应用升级1.3.5版本起,不再内置tinker)
implementation 'com.tencent.tinker:tinker-android-lib:1.9.9'
implementation 'com.tencent.bugly:nativecrashreport:latest.release'
//其中latest.release指代最新版本号,也可以指定明确的版本号,例如2.2.0
}
- 建议把SDK集成完成后再配置插件脚本
apply from: 'tinker-support.gradle'
在app目录下新建文件 tinker-support.gradle
我这边是已经存在了故报了这个错误,你们点击 ok 即可生成该文件
该插件配置直接照着文档copy即可,相关参数含义可以参见文档。
配置如下
apply plugin: 'com.tencent.bugly.tinker-support'
def bakPath = file("${buildDir}/bakApk/")
/**
* 此处填写每次构建生成的基准包目录
*/
def baseApkDir = "app-0916-16-41-06"
/**
* 对于插件各参数的详细解析请参考
*/
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,并且必须保证唯一性 base-1.0.1 对应 patch-1.0.1
tinkerId = "patch-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的分配
}
}
- 再来配置我们的混淆规则 app目录下的 proguard-rules.pro (gradle minifyEnabled 设置为false的可以跳过 )
# Add project specific ProGuard rules here.
# You can control the set of applied configuration files using the
# proguardFiles setting in build.gradle.
#
# For more details, see
# http://developer.android.com/guide/developing/tools/proguard.html
# If your project uses WebView with JS, uncomment the following
# and specify the fully qualified class name to the JavaScript interface
# class:
#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
# public *;
#}
# Uncomment this to preserve the line number information for
# debugging stack traces.
#-keepattributes SourceFile,LineNumberTable
# If you keep the line number information, uncomment this to
# hide the original source file name.
#-renamesourcefileattribute SourceFile
-dontwarn com.tencent.bugly.**
-keep public class com.tencent.bugly.**{*;}
# tinker混淆规则
-dontwarn com.tencent.tinker.**
-keep class com.tencent.tinker.** { *; }
-keep class android.support.**{*;}
# 继承了DefaultApplicationLike 的类 记得保持不被混淆,否则找不到该类直接闪退
-keep public class com.mutou.fixapplication.AppContext{*;}
-optimizationpasses 5
# 混合时不使用大小写混合,混合后的类名为小写
-dontusemixedcaseclassnames
# 指定不去忽略非公共库的类
-dontskipnonpubliclibraryclasses
# 这句话能够使我们的项目混淆后产生映射文件
# 包含有类名->混淆后类名的映射关系
-verbose
# 指定不去忽略非公共库的类成员
-dontskipnonpubliclibraryclassmembers
# 不做预校验,preverify是proguard的四个步骤之一,Android不需要preverify,去掉这一步能够加快混淆速度。
-dontpreverify
# 保留Annotation不混淆
-keepattributes *Annotation*,InnerClasses
# 避免混淆泛型
-keepattributes Signature
# 抛出异常时保留代码行号
-keepattributes SourceFile,LineNumberTable
# 指定混淆是采用的算法,后面的参数是一个过滤器
# 这个过滤器是谷歌推荐的算法,一般不做更改
-optimizations !code/simplification/cast,!field/*,!class/merging/*
#############################################
#
# Android开发中一些需要保留的公共部分
#
#############################################
# 保留我们使用的四大组件,自定义的Application等等这些类不被混淆
# 因为这些子类都有可能被外部调用
-keep public class * extends android.app.Activity
-keep public class * extends android.app.Appliction
-keep public class * extends android.app.Service
-keep public class * extends android.content.BroadcastReceiver
-keep public class * extends android.content.ContentProvider
-keep public class * extends android.app.backup.BackupAgentHelper
-keep public class * extends android.preference.Preference
-keep public class * extends android.view.View
-keep public class com.android.vending.licensing.ILicensingService
# 保留R下面的资源
-keep class **.R$* {*;}
# 保留本地native方法不被混淆
-keepclasseswithmembernames class * {
native <methods>;
}
# 保留在Activity中的方法参数是view的方法,
-keepclassmembers class * extends android.app.Activity{
public void *(android.view.View);
}
# 保留枚举类不被混淆
-keepclassmembers enum * {
public static **[] values();
public static ** valueOf(java.lang.String);
}
# support
-keep public class * extends android.support.v4.**
-keep public class * extends android.support.v7.**
-keep public class * extends android.support.annotation.**
# androidx的混淆
-keep class com.google.android.material.** {*;}
-keep class androidx.** {*;}
-keep public class * extends androidx.**
-keep interface androidx.** {*;}
-dontwarn com.google.android.material.**
-dontnote com.google.android.material.**
-dontwarn androidx.**
# 保留我们自定义控件(继承自View)不被混淆
-keep public class * extends android.view.View{
*** get*();
void set*(***);
public <init>(android.content.Context);
public <init>(android.content.Context, android.util.AttributeSet);
public <init>(android.content.Context, android.util.AttributeSet, int);
}
# 保留Parcelable序列化类不被混淆
-keep class * implements android.os.Parcelable {
public static final android.os.Parcelable$Creator *;
}
# 保留Serializable序列化的类不被混淆
-keepclassmembers class * implements java.io.Serializable {
static final long serialVersionUID;
private static final java.io.ObjectStreamField[] serialPersistentFields;
!static !transient <fields>;
!private <fields>;
!private <methods>;
private void writeObject(java.io.ObjectOutputStream);
private void readObject(java.io.ObjectInputStream);
java.lang.Object writeReplace();
java.lang.Object readResolve();
}
# 对于带有回调函数的onXXEvent、**On*Listener的,不能被混淆
-keepclassmembers class * {
void *(**On*Event);
void *(**On*Listener);
}
# webview 还要注意native接口
-keepclassmembers class * extends android.webkit.WebViewClient {
public void *(android.webkit.WebView, java.lang.String, android.graphics.Bitmap);
public boolean *(android.webkit.WebView, java.lang.String);
}
-keepclassmembers class * extends android.webkit.WebViewClient {
public void *(android.webkit.webView, jav.lang.String);
}
# keep annotated by NotProguard
-keep @top.andnux.proguard.annotation.Keep class * {*;}
-keep class * {
@top.andnux.proguard.annotation.Keep <fields>;
}
-keepclassmembers class * {
@top.andnux.proguard.annotation.Keep <methods>;
}
# 删除代码中Log相关的代码
-assumenosideeffects class android.util.Log {
public static boolean isLoggable(java.lang.String, int);
public static int v(...);
public static int i(...);
public static int w(...);
public static int d(...);
public static int e(...);
}
其中-keep public class com.mutou.fixapplication.AppContext{*;}
这个看各位小伙伴自己建立的项目包名和类名,这个继承了DefaultApplicationLike 的类 记得保持不被混淆,不然Application代理类找不到路径就闪退了。
- 自定义我们的CustomTinkerApplication 来继承TinkerApplication ,在构造函数里直接调用父类TinkerApplication 带四个参数的构造函数(具体代表含义参考文档)
public class CustomTinkerApplication extends TinkerApplication {
public CustomTinkerApplication() {
super(ShareConstants.TINKER_ENABLE_ALL,
"com.mutou.fixapplication.AppContext",
"com.tencent.tinker.loader.TinkerLoader",
false);
}
}
其中第二个参数 "com.mutou.fixapplication.AppContext" 是我们自定义的Application代理类,注意路径正确和写全,这是我包的目录结构,截图仅供参考,小伙伴们更改为自己项目的正确环境
-
将该类配置到清单manifest中
自定义AppContext并且实现SDK初始化
public class AppContext extends DefaultApplicationLike {
public AppContext(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(), "7eda4c07f3", 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);
// 安装tinker
// TinkerManager.installTinker(this); 替换成下面Bugly提供的方法
Beta.installTinker(this);
}
@TargetApi(Build.VERSION_CODES.ICE_CREAM_SANDWICH)
public void registerActivityLifecycleCallback(Application.ActivityLifecycleCallbacks callbacks) {
getApplication().registerActivityLifecycleCallbacks(callbacks);
}
}
其中 Bugly 第二个参数是我在平台上申请的项目的AppId ,第三个参数设置为开启debug ,其他小伙伴们在正式环境可以关掉. 我们其他集成的SDK的初始化也在这里面实现。
- AndroidManifest 进行权限配置
<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" />
其中里面有些需要动态申请权限,小伙伴们注意下,我这边为求方便,直接用5.0的手机测试,若是高于6.0测试时候最好自行打开所有权限。
- Activity配置
在application 标签内的,注意位置(四大组件的注册)
<activity
android:name="com.tencent.bugly.beta.ui.BetaActivity"
android:configChanges="keyboardHidden|orientation|screenSize|locale"
android:theme="@android:style/Theme.Translucent" />
- 配置FileProvider,这边建议继承FileProvider类来解决合并冲突,一般第三方拍照裁剪的库,会解决7.0 上遇到的Uri 问题,如果依赖了就会和这边的设置起冲突,我们一口气走一遍完整的解决冲突问题(单纯想测试的可直接按照文档来)
新建类UriProvider 并且继承FileProvider
public class UriProvider extends FileProvider {
}
在res目录新建xml文件夹,创建provider_paths.xml文件
<?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>
截图如下:
在清单上配置
<provider
android:name=".providers.UriProvider"
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>
name 是我们创建该类的路径与自身类名,小伙伴们自行改更
到这里写完了我们SDK的接入了,接下来这边简单使用下补丁发布,先来生成我们的基准包,里面写个错误的提示,代码和布局过于简单,只贴下活动页代码了
-
生成基准包
在tinker-support中,基准包的 tinkerId 我这边设置为 base-1.0.1 (后面不要命名一模一样的其他基准包,以免冲突)
然后在AS右上角 的Gradle 中找到并且执行assembleRelease编译生成基准包
若是没有找到的,可以在other目录下找找,我的便是在里面找到的
双击运行之后,会生成编译的基准包、混淆配置文件(开启混淆才有)、资源Id,这份文件建议保存起来。
这个就是我们要用于生产环境的包(现在里面的有错误提示的代码),然后找台手机安装打开,之后会联网上报(确保网络正常),在我们的Bugly平台中能看到统计
- 生成补丁包
还是在我们的tinker-support中,这次要修改的有两处:
-
baseApkDir ,将其设置为我们生成的基准包目录的文件名(生成的是时间戳),我这边的是app-0916-16-41-06
-
将tinkerId 设置为 patch-1.0.1
然后在AS右上角那地方找到tinker-suppor插件目录下的buildTinkerPatchRelease 双击运行
生成的补丁包在app\build\outputs\apk\tinkerPatch\release目录下(我这边AS显示不出,但是按照路径上便能找到),小伙伴们可以直接找到的。
-
将patch_signed_7zip补丁包上传
打开我们的管理平台,选中我们创建的项目
管理平台可以看到 1/全量设备, 说明已经激活一台,热修复成功了。
整个流程就到此为止。希望能对小伙伴们有启发,不足之处还望指出。