Firebase Crashlytics 使用入门

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

若要设置 Crashlytics，必须在 Firebase 控制台和 IDE 中执行任务（例如添加 Firebase 配置文件和 Crashlytics SDK）。如需完成设置，您需要强制造成一次测试崩溃，以便向 Firebase 发送您的第一个崩溃报告。

准备工作

将 Firebase 添加到您的 iOS 项目（如果尚未添加）。如果您没有任何 iOS 应用，可以下载一个示例应用。
建议做法：若要使用“未遇到崩溃问题的用户”、“面包屑导航日志”和“疾速崩溃提醒”等功能，您需要在 Firebase 项目中启用 Google Analytics（分析）。
- 如果您的现有 Firebase 项目未启用 Google Analytics（分析），您可以访问 Firebase 控制台，依次点击“”>“项目设置”，然后在集成标签页中启用 Google Analytics（分析）。
- 如果您要创建新的 Firebase 项目，请在项目创建工作流内启用 Google Analytics（分析）。

第 1 步：在 Firebase 控制台中启用 Crashlytics

转到 Firebase 控制台中的 Crashlytics 信息中心。
确保从页面顶部的 Crashlytics 旁边的下拉列表中选择您的应用。
点击启用 Crashlytics。

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

注意：我们建议使用 CocoaPods 安装 Firebase 库。如果您是使用 Swift Package Manager 设置的 Firebase，则可以跳过与 CocoaPods 相关的步骤，例如修改 Podfile 和运行 pod 命令。

打开为 Firebase 项目创建的 podfile，然后添加 FirebaseCrashlytics Pod。

为了获得最佳的 Crashlytics 使用体验，我们建议您在 Firebase 项目中启用 Google Analytics（分析），并将适用于 Google Analytics（分析）的 Firebase pod 添加到您的应用中。
```
pod 'Firebase/Crashlytics'

# Recommended: Add the Firebase pod for Google Analytics
pod 'Firebase/Analytics'
```
安装 pod，然后重新打开 .xcworkspace 文件以便在 Xcode 中查看该项目：
```
pod install
open your-project.xcworkspace
```
在 UIApplicationDelegate 中导入 Firebase 模块：
Swift
```
import Firebase
```
Objective-C
```
@import Firebase;
```

配置一个 FirebaseApp 共享实例（通常在应用的 application:didFinishLaunchingWithOptions: 方法中配置）：

Swift

// Use the Firebase library to configure APIs.
FirebaseApp.configure()

Objective-C

// Use the Firebase library to configure APIs.
[FIRApp configure];

第 3 步：设置 Xcode 以自动上传 dSYM 文件

要生成人类可读懂的崩溃报告，Crashlytics 需要项目的调试符号 (dSYM) 文件。以下步骤介绍了如何配置 Xcode，使其在您每次构建应用时自动生成 dSYM、处理 dSYM 并上传文件。

打开项目的 Xcode 工作区，然后在左侧导航器中选择其项目文件。
从 TARGETS 列表中，选择您的主要构建目标。
点击 Build Settings 标签页，然后完成以下步骤，以便 Xcode 为您的构建版本生成 dSYM。
1. 点击 All，然后搜索 debug information format。
2. 对于所有构建类型，请将 Debug Information Format 设置为 DWARF with dSYM File。
点击 Build Phases 标签页，然后完成以下步骤，以便 Xcode 可以处理您的 dSYM 并上传文件。
1. 依次点击 > New Run Script Phase。
  
  确保新的“运行脚本”阶段是项目的最后一个构建阶段；否则 Crashlytics 将无法正确处理 dSYM。
2. 展开新的“Run Script”部分。
  
  注意：对于其余的子步骤，请完全按照指定的方式复制并粘贴路径，Xcode 将解析这些路径。不过，如果您在解析这些路径或独特的项目结构时遇到 Xcode 问题，可以手动指定路径。
