Google 致力于为黑人社区推动种族平等。查看具体举措

Firebase Crashlytics 使用入门

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

准备工作

  1. 将 Firebase 添加到您的 Android 项目(如果尚未添加)。如果您没有任何 Android 应用,可以下载一个示例应用

  2. 可选:要获得无崩溃用户、面包屑导航和自定义事件等崩溃指标,您需要在 Firebase 项目中启用 Google Analytics(分析)。

    1. 如果您的现有 Firebase 项目未启用 Google Analytics(分析),可以从 >“项目设置”集成标签页将其启用。

      如果您要创建新的 Firebase 项目,请在项目创建工作流期间启用 Google Analytics(分析)。

    2. 最后,在 Google Analytics(分析)控制台中,通过“管理”标签页 >“帐号设置”> 数据共享设置启用数据共享。

      请注意,对于较早的 Firebase 项目,您可能需要在 >“项目设置”(在 Firebase 控制台中)的集成标签页中启用数据共享。

第 1 步:在 Firebase 控制台中设置 Crashlytics

  1. Firebase 控制台的左侧导航面板中点击 Crashlytics

  2. 如果您的 Firebase 项目中注册了多个应用,请从控制台顶栏中的 Crashlytics 旁边的下拉列表中选择刚刚添加的应用。

  3. 点击启用 Crashlytics

第 2 步:将 Firebase Crashlytics 添加到您的应用

  1. 在项目级 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.5'
    
            // Add the Crashlytics Gradle plugin (be sure to add version
            // 2.0.0 or later if you built your app with Android Studio 4.1).
            classpath 'com.google.firebase:firebase-crashlytics-gradle:2.5.2'
        }
    }
    
    allprojects {
        repositories {
            // Check that you have Google's Maven repository (if not, add it).
            google()
        }
    }
       
  2. 在应用级 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

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

    为了获得最佳的 Crashlytics 使用体验,我们建议您在项目中启用 Google Analytics(分析)。此外,在设置 Analytics(分析)时,您还需要将支持 Google Analytics(分析)的 Firebase SDK 添加到您的应用中。

    请确保您使用的是 BoM v24.7.1 或更高版本,以便获得实时的“未受崩溃事件影响的用户数”指标和面包屑导航。

    Java

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:26.8.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:17.4.1'
        implementation 'com.google.firebase:firebase-analytics:18.0.2'
    }
    

    Kotlin+KTX

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:26.8.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:17.4.1'
        implementation 'com.google.firebase:firebase-analytics-ktx:18.0.2'
    }
    

  2. 可选:对于使用 Android 原生开发套件 (NDK) 构建的应用,Firebase Crashlytics 支持崩溃报告功能。如果您的应用使用的是 NDK,您可以将 Crashlytics 配置为报告应用的底层 NDK 库中发生的崩溃。请访问 NDK 崩溃报告文档了解具体操作方法。

第 4 步:运行项目

最后,运行您的应用。您的设备日志会显示表明初始化已完成的 Firebase 验证信息。

后续步骤