腾讯Bugly热更新

Bugly 热更新

Posted by Cedar7 on January 4, 2018

腾讯Bugly热更新

在现在的App中都会集成一些崩溃上报的机制,一般都是集成第三方的统计插件,比如友盟、百度和腾讯等,我自己的项目中用的是腾讯的Bugly,但只是集成了上报的功能,并未集成其他功能。最近发现线上bug开始变多,但是app发版又不能过于频繁,而且就算发版,用户也未必会升级,这样就会造成Bug一直没有得到解决,令心情十分的不美观。所以我决定试着集成一下Bugly的热更新功能。其实官方是由相关的文档说明,但是很多地方都是一笔带过,在实际的操作过程中,并不是关注的那么仔细,所以我在这里只是给大家说一些我在集成过程中遇到的坑还有细节,好帮助大家更好的使用Bugly热更新。附上:Bugly热更新文档地址。

1. 添加依赖

工程根目录下“build.gradle”文件中添加:

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        // tinkersupport插件, 其中lastest.release指拉取最新版本,也可以指定明确版本号,例如1.0.4
        classpath "com.tencent.bugly:tinker-support:1.0.8"
    }
}

tinker:原本是微信开源出来的热更新框架,Bugly也是在tinker的基础上进行了响应的封装和处理,集成到自己的sdk中。tinker在热更新的领域还是有一定的权威(看微信就可以了),附上tinker:Github地址 Tinker-接入指南。有兴趣的可以研究一下。

在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指代最新版本号,也可以指定明确的版本号,例如2.3.2
          compile 'com.tencent.bugly:crashreport_upgrade:1.3.1'
          compile 'com.tencent.bugly:nativecrashreport:latest.release' //其中latest.release指代最新版本号,也可以指定明确的版本号,例如2.2.0
      }

注意: 升级SDK已经集成crash上报功能,已经集成Bugly的用户需要注释掉原来Bugly的jcenter库; 已经配置过符号表的Bugly用户保留原有符号表配置; Bugly SDK(2.1.5及以上版本)已经将Java Crash和Native Crash捕获功能分开,如果想使用NDK库,需要配置: compile ‘com.tencent.bugly:nativecrashreport:latest.release’

在app module的“build.gradle”文件中添加:

// 依赖插件脚本
apply from: 'tinker-support.gradle'

注意:这个tinker-support.gradle需要我们自己新写一个,和app moudule的build.gradle保持同级。

所有关于依赖的添加这有这三处,项目的build.gradle有一处,app的build.gradle有两处。接下来就可以进行代码的相关改动了。

2. 代码改动

新建tinker-support.gradle

首先自己新建一个在app build.gradle中依赖的tinker-support.gradle(注意:保持与build.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

}

