開始使用 Firebase Crashlytics

本快速入門導覽課程說明如何在應用程式中設定 Firebase Crashlytics 與 Firebase Crashlytics SDK 搭配使用,讓您可以全面掌握當機事件 。 使用 Crashlytics Android 裝置的當機、一般錯誤 「應用程式無回應」(ANR) 錯誤。

如要設定 Crashlytics,必須先在 Firebase 控制台和 您的 IDE (例如新增 Firebase 設定檔和 Crashlytics) SDK)。請先強制測試當機,這樣才能完成設定 向 Firebase 回報當機報告。

事前準備

  1. 如果您尚未在 Android 中新增 Firebase,請先完成這項作業。 專案。如果您沒有 Android 應用程式,請下載 範例應用程式

  2. 建議:自動取得 導覽標記記錄 瞭解引發當機、一般錯誤或 ANR 事件的使用者動作 您必須在 Firebase 專案中啟用 Google Analytics。

    • 如果你現有的 Firebase 專案沒有 Google Analytics 您可以在該頁面啟用 Google Analytics Ad Manager 的「Integrations分頁 >專案設定

    • 如要建立新的 Firebase 專案,請啟用 Google Analytics 專案建立流程

  3. 確認應用程式符合下列「最低」需求版本:

    • Gradle 8.0 版
    • Android Gradle 外掛程式 8.1.0 版
    • Google 服務 Gradle 外掛程式 4.4.1

步驟 1:在應用程式中加入 Crashlytics SDK

模組 (應用程式層級) Gradle 檔案中 (通常為 <project>/<app-module>/build.gradle.kts<project>/<app-module>/build.gradle)、 新增 Android 適用的 Crashlytics 程式庫依附元件。建議您使用 Firebase Android BoM 管理程式庫版本管理

如要使用導覽標記記錄, 此外,請將 Google Analytics 專用 Firebase SDK 加進應用程式。請確認 已啟用 Google Analytics

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

    // 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")
}

使用 Firebase Android BoM 應用程式一律會使用相容的 Firebase Android 程式庫版本。

(替代做法) 新增 Firebase 程式庫依附元件,「不使用」BoM

如果選擇不使用 Firebase BoM,則須指定各個 Firebase 程式庫版本 都屬於依附元件行

請注意,如果您在應用程式中使用多個 Firebase 程式庫,強烈建議您 建議使用 BoM 管理程式庫版本 相容。

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:19.0.3")
    implementation("com.google.firebase:firebase-analytics:22.0.2")
}
在尋找 Kotlin 專用的程式庫模組嗎?距離開始還有 2023 年 10 月 (Firebase BoM 32.5.0),Kotlin 和 Java 開發人員都能 依附於主要程式庫模組 (詳情請參閱 這項計畫的常見問題)。

步驟 2:在應用程式中加入 Crashlytics Gradle 外掛程式

  1. 在您的根層級 (專案層級) Gradle 檔案 (<project>/build.gradle.kts<project>/build.gradle),請將 plugins 區塊的 Crashlytics Gradle 外掛程式:

    Kotlin

    plugins {
        // Make sure that you have the AGP plugin 8.1+ dependency
        id("com.android.application") version "8.1.4" apply false
        // ...
    
        // Make sure that you have the Google services Gradle plugin 4.4.1+ dependency
        id("com.google.gms.google-services") version "4.4.2" apply false
    
        // Add the dependency for the Crashlytics Gradle plugin
        id("com.google.firebase.crashlytics") version "3.0.2" apply false
    }
    

    Groovy

    plugins {
        // Make sure that you have the AGP plugin 8.1+ dependency
        id 'com.android.application' version '8.1.4' apply false
        // ...
    
        // Make sure that you have the Google services Gradle plugin 4.4.1+ dependency
        id 'com.google.gms.google-services' version '4.4.2' apply false
    
        // Add the dependency for the Crashlytics Gradle plugin
        id 'com.google.firebase.crashlytics' version '3.0.2' apply false
    }
    
  2. 模組 (應用程式層級) Gradle 檔案中 (通常為 <project>/<app-module>/build.gradle.kts<project>/<app-module>/build.gradle)、 請新增 Crashlytics Gradle 外掛程式:

    Kotlin

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

    Groovy

    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. 前往下列網址的 Crashlytics 資訊主頁: Firebase 控制台,查看測試當機情形。

    重新整理控制台後,如未發現測試當機 五分鐘後 啟用偵錯記錄功能 查看應用程式是否傳送當機報告。


大功告成!Crashlytics 現在會監控您的應用程式是否有當機問題,一般錯誤 錯誤和 ANR 事件 前往 Crashlytics 資訊主頁查看和調查問題 所有報表和統計資料

後續步驟

  • 與 Google Play 整合,讓 您可以直接前往 Crashlytics 資訊主頁。如此一來,您就能更專注於特定版本上的資訊主頁。
  • 在 Android Studio 中,查看及篩選 Crashlytics 資料。
    • 使用 Android Studio 中的「App Quality Insights」視窗查看 Crashlytics 搭配使用和程式碼,不必在 Crashlytics 之間來回切換 資訊主頁和 IDE 可以開始對重大問題進行偵錯。
    • 存取 Android Studio Electric Eel 版本 (穩定版) 中的 AQI 視窗,或試用看看 Flamingo (Beta 版) 中的全新 AQI 功能下載所需的 Android Studio 版本。
    • 學習新知 請參閱 Android Studio 說明文件中的如何使用 AQI 視窗
    • 歡迎您將使用心得與我們分享!如要提供您對 AQI 視窗的意見,請按 提交錯誤報告