bugly热修复集成及遇到的问题

bugly热修复集成

Bugly热修复官方网址点这里

Tinker官方github网址点这里

以下为官方文档的整理,遇到问题的同学可以直接翻到最下面遇到的问题

第一步:添加插件依赖

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

    repositories {

        jcenter()

    }

    dependencies {

        // tinkersupport插件, 其中lastest.release指拉取最新版本,也可以指定明确版本号,例如1.0.4

        classpath "com.tencent.bugly:tinker-support:1.1.2"

    }

}

第二步:集成SDK

gradle配置

1. 在app module的“build.gradle”文件中添加(示例配置):

android {

        defaultConfig {

          ndk {

            //设置支持的SO库架构

            abiFilters 'armeabi' //, 'x86', 'armeabi-v7a', 'x86_64', 'arm64-v8a'

          }

        }

      }

      dependencies {

          implementation "com.android.support:multidex:1.0.1" // 多dex配置

          implementation 'com.tencent.bugly:crashreport_upgrade:1.3.5'

          implementation 'com.tencent.tinker:tinker-android-lib:1.9.6'

          implementation 'com.tencent.bugly:nativecrashreport:latest.release' 
      }

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

// 依赖插件脚本

apply from: 'tinker-support.gradle'

3\. 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

    // 是否支持新增非export的Activity(注意:设置为true才能修改AndroidManifest文件)

    supportHotplugComponent = true

}

/**

* 一般来说,我们无需对下面的参数做任何的修改

* 对于各参数的详细介绍请参考:

* 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

1. 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);。

2. 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配置


3. 配置FileProvider

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



    


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



    


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

在res目录新建xml文件夹,创建provider_paths.xml文件如下:





    

    

    

    


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

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

第五步:混淆配置

为了避免混淆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.**{*;}

第六步: 注意事项

除了官方的FAQ以外还遇到一下问题:

  • Q: ERROR: Java 8 language support, as requested by 'android.enableD8.des...

    A: gradle.properties中添加

# Project-wide Gradle settings.

# IDE (e.g. Android Studio) users:

# Gradle settings configured through the IDE *will override*

# any settings specified in this file.

# For more details on how to configure your build environment visit

# http://www.gradle.org/docs/current/userguide/build_environment.html

# Specifies the JVM arguments used for the daemon process.

# The setting is particularly useful for tweaking memory settings.

org.gradle.jvmargs=-Xmx1536m

# When configured, Gradle will run in incubating parallel mode.

# This option should only be used with decoupled projects. More details, visit

# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects

# org.gradle.parallel=true

# 添加如下两行可正常编译,有警告不影响运行

android.enableD8.desugaring = true

android.useDexArchive = true
  • Q: IDE 找不到DefaultApplicationLike,报错

    A: import中删除原来的引入,重新导入,由于升级换包名导致的问题

  • Q: 打出的基线版本后,上传bugly的升级补丁报红,找不到对应基线版本

    A::在tinker-support.gradle中的tinkerid配置的基线版本需要先启动

若还无法解决,则需要检查代码,apk包中的AndroidManifest.xml中最下面的tinker_id是否能对应上,具体生成基线版本和对应补丁以及上传补丁的步骤请参考官方文档说明

  • Q: 补丁包可下载并合并,但重启时候报异常无法启动一直停留在LaunchActivity或HomeActivity:

并报异常java.lang.VerifyError: Verifier rejected class。

A: bugly封装的tinker在tinker-support.gradle中配置enableProxyApplication = false情况下会使用ApplicationLike实现代替原有Application的功能,所以按照官方文档指导,把原来在application中实现的方法全部移动到自己定义的ApplicationLike中,由于涉及到改动太大,所以项目中未采用,使用的是enableProxyApplication = true

  • Q:在小米设备上出现无法下载补丁,Exception in run JobService类似日志

    A: 需要在设置中开启app自启动即可下载补丁

你可能感兴趣的:(bugly热修复集成及遇到的问题)