如果您的 Android 应用包含原生库,您可以通过对应用的构建配置进行一些小规模更新,利用 Firebase Crashlytics 实现原生代码的完整堆栈轨迹和详细的崩溃报告功能。本指南介绍如何使用全新 Firebase Crashlytics SDK 配置崩溃报告。
准备工作
在执行第 2 步(将 Firebase Crashlytics 添加到您的应用)时,请确保您的应用使用的是 Crashlytics Gradle 插件 v2.4.0 及更高版本,这可保证仅使用未剥离的二进制文件上传符号,以生成符号化解析的崩溃报告。注意:Crashlytics NDK v17.3.0 及更高版本需要使用 Crashlytics Gradle 插件 v2.4.0 及更高版本。如果您导入 Firebase Android BoM,系统会自动指定此 NDK 版本。
第 1 步:更新 Gradle 配置
在您的应用级 build.gradle 中,声明 Crashlytics NDK 运行时依赖项:
Javaapply plugin: 'com.android.application'
apply plugin: 'com.google.firebase.crashlytics'
dependencies {
// ...
// Import the BoM for the Firebase platform
implementation platform('com.google.firebase:firebase-bom:27.1.0')
// Declare the dependency for the Firebase Crashlytics NDK library.
// If you previously declared the Firebase Crashlytics dependency, replace it.
// When using the BoM, you don't specify versions in Firebase library dependencies
implementation 'com.google.firebase:firebase-crashlytics'
implementation 'com.google.firebase:firebase-crashlytics-ndk'
implementation 'com.google.firebase:firebase-analytics'
}
// …
android {
// ...
buildTypes {
release {
// Add this extension
firebaseCrashlytics {
// Enable processing and uploading of native symbols to Crashlytics 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
}
}
}
}
通过使用 Firebase Android BoM,可确保您的应用始终使用 Firebase Android 库的兼容版本。
(替代方法)
在不使用 BoM 的情况下声明 Firebase 库依赖项
如果您选择不使用 Firebase BoM,则必须在其依赖项行中指定每个 Firebase 库版本。
请注意,如果您在应用中使用多个 Firebase 库,我们强烈建议您使用 BoM 来管理库版本,以确保所有版本都兼容。
dependencies {
// Declare the dependency for the Firebase Crashlytics NDK library.
// If you previously declared the Firebase Crashlytics dependency, replace it.
// 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-crashlytics-ndk:17.4.1'
implementation 'com.google.firebase:firebase-analytics:18.0.3'
}
Kotlin+KTXapply plugin: 'com.android.application'
apply plugin: 'com.google.firebase.crashlytics'
dependencies {
// ...
// Import the BoM for the Firebase platform
implementation platform('com.google.firebase:firebase-bom:27.1.0')
// Declare the dependency for the Firebase Crashlytics NDK library.
// If you previously declared the Firebase Crashlytics dependency, replace it.
// 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-crashlytics-ndk'
implementation 'com.google.firebase:firebase-analytics-ktx'
}
// …
android {
// ...
buildTypes {
release {
// Add this extension
firebaseCrashlytics {
// Enable processing and uploading of native symbols to Crashlytics 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
}
}
}
}
通过使用 Firebase Android BoM,可确保您的应用始终使用 Firebase Android 库的兼容版本。
(替代方法)
在不使用 BoM 的情况下声明 Firebase 库依赖项
如果您选择不使用 Firebase BoM,则必须在其依赖项行中指定每个 Firebase 库版本。
请注意,如果您在应用中使用多个 Firebase 库,我们强烈建议您使用 BoM 来管理库版本,以确保所有版本都兼容。
dependencies {
// Declare the dependency for the Firebase Crashlytics NDK library.
// If you previously declared the Firebase Crashlytics dependency, replace it.
// 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-crashlytics-ndk:17.4.1'
implementation 'com.google.firebase:firebase-analytics-ktx:18.0.3'
}
Crashlytics NDK 版本 17.3.0 特别要求:如果您的应用使用 targetSdkLevel 30 或更高版本,您还必须将以下代码添加到您的 AndroidManifest.xml 中,从而在应用中停用指针标记功能:
...
注意:Crashlytics NDK 发行版包含 Android NDK 支持的所有架构的原生二进制文件。如果您的应用仅适用于一部分架构,可以使用 ABI 拆分排除不必要的架构。
第 2 步:启用原生符号上传
如需生成可读的 NDK 崩溃堆栈轨迹,Crashlytics 需要了解原生二进制文件中的符号。我们的 Gradle 插件包含 uploadCrashlyticsSymbolFileBUILD_VARIANT 任务,可自动完成此过程(如需访问此任务,请确保将 nativeSymbolUploadEnabled 设置为 true)。
如需在堆栈轨迹中显示方法名称,您必须在每次构建 NDK 库后明确调用 uploadCrashlyticsSymbolFileBUILD_VARIANT 任务。例如:
>./gradlew app:assembleBUILD_VARIANT\
app:uploadCrashlyticsSymbolFileBUILD_VARIANT
Crashlytics NDK v17.3.0+ 和 Gradle 插件 v2.4.1+ 要求原生共享对象中存在 GNU 构建 ID。您可以通过在每个二进制文件上运行 readelf -n 来验证此 ID 是否存在。如果此构建 ID 不存在,请在构建系统的标志中添加 -Wl,--build-id 来解决此问题。
第 3 步(可选):为外部依赖项上传符号
我们的符号上传任务假设您使用 CMake 之类的标准 NDK 构建工具在 Gradle 构建过程中构建原生库。如果您有在外部构建的原生库,或在 Gradle 中使用了自定义 NDK 构建流程,则可能需要明确指定未剥离的库的路径。firebaseCrashlytics 扩展程序提供 unstrippedNativeLibsDir 属性来执行此操作。
// …
android {
// ...
buildTypes {
release {
firebaseCrashlytics {
nativeSymbolUploadEnabled true
unstrippedNativeLibsDir ‘path/to/unstripped/parent/dir’
}
}
}
}
我们的插件假定库位于指定目录下的特定于架构的子目录中。在以下示例中,子目录 x86 和 arm64 都包含库 libfoo.so 和 libbar.so。
unstrippedNativeLibsDir/
+- x86/
|
+- libfoo.so
+- libbar.so
+- arm64/
|
+- libfoo.so
+- libbar.so
如果您的构建系统未遵循上述结构/命名方案,请先在本地磁盘上手动创建此结构,然后再调用 uploadCrashlyticsSymbolFileBUILD_VARIANT 任务。
第 4 步(可选):自定义 NDK 崩溃报告
您可以视需要在 C++ 代码中包含 crashlytics.h 头文件,以将元数据(如日志、自定义键和用户 ID)添加到 NDK 崩溃报告中。
Firebase Android SDK GitHub 代码库中提供了仅可作为头文件的 C++ 库形式的 crashlytics.h。
请阅读该头文件中的注释,了解有关使用 NDK C++ API 的说明。
第 5 步:查看崩溃报告
通过构建应用、上传符号并强制造成原生代码崩溃来验证 Crashlytics 是否正确报告 NDK 崩溃。在应用崩溃以便 Crashlytics 发送报告后,您将需要重启应用。
您应该会在几分钟内在 Firebase 控制台中看到崩溃。
问题排查
如果您在 Firebase 控制台和 logcat 中看到的堆栈轨迹不同,请参阅问题排查指南。