/**
 * 一般来说,我们无需对下面的参数做任何的修改
 * 对于各参数的详细介绍请参考:
 * 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的分配
    }
}

改动Application

根据官方的说法,改动Application有两种方式。采用两种方式有一个依据:就是tinker-support.gradle–>tinkerSupport–>enableProxyApplication,在注释中我们也已经看到了“是否开启反射Application模式”

enableProxyApplication = true
这种设置对于Application的改动很少,我也是采用这种方式的,但是官方的说法是:这种方式适配性不是很好,但是对于我们项目来说,对于改动Application成本很高,可能会发生一些不可预见的问题,因此我采用了这种方式。只需在自己原有的项目中的Application中进行改动即可。注:无须你改造Application,主要是为了降低接入成本,我们插件会动态替换AndroidMinifest文件中的Application为我们定义好用于反射真实Application的类(需要您接入SDK 1.2.2版本 和 插件版本 1.0.3以上)

public class MyApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        // 这里实现SDK初始化,appId替换成你的在Bugly平台申请的appId
        // 调试时,将第三个参数改为true
        Bugly.init(this, "900029763", false);
    }

    @Override
    protected void attachBaseContext(Context base) {
        super.attachBaseContext(base);
        // you must install multiDex whatever tinker is installed!
        MultiDex.install(base);


        // 安装tinker
        Beta.installTinker();
    }

}

enableProxyApplication = false
这是Tinker推荐的接入方式,一定程度上会增加接入成本,但具有更好的兼容性。

集成Bugly升级SDK之后,我们需要按照以下方式自定义ApplicationLike来实现Application的代码(以下是示例):

自定义Application

public class SampleApplication extends TinkerApplication {
    public SampleApplication() {
        super(ShareConstants.TINKER_ENABLE_ALL, "xxx.xxx.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:loaderClassNameTinker的加载器,使用默认即可
参数4:tinkerLoadVerifyFlag 加载dex或者lib是否验证md5,默认为false

这里的的处理就是:把你自己的Application继承这个TinkerApplication类,只写这么一个构造方法,之前你自己在Application中的所有实现方法都放在一个新写的类中,新文件地址保持和构造方法中的一致。

自定义ApplicationLike

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();
        // 这里实现SDK初始化,appId替换成你的在Bugly平台申请的appId
        // 调试时,将第三个参数改为true
        Bugly.init(getApplication(), "900029763", false);
    }


    @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);
    }

}

注意:tinker需要你开启MultiDex,你需要在dependencies中进行配置compile “com.android.support:multidex:1.0.1”才可以使用MultiDex.install方法; SampleApplicationLike这个类是Application的代理类,以前所有在Application的实现必须要全部拷贝到这里,在onCreate方法调用SDK的初始化方法,在onBaseContextAttached中调用Beta.installTinker(this);。

以上就是关于如何引入和配置Bugly热更新的相关操作,接下来说一下如何打基准包和补丁包的操作。

3.打包

在打包之前我要说一下什么是基准包、补丁包以及他们之间关联的相关机制,关于打包的所有操作都在tinker-support.gradle中进行相关操作,打包不是采用gradle命令,而是直接借助AS中gradle的图形界面,这样省去我们很多熟悉tinker相关命令的时间。

基准包

对于打基准包只需要改动一处就可以,当你觉得你的代码没有问题了,可以发布上线了,将tinker-support.gradle–>tinkerSupport–>tinkerId改成你自定义的内容。image
tinkerId最好是一个唯一标识,例如git版本号、versionName等等。如果你要测试热更新,你需要对基线版本进行联网上报。

这里强调一下,基线版本配置一个唯一的tinkerId,而这个基线版本能够应用补丁的前提是集成过热更新SDK,并启动上报过联网,这样我们后台会将这个tinkerId对应到一个目标版本,例如tinkerId = “bugly_1.0.0” 对应了一个目标版本是1.0.0,基于这个版本打的补丁包就能匹配到目标版本。

执行assembleRelease编译生成基准包:
image
这个会在build/outputs/bakApk路径下生成每次编译的基准包、混淆配置文件、资源Id文件,如下图所示:
image

实际应用中,请注意保存线上发布版本的基准apk包、mapping文件、R.txt文件,如果线上版本有bug,就可以借助我们tinker-support插件进行补丁包的生成。

启动apk,上报联网数据

我们每次冷启动都会请求补丁策略,会上报当前版本号和tinkerId,这样我们后台就能将这个唯一的tinkerId对应到一个版本,大家测试的时候可以打开logcat查看我们的日志,如下图所示:
image 如果看不到log,您需要将bugly初始化的第三个参数设置为true才能看到。

这时我们已经生成了可以发版的包,并且已经发布上线。但突然出现了问题,很紧急!!!需要紧急修复,这就需要我们生成补丁包进行bug修复。接下来将补丁包的生成操作。

补丁包

我这里讲多渠道(gradle配置productFlavors方式)生成补丁包的操作,在生成补丁包时,只需在tinker-support.gradle修改三个地方
image

  1. baseApkDir:修改成你生成的基准包的那个目录(直接粘过来就可以)
  2. tinkerSupport–>tinkerId:改成自定义的(与基准包时定义的不同)。
  3. 打开buildAllFlavorsDir = “${bakPath}/${baseApkDir}”的注释,这个在打基准包的时候是被注释掉的

执行buildAllFlavorsTinkerPatchRelease生成所有渠道补丁包
image
生成的7zip包就是生成的补丁包,接下来就可以去上传分发了。到这里也就全都结束了。更多详细请移步Bugly官方文档。谢谢大家!!!