当前位置: 首页 > 工具软件 > Walle > 使用案例 >

Bugly+Tinker+Walle系列集成记录

关玄裳
2023-12-01

前言
本文讲述了Android项目集成Bugly异常上报、运营统计和Tinker热修复方案以及Walle多渠道打包的一系列流程,用来记录本人在使用中的接入步骤和一些注意点。

Bugly文档中心
Tinker Wiki
Walle打包神器

添加插件依赖
工程根目录下“build.gradle”文件中添加:
classpath ‘com.android.tools.build:gradle:3.0.0’
// tinkersupport插件, 其中lastest.release指拉取最新版本,也可以指定明确版本号,例如1.0.4
classpath “com.tencent.bugly:tinker-support:latest.release”
classpath ‘com.tencent.bugly:symtabfileuploader:latest.release’//Bugly符号表插件
classpath ‘com.meituan.android.walle:plugin:1.1.3’//多渠道打包
}
集成SDK
在app module的“build.gradle”文件中添加(示例配置):
apply from: ‘tinker-support.gradle’
//Bugly符号表插件
apply plugin: ‘bugly’
//美团walle多渠道打包
apply plugin: ‘walle’

       defaultConfig {
       //不开启multiDex(需要用到设为true)
        multiDexEnabled false
     }
}
添加应用签名 (示例:)
        debug {
            storeFile file('keystore/MapleKeyStore.jks')
            storePassword "gaoguanqi"
            keyAlias "Maple"
            keyPassword "gaoguanqi"
        }
        release {
            storeFile file('keystore/MapleKeyStore.jks')
            storePassword "gaoguanqi"
            keyAlias "Maple"
            keyPassword "gaoguanqi"
        }
    }
buildTypes
            //移除无用的资源文件
            shrinkResources true
            zipAlignEnabled true
            minifyEnabled true
            signingConfig signingConfigs.release//需要使用正式证书签名,才能发布到fir.im
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
添加 配置
这里的appId 和 appKey 使用 自己项目的
    appId = '<6334cfd8b4>' // 注册时分配的App ID
    appKey = '<1bf9cf20-8e21-4bee-9d0d-ec93a05e282c>' // 注册时分配的App Key
}
//美团walle多渠道打包

    // 指定渠道包的输出路径
    apkOutputFolder = new File("${project.buildDir}/outputs/channels");
    // 定制渠道包的APK的文件名称
    apkFileNameFormat = '${appName}-${packageName}-${channel}-${buildType}-v${versionName}-${versionCode}-${buildTime}.apk';
    // 渠道配置文件
    channelFile = new File("${project.getProjectDir()}/channel")
}
添加依赖
//
/腾讯Bugly/
compile 'com.tencent.bugly:crashreport_upgrade:latest.release'
//latest.release指代最新版本号
compile 'com.android.support:multidex:1.0.1'
//多dex配置
implementation 'com.android.support:support-v4:26.1.0'
/渠道信息统计分析/
compile 'com.meituan.android.walle:library:1.1.3'

在app module的“build.gradle”文件的同级目录下创建“tinker-support.gradle”文件,
内容如下:

apply plugin: 'com.tencent.bugly.tinker-support'

def bakPath = file("${buildDir}/bakApk/")
/**
 * 此处填写每次构建生成的基准包目录
 * 打热更新包时会修改
 */
def baseApkDir = "app-1206-14-53-56"
/**
 * 对于插件各参数的详细解析请参考
 */
tinkerSupport {
    // 开启tinker-support插件,默认值true
    enable = true
    // 指定归档目录,默认值当前module的子目录tinker
    autoBackupApkDir = "${bakPath}"
    //是否支持新增非export的Activity added 1.9.0
    supportHotplugComponent = true
    // 是否启用覆盖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.2"
    //补丁包
    tinkerId = "patch-1.0.2"
    // 构建多渠道补丁时使用
    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配置说明

添加多渠道配置
在app module的“build.gradle”文件的同级目录下创建channel
meituan # 美团
samsungapps #三星

也可以添加更多渠道,这里只是示例。
由于集成了Bugly的异常上报,所以还需要通过以下方式来塞入渠道信息:即在SampleApplicationLike类中添加
  String channel = WalleChannelReader.getChannel(getApplication());
        Bugly.setAppChannel(getApplication(), channel);

        // 这里实现SDK初始化,appId替换成你的在Bugly平台申请的appId
        // 调试时,将第三个参数改为true
        Bugly.init(getApplication(), "6334cfd8b4", true);//初始化Bugly
关于Application
Bugly提供了两种方式,本人采用了Bugly推荐的非反射Application模式,即在“tinker-support.gradle”文件中设置“enableProxyApplication = false”;
这是Tinker推荐的接入方式,一定程度上会增加接入成本,但具有更好的兼容性。

首先我们需要按照以下方式自定义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

自定义ApplicationLike:
/**
 * 自定义ApplicationLike
 * 注意:tinker需要你开启MultiDex,你需要在dependencies中进行配置compile "com.android.support:multidex:1.0.1"
 * 才可以使用MultiDex.install方法; SampleApplicationLike这个类是Application的代理类,以前所有在Application的
 * 实现必须要全部拷贝到这里,在onCreate方法调用SDK的初始化方法,在onBaseContextAttached中调用Beta.installTinker(this);。

 */
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
        SmallCreditApp.getInstance().init(getApplication(), getApplication().getApplicationContext());
    }

    @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);
    }
}
在Application 中声明
application.png
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"/>

2. Activity配置
<activity
    android:name="com.tencent.bugly.beta.ui.BetaActivity"
    android:configChanges="keyboardHidden|orientation|screenSize|locale"
    android:theme="@android:style/Theme.Translucent" />

3. 配置FileProvider
注意:如果您想兼容Android N或者以上的设备,必须要在AndroidManifest.xml文件中配置FileProvider来访问共享路径的文件。如果你使用的第三方库也配置了同样的FileProvider,你需要将第三方库配置的路径copy到我们配置的provider_path文件下。

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

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

-dontwarn com.tencent.bugly.**
-keep public class com.tencent.bugly.**{*;}
如果你使用了support-v4包,你还需要配置以下混淆规则:

-keep class android.support.**{*;}
打出多渠道包
QQ截图20171207134140.png
生成渠道包和基准包
121212.png
我们把渠道包上线到各大应用市场
接下来应用出现了bug,我们需要紧急修复,通过Bugly定位异常并修复。
之前的做法是需要重新发布版本,现在我们不必因为一个bug而发布新版本。
我们要实现一个热更新包解决所有线上同一个版本的bug(同一个版本是指“tinker-support.gradle”文件中的“tinkerId”相同)


补丁包.png
在Bugly上传我们的补丁包
上传补丁包.png
需要注意基准包信息已上传到Bugly(也就是这个基准包已经在手机上运行######log 804),上传完补丁包并下发。
/**
 * 补丁包步骤:
 * 1,tinker-support  ->  buildTinkerPatchRelease
 * 2,登陆Bugly 打开当前产品,-> 应用升级 ->热更新 ->发布新补丁包
 * 3,补丁文件 选择文件  路i经 xxx\app\build\outputs\patch\release  选择: patch_signed_7zip.apk
 * 4,选择下发范围: 根据情况选择  一般为全量设备 -> 立即下发
 * 5,下载补丁包或有延迟需要等待片刻,然后杀死应用并重启。
 */
 类似资料: