此快速入门介绍了如何使用 Firebase Crashlytics SDK 在应用中设置 Firebase Crashlytics,以便您可以在 Firebase 控制台中获得全面的崩溃报告。 通过 Crashlytics for Android,您可以收到有关崩溃、非严重错误和“应用无响应”(ANR) 错误的报告。
如需设置 Crashlytics,需在 Firebase 控制台和 IDE 中分别执行一些操作(例如添加 Firebase 配置文件和 Crashlytics SDK)。为了完成设置,您需要强制造成一次测试崩溃,以便向 Firebase 发送您的第一个崩溃报告。
准备工作
将 Firebase 添加到您的 Android 项目(如果尚未添加)。如果您没有 Android 应用,可以下载一个示例应用。
建议做法:如需使用“未遇到崩溃问题的用户”、“面包屑导航日志”和“疾速崩溃提醒”等功能,您需要在 Firebase 项目中启用 Google Analytics(分析)。
如果您的现有 Firebase 项目未启用 Google Analytics(分析),您可以访问 Firebase 控制台,依次点击
,然后在 >“项目设置”集成标签页中启用 Google Analytics(分析)。 如果您要创建新的 Firebase 项目,请在项目创建过程中启用 Google Analytics(分析)。
第 1 步:将 Firebase Crashlytics SDK 添加到您的应用
使用 Firebase Android BoM 在模块(应用级)Gradle 文件(通常为app/build.gradle
)中声明 Crashlytics Android 库的依赖项。
为了获得最佳的 Crashlytics 使用体验,我们建议您在 Firebase 项目中启用 Google Analytics(分析),并将 Firebase SDK for Google Analytics 添加到您的应用中。
Java
dependencies { // Import the BoM for the Firebase platform implementation platform('com.google.firebase:firebase-bom:30.3.0') // Declare the dependencies for the Crashlytics and Analytics libraries // When using the BoM, you don't specify versions in Firebase library dependencies implementation 'com.google.firebase:firebase-crashlytics' implementation 'com.google.firebase:firebase-analytics' }
借助 Firebase Android BoM,可确保您的应用使用的始终是 Firebase Android 库的兼容版本。
(替代方法) 在不使用 BoM 的情况下声明 Firebase 库依赖项
如果您选择不使用 Firebase BoM,则必须在每个 Firebase 库的依赖项行中指定相应的库版本。
请注意,如果您在应用中使用多个 Firebase 库,我们强烈建议您使用 BoM 来管理库版本,从而确保所有版本都兼容。
dependencies { // Declare the dependencies for the Crashlytics and Analytics libraries // When NOT using the BoM, you must specify versions in Firebase library dependencies implementation 'com.google.firebase:firebase-crashlytics:18.2.11' implementation 'com.google.firebase:firebase-analytics:21.1.0' }
Kotlin+KTX
dependencies { // Import the BoM for the Firebase platform implementation platform('com.google.firebase:firebase-bom:30.3.0') // Declare the dependencies for the Crashlytics and Analytics libraries // When using the BoM, you don't specify versions in Firebase library dependencies implementation 'com.google.firebase:firebase-crashlytics-ktx' implementation 'com.google.firebase:firebase-analytics-ktx' }
使用 Firebase Android BoM 可确保您的应用始终使用 Firebase Android 库的兼容版本。
(替代方法) 在不使用 BoM 的情况下声明 Firebase 库依赖项
如果您选择不使用 Firebase BoM,则必须在每个 Firebase 库的依赖项行中指定相应的库版本。
请注意,如果您在应用中使用多个 Firebase 库,我们强烈建议您使用 BoM 来管理库版本,从而确保所有版本都兼容。
dependencies { // Declare the dependencies for the Crashlytics and Analytics libraries // When NOT using the BoM, you must specify versions in Firebase library dependencies implementation 'com.google.firebase:firebase-crashlytics-ktx:18.2.11' implementation 'com.google.firebase:firebase-analytics-ktx:21.1.0' }
第 2 步:将 Firebase Crashlytics 插件添加到您的应用
在项目级
build.gradle
文件中,将 Crashlytics Gradle 插件作为 buildscript 依赖项添加。buildscript { repositories { // Check that you have Google's Maven repository (if not, add it). google() } dependencies { // ... // Check that you have the Google services Gradle plugin v4.3.2 or later // (if not, add it). classpath 'com.google.gms:google-services:4.3.13' // Add the Crashlytics Gradle plugin classpath 'com.google.firebase:firebase-crashlytics-gradle:2.9.1' } } allprojects { repositories { // Check that you have Google's Maven repository (if not, add it). google() } }
在应用级
build.gradle
文件中,应用 Crashlytics Gradle 插件:apply plugin: 'com.android.application' apply plugin: 'com.google.gms.google-services' // Google services Gradle plugin // Apply the Crashlytics Gradle plugin apply plugin: 'com.google.firebase.crashlytics'
第 3 步:强制造成一次测试崩溃以完成设置
若要完成 Crashlytics 设置并在 Firebase 控制台的 Crashlytics 信息中心内查看初始数据,您需要强制造成一次测试崩溃。
向应用添加可用于强制造成测试崩溃的代码。
您可以在应用的
MainActivity
中使用以下代码,向应用添加一个按下即会导致崩溃的按钮。该按钮标有“测试崩溃”。Java
Button crashButton = new Button(this); crashButton.setText("Test Crash"); crashButton.setOnClickListener(new View.OnClickListener() { public void onClick(View view) { throw new RuntimeException("Test Crash"); // Force a crash } }); addContentView(crashButton, new ViewGroup.LayoutParams( ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.WRAP_CONTENT));
Kotlin+KTX
val crashButton = Button(this) crashButton.text = "Test Crash" crashButton.setOnClickListener { throw RuntimeException("Test Crash") // Force a crash } addContentView(crashButton, ViewGroup.LayoutParams( ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.WRAP_CONTENT))
构建并运行您的应用。
强制造成应用崩溃以发送应用的第一个崩溃报告:
在测试设备或模拟器上打开应用。
在您的应用中,按下您使用上述代码添加的“测试崩溃”按钮。
应用崩溃后,请将其重启,这样应用便可以将崩溃报告发送到 Firebase。
请转到 Firebase 控制台的 Crashlytics 信息中心 以查看您的测试崩溃报告。
如果您已刷新控制台,但在五分钟后仍未看到测试崩溃报告,请启用调试日志记录,查看您的应用是否正在发送崩溃报告。
大功告成!Crashlytics 现在会监控您的应用是否发生崩溃、非严重错误和 ANR。 您可以访问 Crashlytics 信息中心以查看和调查所有报告和统计信息。
后续步骤
- 您可以通过添加自选式报告、日志、键以及跟踪非严重错误来自定义崩溃报告设置。
- 与 Google Play 集成,以便您可以直接在 Crashlytics 信息中心内按 Google Play 轨道过滤 Android 应用的崩溃报告。这样可让 Crashlytics 信息中心更有侧重地显示特定 build。
-
您可以使用 Android Studio 中的 App Quality Insights(应用质量分析) 窗口直接随代码一同查看堆栈轨迹和崩溃统计信息。使用此工具,您无需在 Crashlytics 信息中心和 IDE 之间来回切换,便可解决一些常见问题。
- 此功能在最新的 Canary 版 Android Studio - Electric Eel | 2022.1.1 中提供。
- 如需详细了解如何使用此功能,请参阅 Android Studio 的新功能文档。
- 由于这是一项 Canary 版功能,因此我们非常希望能够听取您的意见!如果您有任何反馈或遇到任何问题,请提交错误报告。