Android--腾讯Bugly集成文档（吐槽版）

转载请声明地址：http://blog.csdn.net/skyunicorn/article/details/77905736

本文是在原有的Bugly官方文档上进行修改（吐槽）而成

官方开发文档：https://bugly.qq.com/docs/user-guide/instruction-manual-android-hotfix/?v=20170815114059

准备好入坑了么？没准备好的，先去吃个糖压压惊ヽ(*。>Д<)o゜゜゜

介绍（一些废话，看看即可）

热更新能力是Bugly为解决开发者紧急修复线上bug，而无需重新发版让用户无感知就能把问题修复的一项能力。Bugly目前采用微信Tinker的开源方案，开发者只需要集成我们提供的SDK就可以实现自动下载补丁包、合成、并应用补丁的功能，我们也提供了热更新管理后台让开发者对每个版本补丁进行管理。

为什么使用Bugly热更新？（一些废话，看看即可）

· 无需关注Tinker是如何合成补丁的

· 无需自己搭建补丁管理后台

· 无需考虑后台下发补丁策略的任何事情

· 无需考虑补丁下载合成的时机，处理后台下发的策略

· 我们提供了更加方便集成Tinker的方式

· 我们通过HTTPS及签名校验等机制保障补丁下发的安全性

· 丰富的下发维度控制，有效控制补丁影响范围

· 我们提供了应用升级一站式解决方案

视频教程（一些废话，看看即可）

为了让开发者能够更加直观的学习如何接入Bugly热更新能力，我们Bugly开发了这样的一套关于热更新接入的教程：

课程1：Bugly热更新介绍

课程2：tinker-support插件使用

课程3：集成升级SDK

课程4：生成补丁包之痛我懂你

课程5：补丁包为何上传不上去？

课程6：普通打包的热更新、

课程7：渠道包的热更新

课程8：加固的热更新

 

一、使用指南

第一步：添加插件依赖

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

 

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        // tinkersupport插件, 其中lastest.release指拉取最新版本，也可以指定明确版本号，例如1.0.4
          // 一般用latest.release即可(!!!尼玛坑啊，一会lastest，一会latest到底哪个，我测试用latest没报错)               
        //classpath "com.tencent.bugly:tinker-support:1.0.8"
        classpath "com.tencent.bugly:tinker-support:latest.release"
}
}

注意：自tinkersupport 1.0.3版本起无需再配tinker插件的classpath。（一些废话，看看即可）

版本对应关系: tinker-support 1.0.8 对应 tinker 1.7.11

tinker-support 1.0.7 对应 tinker 1.7.9

tinker-support 1.0.4 对应 tinker 1.7.7

tinker-support 1.0.3 对应 tinker 1.7.6

tinker-support 1.0.2 对应 tinker 1.7.5（需配置tinker插件的classpath）

第二步：集成SDK

gradle配置

在app module的“build.gradle”文件中添加（示例配置）：

android {
        defaultConfig {
          ndk {
            //设置支持的SO库架构，模拟器需要‘x86’,‘armeabi-v7a’
            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:latest.release'
          compile 'com.tencent.bugly:nativecrashreport:latest.release' //其中latest.release指代最新版本号，也可以指定明确的版本号，例如2.2.0
      }

配置singingConfigs和buildTypes时要注意，singingConfigs必须在buildTypes前面(巨坑：我已经被坑过了，貌似用它的方法打包必须要配置这个)

// 签名配置
    signingConfigs {
        release {
            try {
                storeFile file("./keystore/keyStore.jks")
                storePassword "123123"
                keyAlias "key0"
                keyPassword "123123"
            } catch (ex) {
                throw new InvalidUserDataException(ex.toString())
            }
        }

//        debug {
//            storeFile file("./keystore/debug.keystore")
//        }
    }

    buildTypes {
        release {
            minifyEnabled true
            signingConfig signingConfigs.release
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
//        debug {
//            debuggable true
//            minifyEnabled false
//            signingConfig signingConfigs.debug
//        }
    }

后续更新升级SDK时，只需变更配置脚本中的版本号即可。（一些废话，看看即可，因为这是针对已经集成Bugly的用户，我们是最新版的）

注意：升级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 plugin: 'com.android.application'
// 依赖插件脚本
apply from: 'tinker-support.gradle'

tinker-support.gradle内容如下所示（示例配置，照抄就是）：

注：您需要在同级目录下创建tinker-support.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的分配
    }
}

基准包的路径

 

文件夹名字就是def baseApkDir = "app-0208-15-10-00"这里应该填写的（如何生成基准包，后面会说）

 

更详细的配置项参考tinker-support配置说明（闲的可以去看看，我是没看）

第三步：初始化SDK

enableProxyApplication = false 的情况

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

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

自定义Application

"xxx.xxx"是SampleApplicationLike的包名，不解释。

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：loaderClassName Tinker的加载器，使用默认即可
参数4：tinkerLoadVerifyFlag 加载dex或者lib是否验证md5，默认为false

我们需要您将以前的Applicaton配置为继承TinkerApplication的类：

自定义ApplicationLike（照抄就是了，改个appId即可）

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
	// 这第二个参数是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);。

enableProxyApplication = true 的情况（没看，就是阉割版的意思）

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

}

注：无须你改造Application，主要是为了降低接入成本，我们插件会动态替换AndroidMinifest文件中的Application为我们定义好用于反射真实Application的类（需要您接入SDK 1.2.2版本 和 插件版本 1.0.3以上）。

第四步：AndroidManifest.xml配置

在AndroidMainfest.xml中进行以下配置：

1. 权限配置

2. Activity配置（必配，框架里自带的Activity，无需新建）

3. 配置FileProvider

注意：如果您想兼容Android N或者以上的设备，必须要在AndroidManifest.xml文件中配置FileProvider来访问共享路径的文件。

像这样

如果你使用的第三方库也配置了同样的FileProvider, 可以通过继承FileProvider类来解决合并冲突的问题，示例如下：

这里要注意一下，FileProvider类是在support-v4包中的，检查你的工程是否引入该类库。

在res目录新建xml文件夹，创建provider_paths.xml文件如下：（照抄就是）

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

这里配置的两个外部存储路径是升级SDK下载的文件可能存在的路径，一定要按照上面格式配置，不然可能会出现错误。

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

第五步：混淆配置

为了避免混淆SDK，在Proguard混淆文件中增加以下配置：

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

如果你使用了support-v4包，你还需要配置以下混淆规则：

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

二、接入流程

 

完整接入流程

· 打基准包安装并上报联网（注：填写唯一的tinkerId）（再注：根本没什么卵用，后面会说明）

· 对基准包的bug修复（可以是Java代码变更，资源的变更）

· 修改基准包路径、修改补丁包tinkerId、mapping文件路径（如果开启了混淆需要配置）、resId文件路径

· 执行buildTinkerPatchRelease打Release版本补丁包

· 选择app/build/outputs/patch目录下的补丁包并上传（注：不要选择tinkerPatch目录下的补丁包，不然上传会有问题）

· 编辑下发补丁规则，点击立即下发

· 杀死进程并重启基准包，请求补丁策略（SDK会自动下载补丁并合成）

· 再次重启基准包，检验补丁应用结果

· 查看页面，查看激活数据的变化

普通打包

1、编译基准包

配置基准包的tinkerId

（以下了解下就好，没什么卵用）

tinkerId最好是一个唯一标识，例如git版本号、versionName等等。 如果你要测试热更新，你需要对基线版本进行联网上报。

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

 

在这个文件中修改

修改tinkerId，按照官网的意思是基本包用base标识，补丁用patch（不用固定格式--感觉没什么卵用，注：史前巨坑,本以为是靠这个区分版本的，结果是在build里面通过versionName+versionCode拼接的版本号）

 

 

执行assembleRelease编译生成基准包：

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

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

启动apk，上报联网数据

我们每次冷启动都会请求补丁策略，会上报当前版本号和tinkerId，这样我们后台就能将这个唯一的tinkerId对应到一个版本，大家测试的时候可以打开logcat查看我们的日志，如下图所示：

如果看不到log，您需要将bugly初始化的第三个参数设置为true才能看到。

2、对基线版本的bug修复（只是举个例子）

未修复前（只是举个例子）

这个类有一个会造成空指针的方法。

修复后（只是举个例子）

对产生bug的类进行修复，作为补丁下次覆盖基线版本的类。

3、根据基线版本生成补丁包

修改待修复apk路径、mapping文件路径、resId文件路径

执行构建补丁包的task

如果你要生成不同编译环境的补丁包，只需要执行TinkerSupport插件生成的task，比如buildTinkerPatchRelease就能生成release编译环境的补丁包。 注：TinkerSupport插件版本低于1.0.4的，需要使用tinkerPatchRelease来生成补丁包 。

生成的补丁包在build/outputs/patch目录下：

大家这里可能会有一个疑问，补丁版本是怎么匹配到目标版本的，可以双击patch包，我们提供的插件会在tinker生成的patch包基础上插入一个MF文件：

4、上传补丁包到平台

上传补丁包到平台并下发编辑规则

点击发布新补丁，上传前面生成的patch包，我们平台会自动为你匹配到目标版本，你可以选择下发范围（开发设备、全量设备、自定义），填写完备注之后，点击立即下发让补丁生效，这样你就可以在客户端当中收到我们的策略，SDK会自动帮你把补丁包下到本地。

5、测试补丁应用效果

启动app应用patch

如果匹配到目标版本，后台就会下发补丁策略，可以在logcat看到如下日志：

下载成功之后，我们会立即去合成补丁，可以看到patch合成的日志：

重启app查看效果

注：我们方案是基于Tinker方案的实现，需要下次启动才能让补丁生效。

多渠道打包（了解下就好）

Bugly支持两种方式进行多渠道打包：

1.gradle配置productFlavors方式

2.多渠道打包工具打多渠道包方式（推荐）

方法1：gradle配置productFlavors方式

1. 配置productFlavors

android {
    ...

    // 多渠道打包（示例配置）
    productFlavors {
        xiaomi {
        }

        yyb {
        }
    }

  ...

}

2. 执行assembleRelease生成基线apk

按照普通打包方式正常配置基线版本的tinkerId，然后执行assembleRelease生成不同渠道的apk，会在工程中build/bakApk/生成如下图所示文件：

3. 打渠道补丁包配置

4.执行buildAllFlavorsTinkerPatchRelease生成所有渠道补丁包

如下图所示：

5.测试应用补丁包

与普通打包一致。

方法2：多渠道打包工具打多渠道包方式（推荐,注：官网推荐，不是我推荐）

多渠道工具打包方式，参考这篇文章：Bugly多渠道热更新解决方案

加固打包

需要集成升级SDK版本1.3.0以上版本才支持加固。

经过测试的加固产品：

1.腾讯乐固

2.爱加密

3.梆梆加固

4.360加固（SDK 1.3.1之后版本支持）

其他产品需要大家进行验证。

1.设置isProtectedApp参数

在tinker-support配置当中设置isProtectedApp = true，表示你要打加固的的apk。是否使用加固模式，仅仅将变更的类合成补丁。注意，这种模式仅仅可以用于加固应用中。

2.将基准包进行加固

如果你的app需要进行加固，你需要将你打出的基准包上传到具体的加固平台进行加固，例如乐固，加固完成之后需要对apk进行重签名：

jarsigner -verbose -keystore  -signedjar   

以上命令说明：
-verbose：指定生成详细输出
-keystore：指定证书存储路径
-signedjar：改选项的三个参数分别为签名后的apk包、未签名的apk包、数字证书别名

示例：

 jarsigner -verbose -keystore keystore/release.keystore -signedjar app-release-signed.apk app-release.encrypted.apk testres

如果你使用的加固产品提供了GUI的加固和签名工具，可以通过工具来进行加固和签名。

3.根据未加固的基准包生成补丁包

打patch包的操作跟普通打包方式一致。

注意：这里指定的基线版本是未加固的版本。

4.测试验证

测试验证的版本是经过加固并且已经重签名后的apk，安装到测试设备并上报联网，其他操作与普通打包无异。

 

 

三、结果

服务器推送后，前端会在任务后台自动下载，下载完成后会弹出提示，重启后生效

四、一些巨坑

1.关于加固（坑级：史诗级陨石巨坑）

 

使用360加固或者其他加固，必须打开加固模式（默认关闭）

 

打开加固模式后，必须加固才能更新成功，不然必崩（被坑了一下午有木有！！！

ヾ(｡｀Д´｡)）

 

在tinker-support.gradle里面

2.关于指定下发范围（坑级：小坑）

 

 

在SampleApplicationLike里面

3.关闭显示Toast信息和Log信息（坑级：小坑）

改为false

4.关于基版和补丁版本号问题（坑级：陨石巨坑）

官方文档竟然没有说明！！！现在的版本号不再是自己填写tinkerId（我已经测试过了），而是用的versionName+versionCode，e.g.：versionName是“1.0”，versionCode是5，拼接后是“1.0.5”，这么重要的事情，官方竟然没有说三遍（哪怕说一遍也可以啊

ヾ(。￣□￣)ﾂ゜゜゜）

 

 

5.关于配置(坑级：巨坑，一不小心就进去了)

配置singingConfigs和buildTypes时要注意，singingConfigs必须在buildTypes前面(巨坑：我已经被坑过了，貌似用它的方法打包必须要配置这个)

/ 签名配置
    signingConfigs {
        release {
            try {
                storeFile file("./keystore/keyStore.jks")
                storePassword "123123"
                keyAlias "key0"
                keyPassword "123123"
            } catch (ex) {
                throw new InvalidUserDataException(ex.toString())
            }
        }

//        debug {
//            storeFile file("./keystore/debug.keystore")
//        }
    }

    buildTypes {
        release {
            minifyEnabled true
            signingConfig signingConfigs.release
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
//        debug {
//            debuggable true
//            minifyEnabled false
//            signingConfig signingConfigs.debug
//        }
    }

同志们，前方还有更多的坑在等着你们，生命不息，大坑不止...