Firebase Crashlytics 使用入门

此快速入门介绍了如何使用 Firebase Crashlytics SDK 在应用中设置 Firebase Crashlytics，以便您可以在 Firebase 控制台中获得全面的崩溃报告。

若要设置 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

转到 Firebase 控制台中的 Crashlytics 信息中心。
确保从页面顶部的 Crashlytics 旁边的下拉列表中选择您的应用。
点击启用 Crashlytics。

第 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.10'

        // Add the Crashlytics Gradle plugin
        classpath 'com.google.firebase:firebase-crashlytics-gradle:2.7.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 步：将 Firebase Crashlytics SDK 添加到您的应用

使用 Firebase Android BoM 在模块（应用级）Gradle 文件（通常为 app/build.gradle）中声明 Crashlytics Android 库的依赖项。

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

Java

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

    // 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.1'
    implementation 'com.google.firebase:firebase-analytics:19.0.0'
}

Kotlin+KTX

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

    // 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.1'
    implementation 'com.google.firebase:firebase-analytics-ktx:19.0.0'
}

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

若要完成 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))

构建并运行您的应用。
强制造成应用崩溃以发送应用的第一个崩溃报告：
1. 通过测试设备或模拟器打开应用。
2. 在您的应用中，按下您使用上述代码添加的“测试崩溃”按钮。
3. 应用崩溃后，请将其重启，这样应用便可以将崩溃报告发送到 Firebase。
请转到 Firebase 控制台的 Crashlytics 信息中心以查看您的测试崩溃报告。

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

这样就大功告成了！Crashlytics 现在会监控您的应用是否会发生崩溃，您可以在 Crashlytics 信息中心内查看和调查崩溃报告和统计信息。

后续步骤

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