欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

Android应用崩溃检测----Bugly捕获Crash异常

程序员文章站 2024-03-20 16:57:46
...

在开发当中,当程序发布出去之后,如果出现了崩溃的问题,开发者应该及时获取在该设备上导致崩溃的信息,这对于下一个版本的bug修复帮助极大,所以捕获Crash,获取设备参数信息和错误日志就显得尤为重要,现在有很多第三方平台可以实现这些功能,在我们这里介绍的是腾讯的Bugly.

Bugly不仅可以捕获Crash,将异常信息上报,还有运营统计,应用升级,热更新等功能,因为目前我只使用到了捕获异常的功能,所以本篇文章只对此功能做介绍。如果需要其他功能,可以去官网查看文档。(链接:https://bugly.qq.com/docs/user-guide/instruction-manual-android/?v=20171123163535

注册APP应用

先去官网(https://bugly.qq.com/v2/index)注册APP,注册过程不再赘述,按照步骤来非常简单。

  • 注册成功以后在我的产品里面找到APP,点击“设置”。
    Android应用崩溃检测----Bugly捕获Crash异常

  • 进入设置后找到App ID,在初始化的时候会用。
    Android应用崩溃检测----Bugly捕获Crash异常

库文件导入

Bugly支持自动集成和手动集成两种方式,如果您使用Gradle编译Apk,强烈推荐您使用自动接入方式配置库文件。

自动集成步骤

Bugly支持JCenter仓库和Maven Central仓库。为了实现更加灵活的配置,Bugly SDK(2.1.5及以上版本)和NDK(SO库)目前已经分开成两个独立的仓库:

SDK:com.tencent.bugly:crashreport
NDK:com.tencent.bugly:nativecrashreport

其中,集成Bugly NDK时,需要同时集成Bugly SDK。

同时集成SDK和NDK

在Module的build.gradle文件中添加依赖和属性配置:

android {
    defaultConfig {
        ndk {
            // 设置支持的SO库架构
            abiFilters 'armeabi' //, 'x86', 'armeabi-v7a', 'x86_64', 'arm64-v8a'
        }
    }
}

dependencies {
    compile 'com.tencent.bugly:crashreport:latest.release' //其中latest.release指代最新Bugly SDK版本号,也可以指定明确的版本号,例如2.1.9
    compile 'com.tencent.bugly:nativecrashreport:latest.release' //其中latest.release指代最新Bugly NDK版本号,也可以指定明确的版本号,例如3.0
}

同时集成Bugly SDK和NDK的配置如下图所示,后续更新Bugly SDK和NDK时,只需变更配置脚本中的版本号即可。
Android应用崩溃检测----Bugly捕获Crash异常

注意:自动集成时会自动包含Bugly SO库,建议在Module的build.gradle文件中使用NDK的“abiFilter”配置(如上图),设置支持的SO库架构。

如果在添加“abiFilter”之后Android Studio出现以下提示:

NDK integration is deprecated in the current plugin.  Consider trying the new experimental plugin.

则在项目根目录的gradle.properties文件中添加(如下图所示):

android.useDeprecatedNdk=true

Android应用崩溃检测----Bugly捕获Crash异常

权限配置

  • 在AndroidManifest.xml中添加权限:
<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" />
  • 请避免混淆Bugly,在Proguard混淆文件中增加以下配置:
-dontwarn com.tencent.bugly.**
-keep public class com.tencent.bugly.**{*;}

这里没有做混淆处理,所以只给出Proguard混淆文件位置。如图所示:
Android应用崩溃检测----Bugly捕获Crash异常

初始化

获取APP ID并将以下代码复制到项目Application类onCreate()中,Bugly会为自动检测环境并完成配置:

//为了保证运营数据的准确性,建议不要在异步线程初始化Bugly。

CrashReport.initCrashReport(getApplicationContext(), "注册时申请的APPID", false); 

第三个参数为SDK调试模式开关,调试模式的行为特性如下:

  • 输出详细的Bugly SDK的Log;
  • 每一条Crash都会被立即上报;
  • 自定义日志将会在Logcat中输出。

    建议在测试阶段建议设置成true,发布时设置为false。

此外,Bugly2.0及以上版本还支持通过“AndroidManifest.xml”来配置APP信息。如果同时又通过代码中配置了APP信息,则最终以代码配置的信息为准。

在“AndroidManifest.xml”的“Application”中增加“meta-data”配置项:

<application
    <!-- 配置APP ID -->
    <meta-data
            android:name="BUGLY_APPID"
            android:value="<APP_ID>" />
    <!-- 配置APP版本号 -->
    <meta-data
            android:name="BUGLY_APP_VERSION"
            android:value="<APP_Version>" />
    <!-- 配置APP渠道号 -->
    <meta-data
            android:name="BUGLY_APP_CHANNEL"
            android:value="<APP_Channel>" />
    <!-- 配置Bugly调试模式(true或者false)-->
    <meta-data
            android:name="BUGLY_ENABLE_DEBUG"
            android:value="<isDebug>" />
</application>

<!-- 不同于“android:versionName”,“BUGLY_APP_VERSION”配置的是Bugly平台的APP版本号。-->

通过“AndroidManifest.xml”配置后的初始化方法如下:

CrashReport.initCrashReport(getApplicationContext());

Bugly默认从“AndroidManifest.xml”文件中读取“VersionName”作为版本号,自定义设置请使用参考“高级设置”。

MultiDex注意事项

MultiDex问题简介

Android 的classLoader在加载APK的时候限制了class.dex包含的Java方法总数不能超过65535,如果超出会报异常。但是现在随便一个复杂一点的App,轻而易举就能超过65535。MultiDex是google为了解决这个问题推出了官方的解决方案。(百度关键词:MultiDex)

如果使用了MultiDex,建议通过Gradle的“multiDexKeepFile”配置等方式把Bugly的类放到主Dex,Bugly 类放到主Dex,方式有两种(以下两种方式使用一种即可):

multiDexKeepFile 属性

build.gradle的同级目录下创建 multiDexKeep.txt,在 multiDexKeep.txt 中配置进需要手动插入的 类的完整路径 即 包名+类名.class
Android应用崩溃检测----Bugly捕获Crash异常

然后在bulid.gradle里配置

android {
    defaultConfig {
        multiDexEnabled true
        multiDexKeepFile file('multiDexKeep.txt') // keep specific classes
    }
}

multiDexKeepProguard 属性

build.gradle的同级目录下创建multiDexKeep.pro,multiDexKeep.pro中的配置与混淆文件的配置相同 使用 -keep class xxxx 指定类名
Android应用崩溃检测----Bugly捕获Crash异常
然后在bulid.gradle里配置

android {
    defaultConfig {
        multiDexEnabled true
        multiDexKeepProguard file('multidexKeep.pro')
    }
}

另外建议在Application类的”attachBaseContext”方法中主动加载非主dex:

public class MyApplication extends SomeOtherApplication {
  @Override
  protected void attachBaseContext(Context base) {
     super.attachBaseContext(context);
     Multidex.install(this);
  }
}

增加上报进程控制

如果App使用了多进程且各个进程都会初始化Bugly(例如在Application类onCreate()中初始化Bugly),那么每个进程下的Bugly都会进行数据上报,造成不必要的资源浪费。

因此,为了节省流量、内存等资源,建议初始化的时候对上报进程进行控制,只在主进程下上报数据:判断是否是主进程(通过进程名是否为包名来判断),并在初始化Bugly时增加一个上报进程的策略配置。

Context context = getApplicationContext();
// 获取当前包名
String packageName = context.getPackageName();
// 获取当前进程名
String processName = getProcessName(android.os.Process.myPid());
// 设置是否为上报进程
UserStrategy strategy = new UserStrategy(context);
strategy.setUploadProcess(processName == null || processName.equals(packageName));
// 初始化Bugly
CrashReport.initCrashReport(context, "注册时申请的APPID", isDebug, strategy);
// 如果通过“AndroidManifest.xml”来配置APP信息,初始化方法如下
// CrashReport.initCrashReport(context, strategy);

其中获取进程名的方法“getProcessName”有多种实现方法,推荐方法如下:

/**
 * 获取进程号对应的进程名
 * 
 * @param pid 进程号
 * @return 进程名
 */
private static String getProcessName(int pid) {
    BufferedReader reader = null;
    try {
        reader = new BufferedReader(new FileReader("/proc/" + pid + "/cmdline"));
        String processName = reader.readLine();
        if (!TextUtils.isEmpty(processName)) {
            processName = processName.trim();
        }
        return processName;
    } catch (Throwable throwable) {
        throwable.printStackTrace();
    } finally {
        try {
            if (reader != null) {
                reader.close();
            }
        } catch (IOException exception) {
            exception.printStackTrace();
        }
    }
    return null;
}

测试

现在您可以制造一个Crash(建议通过“按键”来触发),来体验Bugly的能力了。在初始化Bugly的之后,调用Bugly测Java Crash接口。

CrashReport.testJavaCrash();

执行到这段代码时会发生一个Crash,Logcat的TAG=CrashReportInfo中输出为:
Android应用崩溃检测----Bugly捕获Crash异常
现在您已经可以在“崩溃”页面看到刚才触发的Crash issue了(延迟一般在10s以内)。

如果项目包含了Native工程或者使用了代码混淆,建议配置符号表文件,具体请参考“符号表配置

总结

其实这篇博客大部分还是从官方文档拷贝的,因为步骤是相同的,写出来的东西肯定也是万变不离其宗,其中在每一步都加了图片参考,会有一个更直观的展示。再一个,在multiDex处理时有些需要注意的地方,都已经注明了,如果有疑问和错误欢迎各位小伙伴留言批评指正。