美文网首页
Tinker(bugly)热更新

Tinker(bugly)热更新

作者: 小妖sc | 来源:发表于2021-01-12 17:08 被阅读0次

    什么是热更新?

    热更新是为解决开发者紧急修复线上bug的一种方式,无需重新发版,用户无感知是他的特点。方式有很多种,其中Qzone、Tinker、AndFix、Robust是比较好的几种方式,本文主要着重介绍一下Bugly的集成和使用。(Bugly目前采用微信Tinker的开源方案,只需要集成对应的SDK就可以实现自动下载补丁包、合成、并应用补丁包的功能,也提供了热更新管理后台,对每个版本的补丁包进行管理)。

    热更新的集成

    1. 添加插件依赖

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

    buildscript {
        repositories {
            jcenter()
        }
        dependencies {
            // tinkersupport插件, 其中lastest.release指拉取最新版本,也可以指定明确版本号,例如1.0.4
            classpath "com.tencent.bugly:tinker-support:1.1.5"
        }
    }
    
    • 注意:自tinkersupport 1.0.3版本起无需再配tinker插件的classpath。

    版本对应关系:
    tinker-support 1.1.3 对应 tinker 1.9.8
    tinker-support 1.1.2 对应 tinker 1.9.6
    tinker-support 1.1.1 对应 tinker 1.9.1
    tinker-support 1.0.9 对应 tinker 1.9.0
    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)

    2. 集成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:2.1.5'
              compile 'com.tencent.bugly:crashreport_upgrade:1.3.6'
              // 指定tinker依赖版本(注:应用升级1.3.5版本起,不再内置tinker)
              compile 'com.tencent.tinker:tinker-android-lib:1.9.9'
              compile 'com.tencent.bugly:nativecrashreport:2.2.0' //其中latest.release指代最新版本号,也可以指定明确的版本号,例如2.2.0
          }
    
    • 后续更新升级SDK时,只需变更配置脚本中的版本号即可。

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

    在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 buildTime() {
        return new Date().format("MMdd-HH-mm-ss", TimeZone.getTimeZone("GMT+8"))
    }
    
    /**
     * 此处填写每次构建生成的基准包目录
     */
    def baseApkDir = "app-0910-16-44-28"
    def myTinkerId = "base-" + rootProject.ext.android.versionName  // 用于生成基准包(不用修改)
    //def myTinkerId = "patch-" + rootProject.ext.android.versionName  // 用于生成补丁包(每次生成补丁包都要修改一次,最好是 patch-${versionName}.x.x)
    
    /**
     * 对于插件各参数的详细解析请参考
     */
    tinkerSupport {
    
        // 开启tinker-support插件,默认值true
        enable = true
    
        // 是否启用加固模式,默认为false.(tinker-spport 1.0.7起支持)
        // isProtectedApp = true
    
        // 是否开启反射Application模式
        enableProxyApplication = true
    
        // 是否支持新增非export的Activity(注意:设置为true才能修改AndroidManifest文件)
        supportHotplugComponent = 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 = "${myTinkerId}"
    
        // 构建多渠道补丁时使用
        // buildAllFlavorsDir = "${bakPath}/${baseApkDir}"
    
    }
    
    /**
     * 一般来说,我们无需对下面的参数做任何的修改
     * 对于各参数的详细介绍请参考:
     * 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的分配
        }
    }
    

    3. 初始化SDK

    enableProxyApplication = false 的情况

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

    自定义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 的情况
    /**
     * @作者 luckly
     * @创建日期 2019/9/2 10:14
     */
    public class MyApplication extends Application {
        @Override
        public void onCreate() {
            super.onCreate();
            // 这里实现SDK初始化,appId替换成你的在Bugly平台申请的appId
            // 调试时,将第三个参数可以根据当前Android Studio 的包是否是debug包来控制开启和关闭
            Bugly.init(this, BuildConfig.DEBUG ? BUGLY_ID_DEBUG : BUGLY_ID, BuildConfig.DEBUG);
            //Bugly.setIsDevelopmentDevice(getApplicationContext(), true);
        }
    
        @Override
        protected void attachBaseContext(Context base) {
            super.attachBaseContext(base);
            // you must install multiDex whatever tinker is installed!
            MultiDex.install(base);
            // 安装tinker
            // 此接口仅用于反射Application方式接入。
            Beta.installTinker();
        }
    
        @TargetApi(Build.VERSION_CODES.ICE_CREAM_SANDWICH)
        public void registerActivityLifecycleCallback(Application.ActivityLifecycleCallbacks callbacks) {
            getApplication().registerActivityLifecycleCallbacks(callbacks);
        }
    }
    

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

    4. AndroidManifest.xml配置

    在AndroidMainfest.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" />
    
    • Activity配置
    <activity
        android:name="com.tencent.bugly.beta.ui.BetaActivity"
        android:configChanges="keyboardHidden|orientation|screenSize|locale"
        android:theme="@android:style/Theme.Translucent" />
    
    • 配置FileProvider
      注意:如果您想兼容Android N或者以上的设备,必须要在AndroidManifest.xml文件中配置FileProvider来访问共享路径的文件。
     <provider
        android:name="android.support.v4.content.FileProvider"
        android:authorities="${applicationId}.fileProvider"
        android:exported="false"
        android:grantUriPermissions="true">
        <meta-data
            android:name="android.support.FILE_PROVIDER_PATHS"
            android:resource="@xml/provider_paths"/>
    </provider>
    

    如果你使用的第三方库也配置了同样的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配置了,并且包含了对应的资源文件。

    5. 混淆配置

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

    -dontwarn com.tencent.bugly.**
    -keep public class com.tencent.bugly.**{*;}
    # tinker混淆规则
    -dontwarn com.tencent.tinker.**
    -keep class com.tencent.tinker.** { *; }
    

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

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

    6. 代码示例

    本示例其中只包含 enableProxyApplication = true 的情况,false 的情况如果有需要后续会添加:
    Github 地址

    相关文章

      网友评论

          本文标题:Tinker(bugly)热更新

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