獲取 Android NDK 崩潰報告

如果您的 Android 應用包含本機庫，您可以從 Firebase Crashlytics 為您的本機代碼啟用完整的堆棧跟踪和詳細的崩潰報告，並對您的應用的構建配置進行一些小的更新。

本指南介紹如何使用適用於 NDK 的 Firebase Crashlytics SDK 配置崩潰報告。

如果您正在尋找如何在 Unity 項目中開始使用 Crashlytics，請查看Unity 入門指南。

在你開始之前

1. 如果您還沒有，請將 Firebase 添加到您的 Android 項目中。如果您沒有 Android 應用，可以下載示例應用。

2. 推薦：要獲得無崩潰用戶、麵包屑日誌和速度警報等功能，您需要在 Firebase 項目中啟用 Google Analytics。

   • 如果您現有的 Firebase 項目未啟用 Google Analytics，您可以從 Firebase 控制台中settings >項目設置的集成選項卡啟用 Google Analytics。

   • 如果您要創建新的 Firebase 項目，請在項目創建工作流程中啟用 Google Analytics。

第 1 步：將適用於 NDK 的 Crashlytics SDK 添加到您的應用程序

為了獲得 Crashlytics 的最佳體驗，我們建議在您的 Firebase 項目中啟用 Google Analytics ，並將適用於 Google Analytics 的 Firebase SDK 添加到您的應用中。

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

    // Add the dependencies for the Crashlytics NDK and Analytics libraries
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-crashlytics-ndk'
    implementation 'com.google.firebase:firebase-analytics'
}

dependencies {
    // Add the dependencies for the Crashlytics NDK and Analytics libraries
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-crashlytics-ndk:18.3.2'
    implementation 'com.google.firebase:firebase-analytics:21.2.0'
}

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

    // Add the dependencies for the Crashlytics NDK and Analytics libraries
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-crashlytics-ndk'
    implementation 'com.google.firebase:firebase-analytics-ktx'
}

dependencies {
    // Add the dependencies for the Crashlytics NDK and Analytics libraries
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-crashlytics-ndk:18.3.2'
    implementation 'com.google.firebase:firebase-analytics-ktx:21.2.0'
}

第 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.14'
   
           // Add the dependency for the Crashlytics Gradle plugin
           classpath 'com.google.firebase:firebase-crashlytics-gradle:2.9.2'
       }
   }

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 步：將firebaseCrashlytics擴展添加到您的構建中

在您的模塊（應用級）Gradle 文件（通常是app/build.gradle ）中，添加firebaseCrashlytics擴展。

// ...

android {
  // ...
  buildTypes {
      release {
          // Add this extension
          firebaseCrashlytics {
              // Enable processing and uploading of native symbols to Firebase servers.
              // By default, this is disabled to improve build speeds.
              // This flag must be enabled to see properly-symbolicated native
              // stack traces in the Crashlytics dashboard.
              nativeSymbolUploadEnabled true
          }
      }
  }
}

// ...

android {
  // ...
  buildTypes {
      release {
          // Add this extension
          firebaseCrashlytics {
              // Enable processing and uploading of native symbols to Firebase servers.
              // By default, this is disabled to improve build speeds.
              // This flag must be enabled to see properly-symbolicated native
              // stack traces in the Crashlytics dashboard.
              nativeSymbolUploadEnabled true
          }
      }
  }
}

第 4 步：設置本地符號的自動上傳

為了從 NDK 崩潰中生成可讀的堆棧跟踪，Crashlytics 需要了解本機二進製文件中的符號。 Crashlytics Gradle 插件包含uploadCrashlyticsSymbolFile BUILD_VARIANT任務以自動執行此過程。

1. 為了讓您可以訪問自動上傳符號的任務，請確保在您的模塊（應用級）Gradle 文件nativeSymbolUploadEnabled設置為true 。

2. 要使方法名稱出現在堆棧跟踪中，您必須在每次構建 NDK 庫後顯式調用uploadCrashlyticsSymbolFile BUILD_VARIANT任務。例如：

   >./gradlew app:assembleBUILD_VARIANT\
              app:uploadCrashlyticsSymbolFileBUILD_VARIANT
   

3. Crashlytics SDK for NDK 和 Crashlytics Gradle 插件都依賴於原生共享對像中是否存在 GNU 構建 ID。

   您可以通過對每個二進製文件運行readelf -n來驗證此 ID 的存在。如果構建 ID 不存在，請將-Wl,--build-id添加到構建系統的標誌以解決問題。

第 5 步：強制測試崩潰以完成設置

要完成 Crashlytics 的設置並在 Firebase 控制台的 Crashlytics 控制面板中查看初始數據，您需要強制測試崩潰。

1. 向您的應用添加可用於強制測試崩潰的代碼。

   您可以在應用程序的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))
   

2. 構建並運行您的應用程序。

3. 強制測試崩潰以發送您的應用的第一個崩潰報告：

   1. 從您的測試設備或模擬器打開您的應用程序。

   2. 在您的應用程序中，按下您使用上述代碼添加的“測試崩潰”按鈕。

   3. 在您的應用崩潰後，重新啟動它，以便您的應用可以將崩潰報告發送到 Firebase。

4. 轉到 Firebase 控制台的Crashlytics 儀表板以查看您的測試崩潰。

   如果您已刷新控制台，但五分鐘後仍未看到測試崩潰，請啟用調試日誌記錄以查看您的應用是否正在發送崩潰報告。

就是這樣！ Crashlytics 現在正在監控您的應用程序的崩潰情況，您可以在 Crashlytics 儀表板中查看和調查崩潰報告和統計信息。

上傳符號的替代選項

上面此頁面上的主要工作流程適用於標準 Gradle 構建。但是，某些應用程序使用不同的配置或工具（例如，Gradle 以外的構建過程）。在這些情況下，以下選項可能有助於成功上傳符號。

選項：上傳庫模塊和外部依賴項的符號

此選項在以下情況下可能會有所幫助：

• 如果您在 Gradle 中使用自定義的 NDK 構建過程
• 如果您的本機庫是在庫/功能模塊中構建的或由第三方提供的
• 如果自動符號上傳任務失敗或您在儀表板中看到未符號化的崩潰

選項：為非 Gradle 構建或不可訪問的未剝離本機庫上傳符號

此選項在以下情況下可能會有所幫助：

• 如果您使用 Gradle 以外的構建過程

• 如果以某種方式向您提供未剝離的原生庫，而在 Gradle 構建期間它們無法訪問

故障排除

如果您在 Firebase 控制台和 logcat 中看到不同的堆棧跟踪，請參閱故障排除指南。

下一步

• 通過添加選擇加入報告、日誌、密鑰和跟踪非致命錯誤來自定義您的崩潰報告設置。

• 與 Google Play 集成，以便您可以直接在 Crashlytics 儀表板中按 Google Play 跟踪過濾您的 Android 應用程序的崩潰報告。這使您可以更好地將儀表板集中在特定的構建上。