美文网首页
Bugly热更新接入的详细流程

Bugly热更新接入的详细流程

作者: 王学宏 | 来源:发表于2017-07-21 11:54 被阅读0次

    热修复说白了就是”及时无感打补丁”,比如公司上线一个app,用户反应有重大bug,需要紧急修复。
    2015年以来,Android开发领域里对热修复技术的讨论和分享越来越多,同时也出现了一些不同的解决方案.如果按照通常做法,那就是程序猿加班搞定bug,然后测试,重新打包并发布。这样带来的问题就是成本高,效率低。于是,热修复就应运而生.一般通过事先设定的接口从网上下载无Bug的代码来替换有Bug的代码。这样就省事多了,用 户体验也好。目前热修复尽管有很多坑,做了好多工作,可能吃力不讨好,各种适配可能还是没修复线上的有些Bug。
    热修复技术,可以看做是Android平台发展成熟至一定阶段的必然产物。它是一种维护流量、对用户打搅极小的技术应用,其出现的逻辑无一不蕴含了一个事实:无线应用已发展到一个新阶段,即如何更好维护昂贵的流量。

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

    而在Android平台上,业界除阿里系之外,比较著名的热修复还有:腾讯QQ 空间的超级补丁技术、 微信的Tinkr、 饿了么的Amigo、美团的Robust等等。不 过他们各自高自身的局限性, 或者不够稳定, 或者补丁过大, 或者效率低下, 或者使 用起来迫于繁琐,大部分技术上看起来似乎可行,但实际体验并不好。

    Paste_Image.png

    第一步:添加插件依赖

    导入bugly jar包 , build.gradle(Project)文件下面添加

    buildscript {
        repositories {
            jcenter()
        }
        dependencies {
            classpath 'com.android.tools.build:gradle:2.3.2'
    
            // NOTE: Do not place your application dependencies here; they belong
            // in the individual module build.gradle files
            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 {
        // 本地集成aar方式
    //    compile fileTree(dir: 'libs', include: ['**.*'])
    //    compile(name: 'bugly_crashreport_upgrade-1.3.0', ext: 'aar')
        // 多dex配置//注释掉原有bugly的仓库  必须依赖multidex才可以使用
        //    MultiDex.install(base);
        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/")
    
    /**
     * 此处填写每次构建生成的基准包目录
     */
    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的分配
        }
    }
    
    

    更详细的配置项参考tinker-support配置说明

    第三步:初始化SDK

    enableProxyApplication = false 的情况
    

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

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

    自定义MyApplication

    public class MyApplication extends TinkerApplication implements
            Enviroment.EnviromentCallback, ActivityLifecycleCallbacks{
    
        public MyApplication() {
            super(ShareConstants.TINKER_ENABLE_ALL, "cn.eagleview.glasssync.global.MyApplicationLike",
                    "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
    

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

    Paste_Image.png

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

    接入非常的简单,有兴趣可以自己参考 Bugly热更新文档

    第四步:AndroidManifest.xml配置

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

    1. 权限配置
    
        <!--Bugly升级SDK权限配置开始-->
        <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"/>
        <!--Bugly升级SDK权限配置结束-->
    

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

            <!--配置升级的能力-->
            <!-- Bugly升级SDK配置开始  -->
            <activity
                android:name="com.tencent.bugly.beta.ui.BetaActivity"
                android:theme="@android:style/Theme.Translucent"/>
            <!-- com.tencent.bugly.hotfix.easy.fileProvider  -->
            <!-- android:authorities="${applicationId}.fileProvider"  -->
            <provider
                android:name="android.support.v4.content.FileProvider"
                android:authorities="cn.eagleview.glasssync.hotfix.easy.fileProvider"
                android:exported="false"
                android:grantUriPermissions="true">
                <meta-data
                    android:name="android.support.FILE_PROVIDER_PATHS"
                    android:resource="@xml/provider_paths"/>
            </provider>
            <!-- Bugly升级SDK配置结束-->
            <!--配置升级的能力-->
    

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

    <provider
        android:name=".utils.BuglyFileProvider"
        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>
    

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

    在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>
    

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

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

    第五步:混淆配置

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

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

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

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

    注意:如果使用了第三方的jar包如果混淆出错,在里面添加避免混淆即可

    第六步:配置签名文件keystore

        // 签名配置
        signingConfigs {
            release {
                try {
                    storeFile file("./keystore/release.keystore")
                    storePassword "testres"
                    keyAlias "testres"
                    keyPassword "testres"
                } catch (ex) {
                    throw new InvalidUserDataException(ex.toString())
                }
            }
    
            debug {
                storeFile file("./keystore/debug.keystore")
            }
        }
    
     //构建类型,签名需要配置signingConfig
        buildTypes {
            release {
                zipAlignEnabled true
                minifyEnabled true       //是否开启混淆
                shrinkResources true  //移除无用的资源文件
                signingConfig signingConfigs.release
                proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
            }
            debug{
                debuggable true
                minifyEnabled false
                signingConfig signingConfigs.debug
            }
        }
    

    温馨提示 需要引入:

    Paste_Image.png

    第七步:打基准包和补丁包

    Paste_Image.png

    打基准包需要注意的是

        // 构建基准包和补丁包都要指定不同的tinkerId,并且必须保证唯一性
        tinkerId = "base-1.0.1"
    

    打补丁包需要注意的是

    /**
     * 此处填写每次构建生成的基准包目录
     */
    def baseApkDir = "app-0612-12-23-05"
    
                      ·
                      ·
                      ·
    
        // 构建基准包和补丁包都要指定不同的tinkerId,并且必须保证唯一性
        tinkerId = "patch-1.0.1"
    
    

    对应生成的文件如下图所示:

    Paste_Image.png

    注意:
    上传补丁时,必须先连网运行一次基准包,否则上传补丁时会找不到版本。。
    上传的补丁必须是patch_signew_7zip.apk文件,不能是另外两个。。

    第八步:上传补丁包

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

    Paste_Image.png Paste_Image.png

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

    提醒:自定义只允许输入 > 、> =、=、< 、< = 及数字、小数点、分号(;) 比如只允许下发系统版本大于等于5.0设备和小于等于7.0设备 :>= 5.0;<=7.0

    Paste_Image.png Paste_Image.png Paste_Image.png

    最终如果运行我们带有Bug的App,并且匹配到目标版本以后,后台就会下发补丁策略,可以在logcat看到日志:

    Paste_Image.png

    下载成功之后,会立即去合成补丁,可以看到patch合成的日志:

    Paste_Image.png

    注:Bugly热修复方案是基于Tinker方案实现的,必须重启我们的App,补丁才会生效。。

    使用范例:
    大家如果想测试验证热更新能力,请仔细查看以下文档:
    热更新使用范例
    常见问题:
    大家如果在使用我们Bugly热更新遇到问题,请先查看FAQ:
    热更新常见问题

    附件 :阿里热修复 直接参考阿里官网

    Tinker热修复 可参考鸿洋_的Android 热修复 Tinker接入及源码浅析

    Amigo热修复 有兴趣可参考Amigo 源码解读

    参考文档的版权归原作者所有,本人是项目开发的笔记整理,借鉴之处还望各位大神见谅......

    相关文章

      网友评论

          本文标题:Bugly热更新接入的详细流程

          本文链接:https://www.haomeiwen.com/subject/smslqxtx.html