Bugly的使用

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

第一步：添加插件依赖
工程根目录下“build.gradle”文件中添加：

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

第二步：集成SDK
gradle配置

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

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

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

tinker-support.gradle内容如下所示（示例配置）：

apply plugin: 'com.tencent.bugly.tinker-support'def bakPath = file("${buildDir}/bakApk/")/*在本类中需要修改：* 1.baseApkDir* 2-4名称的修改* 2.baseApk* 3.baseApkProguardMapping* 4.baseApkResourceMapping* 5.tinkerId  编号必须一致* *//** * 此处填写每次构建生成的基准包目录  app/build/bakApk/app-0412-18-01-33 */def baseApkDir = "app-0413-11-40-46"/** * 对于插件各参数的详细解析请参考 */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  patch    tinkerId = "base-1.0.3"  //base-1.0.3 错误版本  patch-1.0.3 补丁版本   （1.0.3基准包和补丁包版本要一致）    // 构建多渠道补丁时使用    // buildAllFlavorsDir = "${bakPath}/${baseApkDir}"    // 是否开启反射Application模式    enableProxyApplication = false//使用SampleApplication和SampleApplicationLike    //enableProxyApplication = true//使用MyApplication}/** * 一般来说,我们无需对下面的参数做任何的修改 * 对于各参数的详细介绍请参考: * 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的分配    }}

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

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

自定义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);。

enableProxyApplication = true 的情况

public class MyApplication extends Application {    @Override    public void onCreate() {        super.onCreate();        // 这里实现SDK初始化，appId替换成你的在Bugly平台申请的appId        // 调试时，将第三个参数改为true  900029763自己申请的ID        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();    }}

第四步：AndroidManifest.xml配置
1. 权限配置

<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" /><uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>

第五步：混淆配置

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

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

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

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

bugly地址：https://bugly.qq.com/docs/user-guide/instruction-manual-android-hotfix/?v=20170322165254
Github Demo
https://github.com/BuglyDevTeam/Bugly-Android-Demo

普通打包
1、编译基准包
配置基准包的tinkerId

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

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

执行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方案的实现，需要下次启动才能让补丁生效。

多渠道打包

tinker是支持我们打多渠道的，建议大家按照以下步骤进行最佳实践：

1. 配置productFlavors

android {    ...    // 多渠道打包（示例配置）    productFlavors {        xiaomi {            applicationId 'com.tencent.bugly.hotfix.xiaomi'        }        yyb {            applicationId 'com.tencent.bugly.hotfix.yyb'        }    }  ...}

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

3. 打渠道补丁包配置

4.执行buildAllFlavorsTinkerPatchRelease生成所有渠道补丁包
如下图所示：

5.测试应用补丁包
与普通打包一致。

加固打包（仅支持tinker 1.7.5及以下）

tinker的一般模式需要Dex的合成，它并不支持加固，一定要使用加固的app可以使用usePreGeneratedPatchDex模式。由于加固会改变apk的dex结构，所以生成补丁包时我们务必要使用加固前的apk。
但是需要注意的是，某些加固工具会将非exported的四大组件的类名替换，对于这部分类即使使用usePreGeneratedPatchDex也无法修改。对于360加固，MainActivity由于被提前加载，也无法修复。大家对于加固的情况，请仔细测试，能否支持与加固的方式有关联。

1.提前生成dex配置
tinker是支持加固模式的，但需要你回退到Qzone方案 ，将usePreGeneratedPatchDex设置为true。

是否提前生成dex，而非合成的方式。这套方案即回退成Qzone的方案，对于需要使用加固或者多flavor打包(建议使用其他方式生成渠道包)的用户可使用。但是这套方案需要插桩，会造成Dalvik下性能损耗以及Art补丁包可能过大的问题，务必谨慎使用。另外一方面，这种方案在Android
N之后可能会产生问题，建议过滤N之后的用户。

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

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

3.根据加固的基准包生成补丁包
打patch包的操作跟普通打包方式一致。

demo下载自己测试：http://download.csdn.net/detail/u011531708/9812942

详解：
https://bugly.qq.com/docs/user-guide/instruction-manual-android-hotfix-demo/?v=20170322165254