Bugly Tinker接入步骤和遇到的问题

最近项目中需要接入热更新,在接入Bugly Tinker过程中遇到了很多问题,在此记录下,同时建议如果APP用户量不是非常大的还是接入阿里的Sophix吧,每月5万台设备免费,而且问题也没有这么多...

一.接入步骤,TinkerSupport和tinker插件的对应关系在Bugly官网 更新日志页面查询

1. 项目根目录build.gradle添加依赖

  //tinkersupport
  classpath "com.tencent.bugly:tinker-support:1.2.0"

2. 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指代最新版本号，也可以指定明确的版本号，例如1.3.4
          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:latest.release' //其中latest.release指代最新版本号，也可以指定明确的版本号，例如2.2.0
      }

3.添加tinker依赖插件脚本到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-0803-16-53-32"

/**
 * 对于插件各参数的详细解析请参考
 */
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"
    //建议设置true,用户就不用再自己管理tinkerId的命名,插件会为每一次构建的base包自动生成唯一的tinkerId，默认命名规则是versionname.versioncode_时间戳
    //具体参考https://github.com/BuglyDevTeam/Bugly-Android-Demo/wiki/Tinker-ID%E8%AF%A5%E6%80%8E%E4%B9%88%E8%AE%BE%E7%BD%AE
    autoGenerateTinkerId = true
    // 构建基准包和补丁包都要指定不同的tinkerId，并且必须保证唯一性
    tinkerId = "if autoGenerateTinkerId=true ,no need set here"

    // 构建多渠道补丁时使用
    // 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的分配
    }
}

4. 在AndroidMainfest.xml中添加权限

5. 添加混淆配置,在app module中的proguard-rules.pro

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

5.初始化SDK

5.1 enableProxyApplication = false 的情况

自定义Application
xxx.xxx.SampleApplicationLike 修改为自己的包名对应位置的SampleApplicationLike

public class SampleApplication extends TinkerApplication {
    public SampleApplication() {
        super(ShareConstants.TINKER_ENABLE_ALL, "xxx.xxx.SampleApplicationLike",
                "com.tencent.tinker.loader.TinkerLoader", false);
    }
}

修改AndroidManifest中application的name为SampleApplication

自定义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,Android 21以上自带MultiDex 在app module下的build.gradle - defaultConfig下添加multiDexEnabled true

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

}

二.生成基准包和补丁包步骤

2.1 生成基准包

gradler中点击assembleRelease或直接Generate signed APK,生成后的文件会在app-build-bakApk目录下,按照生成时间命令文件夹,基准包需要保存好.

tinker_01.png

2.2 生成补丁包

• 在改好bug后,修改tinker-support.gradle中的def baseApkDir = "app-0803-16-53-32"为基准包的文件夹名称,tinkerId由于已经设置了autoGenerateTinkerId = true,因此不需要自己修改

• 点击Gradle选项中的tinker-support,选择buildTinkerPatchRelease,等待生成补丁包完成

tinker_02.png

• 如 果一切正常,生成的补丁包会在app-build-outputs-patch-release目录下,选择patch_signed.apk或patch_signed_7zip.apk上传到bugly平台的热更新中即可.

tinker_03.png

三.tinker生成补丁包中出现的问题

1.签名配置 can't the get signConfig for this build

签名没有配置正确,除需要在app module-android下配置signingConfigs和buildTypes外,在defaultConfig下添加signingConfig signingConfigs.release

tinker_04.png

2.提交补丁时提示未匹配到可应用补丁包的APP版本

• 基准包需要安装并且联网运行一次,才能上报到bugly

• 如果是Android P以上的版本,基准包运行后也会发现无法上报到bugly,查看日志会提示Cleartext HTTP traffic to android.bugly.qq.com not permitted,解决方法如下:

  在res目录下新建xml文件夹,新建文件network_security_config.xml,然后在AndroidManifest.xml application标签下加上:
  android:networkSecurityConfig="@xml/network_security_config"然后重新打包运行即可.

3.运行assembleDebug时提示”错误: 无法访问Keep 找不到android.support.annotation.Keep的类文件

tinker-android-anno-1.9.14.5使用了supprot包的@keep，应该是androidx和suport包不能并存，可将当前工程和依赖包都统一为androidx，在gradle.properties添加以下配置试试

android.useAndroidX=true
android.enableJetifier=true

4.生成补丁包时提示can't find tinkerProcessReleaseManifest, you must init tinker plugin first!

Tinker目前还不支持Gradle 5.x，需要降低Gradle版本

1.修改gradle文件夹下的gradle-wrapper.properties版本

distributionUrl=https://services.gradle.org/distributions/gradle-5.6.4-all.zip

2.修改项目根目录下的build.gradle中gradle依赖版本为

classpath "com.android.tools.build:gradle:3.5.3"

5. 警告Warning:ignoreWarning is false, but we found loader classes are found in old secondary dex. Found classes: {Lcom/tencent/tinker/loader/R;}

降低minSdkVersion版本到21有效解决

defaultConfig {
        applicationId "xxx"
        minSdkVersion 21
        targetSdkVersion 29
        versionCode 1
        versionName "1"
}

6.加固版本生成基准包步骤,先在官网确认bugly支持的加固产品和版本

• 5.1 打补丁包时tinker-support中isProtectedApp = true需要打开

• 5.2 tinker-support 填写加固前的基准包目录,生成补丁包上传到bugly

7.上传补丁到Bugly热更新平台时提示上传失败，文件不合法，请上传有效的补丁包文件

• 补丁文件名称过长导致,例如xxx-V5.0.202000000-111570-release-patch_signed_7zip.apk,修改补丁文件名称后解决
• 生成的补丁文件中不包含YAPATCH.MF文件,需要重新生成补丁尝试
• 平台抽风,需要换个时间再尝试