Firebase Crashlytics 入門

本快速入門介紹如何使用 Firebase Crashlytics SDK 在您的應用程式中設定 Firebase Crashlytics,以便您可以在 Firebase 控制台中取得全面的崩潰報告。透過 Android 版 Crashlytics,您可以獲得崩潰、非致命錯誤和「應用程式未回應」(ANR) 錯誤的報告。

設定 Crashlytics 需要在 Firebase 控制台和 IDE 中執行任務(例如新增 Firebase 設定檔和 Crashlytics SDK)。要完成設置,您需要強制測試崩潰,以將第一個崩潰報告傳送到 Firebase。

在你開始之前

  1. 如果您尚未將 Firebase 新增至您的 Android 專案中,請將其新增至您的 Android 專案中。如果您沒有 Android 應用程序,可以下載範例應用程式

  2. 建議:要自動取得麵包屑日誌以了解導致崩潰、非致命或 ANR 事件的使用者操作,您需要在 Firebase 專案中啟用 Google Analytics。

    • 如果您現有的 Firebase 專案未啟用 Google Analytics,您可以從您的 Firebase 專案的整合標籤中啟用 Google Analytics。 Firebase 控制台中的 >專案設定

    • 如果您要建立新的 Firebase 項目,請在專案建立工作流程期間啟用 Google Analytics。

步驟 1 :將 Crashlytics SDK 添加到您的應用程式

模組(應用程式層級)Gradle 檔案(通常<project>/<app-module>/build.gradle.kts<project>/<app-module>/build.gradle )中,新增 Crashlytics 庫的依賴項對於安卓。我們建議使用Firebase Android BoM來控制函式庫版本控制。

若要利用麵包屑日誌,也要將適用於 Google Analytics 的 Firebase SDK 加入您的應用程式。確保您的 Firebase 專案中啟用了 Google Analytics

dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:32.8.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")
}

透過使用Firebase Android BoM ,您的應用程式將始終使用 Firebase Android 程式庫的相容版本。

(替代方法)在不使用 BoM 的情況下新增 Firebase 庫依賴項

如果您選擇不使用 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:18.6.3")
    implementation("com.google.firebase:firebase-analytics:21.6.1")
}
正在尋找 Kotlin 特定的庫模組?2023 年 10 月(Firebase BoM 32.5.0)開始,Kotlin 和 Java 開發人員都可以依賴主庫模組(有關詳細信息,請參閱有關此計劃的常見問題解答)。

步驟 2 :將 Crashlytics Gradle 外掛程式新增至您的應用程式中

  1. 根級(專案級) Gradle 檔案( <project>/build.gradle.kts<project>/build.gradle )中,將 Crashlytics Gradle 外掛程式新增至plugins區塊:

    Kotlin

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

    Groovy

    plugins {
        id 'com.android.application' version '7.3.0' apply false
        // ...
    
        // Make sure that you have the Google services Gradle plugin dependency
        id 'com.google.gms.google-services' version '4.4.1' apply false
    
        // Add the dependency for the Crashlytics Gradle plugin
        id 'com.google.firebase.crashlytics' version '2.9.9' 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. 前往 Firebase 控制台的Crashlytics 儀表板以查看測試當機。

    如果刷新控制台後五分鐘後仍未看到測試崩潰,請啟用偵錯日誌記錄以查看您的應用程式是否正在傳送崩潰報告。


就是這樣! Crashlytics 現在正在監控您的應用程式是否發生崩潰、非致命錯誤和 ANR。造訪Crashlytics 儀表板以查看和調查您的所有報告和統計資料。

下一步

  • 透過新增選擇加入報告、日誌、金鑰和非致命錯誤追蹤來自訂崩潰報告設定
  • 與 Google Play 集成,以便您可以直接在 Crashlytics 儀表板中按 Google Play 追蹤過濾 Android 應用程式的崩潰報告。這使您可以更好地將儀表板集中在特定的建置上。
  • 在 Android Studio 中,檢視和篩選 Crashlytics 資料。
    • 使用 Android Studio 中的應用程式品質洞察(AQI) 視窗可以在程式碼旁邊查看 Crashlytics 資料 - 無需在 Crashlytics 儀表板和 IDE 之間來回跳轉即可開始偵錯主要問題。
    • 造訪 Android Studio 的 Electric Eel 版本(穩定版)中的 AQI 窗口,或嘗試 Flamingo(測試版)中的新 AQI 功能下載您想要的 Android Studio 版本。
    • 在 Android Studio 文件中了解如何使用 AQI 視窗
    • 我們很樂意聽取您的意見!透過提交錯誤報告向我們發送有關 AQI 視窗的回饋。