3. 在脚本字段（位于 Shell 标签下）中，添加以下运行脚本。
  
  此脚本会处理项目的 dSYM 文件，并将文件上传到 Crashlytics。
```
"${PODS_ROOT}/FirebaseCrashlytics/run"
```
4. 在 Input Files 部分中，添加以下文件的路径。
  - 添加项目的 dSYM 文件的路径
    
    如此 Crashlytics 将能够更快地处理大型应用的 dSYM。
```
${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}/Contents/Resources/DWARF/${TARGET_NAME}
```
  - 将路径添加到项目的已构建 Info.plist 文件
    
    如此 Crashlytics 便可将应用版本与 dSYM 相关联。
```
$(SRCROOT)/$(BUILT_PRODUCTS_DIR)/$(INFOPLIST_PATH)
```

如需详细了解 dSYM 文件和 Crashlytics（包括如何手动上传 dSYM 文件），请访问获取经过去混淆处理的崩溃报告。

第 4 步：强制造成一次测试崩溃以完成设置

若要完成 Crashlytics 设置并在 Firebase 控制台的 Crashlytics 信息中心内查看初始数据，您需要强制造成一次测试崩溃。

向应用添加可用于强制造成测试崩溃的代码。

您可以使用以下代码向应用添加一个按钮，该按钮在被按下时会造成崩溃。该按钮标有“测试崩溃”。

Swift

import UIKit

class ViewController: UIViewController {
  override func viewDidLoad() {
      super.viewDidLoad()

      // Do any additional setup after loading the view, typically from a nib.

      let button = UIButton(type: .roundedRect)
      button.frame = CGRect(x: 20, y: 50, width: 100, height: 30)
      button.setTitle("Test Crash", for: [])
      button.addTarget(self, action: #selector(self.crashButtonTapped(_:)), for: .touchUpInside)
      view.addSubview(button)
  }

  @IBAction func crashButtonTapped(_ sender: AnyObject) {
      let numbers = [0]
      let _ = numbers[1]
  }
}

Objective-C

#import "ViewController.h"

@implementation ViewController
‐ (void)viewDidLoad {
    [super viewDidLoad];

    // Do any additional setup after loading the view, typically from a nib.

    UIButton* button = [UIButton buttonWithType:UIButtonTypeRoundedRect];
    button.frame = CGRectMake(20, 50, 100, 30);
    [button setTitle:@"Test Crash" forState:UIControlStateNormal];
    [button addTarget:self action:@selector(crashButtonTapped:)
        forControlEvents:UIControlEventTouchUpInside];
    [self.view addSubview:button];
}

‐ (IBAction)crashButtonTapped:(id)sender {
    @[][1];
}

@end

在 Xcode 中构建并运行您的应用。按照以下步骤操作，确保测试设备或模拟器已断开与 Xcode 调试程序（它会干扰 Crashlytics）的连接。
1. 点击 Build and then run the current scheme，以在设备或模拟器上构建您的应用。
2. 等待应用运行，然后点击 Stop running the scheme or action 以关闭应用的初始实例。此初始实例包含会干扰 Crashlytics 的调试程序。
强制造成应用崩溃以发送应用的第一个崩溃报告：
1. 在测试设备或模拟器的主屏幕中打开您的应用。
2. 在您的应用中，按下您使用上述代码添加的“测试崩溃”按钮。
3. 应用崩溃后，在 Xcode 中再次运行该应用，以便其将崩溃报告发送到 Firebase。
请转到 Firebase 控制台的 Crashlytics 信息中心以查看您的测试崩溃报告。

如果您已刷新控制台，但在五分钟后仍未看到测试崩溃报告，请启用调试日志记录，以查看您的应用是否正在发送崩溃报告。

这样就大功告成了！Crashlytics 现在会监控您的应用是否会发生崩溃，您可以在 Crashlytics 信息中心内查看和调查崩溃报告和统计信息。

后续步骤

您可以通过添加自选式报告、日志、键以及跟踪非严重错误来自定义崩溃报告设置。