Firebase Crashlytics 使用入门

iOS+ Android Flutter Unity

此快速入门介绍了如何使用 Firebase Crashlytics SDK 在应用中设置 Firebase Crashlytics，以便您可以在 Firebase 控制台中获得全面的崩溃报告。 通过 Crashlytics for Android，您可以收到有关崩溃、非严重错误和“应用无响应”(ANR) 错误的报告。

设置 Crashlytics 需要在 Firebase 控制台和 IDE 中分别执行一些操作（例如添加 Firebase 配置文件和 Crashlytics SDK）。为了完成设置，您需要强制造成一次测试崩溃，以便向 Firebase 发送您的第一个崩溃报告。

准备工作

1. 将 Firebase 添加到您的 Android 项目（如果尚未添加）。如果您没有 Android 应用，可以下载一个示例应用。

2. 建议做法：如需使用“未遇到崩溃问题的用户”“面包屑导航日志”和“疾速崩溃提醒”等功能，您需要在 Firebase 项目中启用 Google Analytics（分析）。

   • 如果您的现有 Firebase 项目未启用 Google Analytics（分析），您可以访问 Firebase 控制台，依次点击 settings >“项目设置”，然后在集成标签页中启用 Google Analytics（分析）。

   • 如果您要创建新的 Firebase 项目，请在项目创建过程中启用 Google Analytics（分析）。

第 1 步：将 Crashlytics SDK 添加到您的应用

为了获得最佳的 Crashlytics 使用体验，我们建议您在 Firebase 项目中启用 Google Analytics（分析），并将 Firebase SDK for Google Analytics 添加到您的应用中。

dependencies {
    // Import the BoM for the Firebase platform
    implementation platform('com.google.firebase:firebase-bom:32.0.0')

    // Add 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'
}

dependencies {
    // Add 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.3.7'
    implementation 'com.google.firebase:firebase-analytics-ktx:21.2.2'
}

dependencies {
    // Import the BoM for the Firebase platform
    implementation platform('com.google.firebase:firebase-bom:32.0.0')

    // Add 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'
}

dependencies {
    // Add 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.3.7'
    implementation 'com.google.firebase:firebase-analytics:21.2.2'
}

第 2 步：将 Crashlytics Gradle 插件添加到您的应用

1. 在您的根级（项目级）Gradle 文件 (<project>/build.gradle) 中，将 Crashlytics Gradle 插件添加为 buildscript 依赖项：

   buildscript {
       repositories {
         // Make sure that you have the following two repositories
         google()  // Google's Maven repository
         mavenCentral()  // Maven Central repository
       }
   
       dependencies {
           ...
           classpath 'com.android.tools.build:gradle:7.2.0'
   
           // Make sure that you have the Google services Gradle plugin dependency
           classpath 'com.google.gms:google-services:4.3.15'
   
           // Add the dependency for the Crashlytics Gradle plugin
           classpath 'com.google.firebase:firebase-crashlytics-gradle:2.9.5'
       }
   }

2. 在您的模块（应用级）Gradle 文件（通常是 <project>/<app-module>/build.gradle）中，添加 Crashlytics Gradle 插件：

   plugins {
       id 'com.android.application'
   
       // Make sure that you have the Google services Gradle plugin
       id 'com.google.gms.google-services'
   
       // Add the Crashlytics Gradle plugin
       id 'com.google.firebase.crashlytics'
       ...
   }

第 3 步：强制造成一次测试崩溃以完成设置

若要完成 Crashlytics 设置并在 Firebase 控制台的 Crashlytics 信息中心内查看初始数据，您需要强制造成一次测试崩溃。

1. 向应用添加可用于强制造成测试崩溃的代码。

   您可以在应用的 MainActivity 中使用以下代码，向应用添加一个按下即会导致崩溃的按钮。该按钮标有“测试崩溃”。

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

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

2. 构建并运行您的应用。

3. 强制造成测试崩溃以发送应用的第一个崩溃报告：

   1. 在测试设备或模拟器上打开应用。

   2. 在您的应用中，按下您使用上述代码添加的“测试崩溃”按钮。

   3. 应用崩溃后，请将其重启，这样应用便可以将崩溃报告发送到 Firebase。

4. 前往 Firebase 控制台的 Crashlytics 信息中心，查看您的测试崩溃报告。

   如果您已刷新控制台，但在五分钟后仍未看到测试崩溃报告，请启用调试日志记录，查看您的应用是否正在发送崩溃报告。

大功告成！Crashlytics 现在会监控您的应用是否发生崩溃、非严重错误和 ANR。 您可以访问 Crashlytics 信息中心以查看和调查所有报告和统计信息。

后续步骤

• 您可以通过添加自选式报告、日志、键以及跟踪非严重错误来自定义崩溃报告设置。

• 与 Google Play 集成，以便您可以直接在 Crashlytics 信息中心内按 Google Play 轨道过滤 Android 应用的崩溃报告。这样可让 Crashlytics 信息中心更有侧重地显示特定 build 的崩溃信息。

• 在 Android Studio 中，查看和过滤 Crashlytics 数据。
  • 使用 Android Studio 中的“App Quality Insights”（AQI，应用质量数据分析）窗口查看 Crashlytics 数据以及您的代码，而无需在 Crashlytics 信息中心和 IDE 之间来回切换即可开始调试常见问题。
  • 使用 Android Studio 的 Electric Eel 版本（稳定版）中的 AQI 窗口，或者试用 Flamingo（Beta 版）中的新 AQI 功能。 下载所需的 Android Studio 版本。
  • 参阅 Android Studio 文档，了解如何使用 AQI 窗口。
  • 我们希望倾听您的宝贵意见！通过提交 bug 报告向我们发送有关 AQI 窗口的反馈。