Firebase Crashlytics 入門

本快速入門介紹瞭如何使用 Firebase Crashlytics SDK 在您的應用中設置 Firebase Crashlytics，以便您可以在 Firebase 控制台中獲取全面的崩潰報告。

設置 Crashlytics 需要在 Firebase 控制台和 IDE 中執行任務（例如添加 Firebase 配置文件和 Crashlytics SDK）。要完成設置，您需要強制測試崩潰，以將第一個崩潰報告發送到 Firebase。

在你開始之前

如果您尚未將 Firebase 添加到您的 Apple 項目中，請將其添加到您的 Apple 項目中。如果您沒有 Apple 應用程序，可以下載示例應用程序。
推薦：要獲得無崩潰用戶、麵包屑日誌和速度警報等功能，您需要在 Firebase 項目中啟用 Google Analytics。
Crashlytics 支持的所有 Apple 平台（watchOS 除外）都可以利用 Google Analytics 的這些功能。請注意，您需要適用於 macOS 和 tvOS 應用程序的 SDK v8.9.0+。
- 如果您現有的 Firebase 項目未啟用 Google Analytics（分析），您可以從 Firebase 控制台中 >項目設置的“集成”選項卡中啟用 Google Analytics。
- 如果您要創建新的 Firebase 項目，請在項目創建工作流程期間啟用 Google Analytics。

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

使用 Swift Package Manager 安裝和管理 Firebase 依賴項。

在 Xcode 中，打開應用程序項目，導航至File > Add Packages 。
出現提示時，添加 Firebase Apple 平台 SDK 存儲庫：

  https://github.com/firebase/firebase-ios-sdk

選擇 Crashlytics 庫。
為了獲得 Crashlytics 的最佳體驗，我們建議在您的 Firebase 項目中啟用 Google Analytics ，並將適用於 Google Analytics 的 Firebase SDK 添加到您的應用中。您可以選擇沒有 IDFA 收集或有 IDFA 收集的庫。
完成後，Xcode 將自動開始在後台解析並下載您的依賴項。

接下來，配置 Firebase 模塊：

在您的App結構或UIApplicationDelegate中導入 Firebase 模塊：
迅速
```
import Firebase
```
Objective-C
```
@import Firebase;
```

配置FirebaseApp共享實例，通常在應用程序委託的application(_:didFinishLaunchingWithOptions:)方法中：

迅速

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

Objective-C

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

第 2 步：設置 Xcode 自動上傳 dSYM 文件

為了生成人類可讀的崩潰報告，Crashlytics 需要項目的調試符號 (dSYM) 文件。以下步驟描述瞭如何配置 Xcode 以在構建應用程序時自動生成 dSYM、處理它們並上傳文件。

打開項目的 Xcode 工作區，然後在左側導航器中選擇其項目文件。
從目標列表中，選擇您的主要構建目標。
單擊“構建設置”選項卡，然後完成以下步驟，以便 Xcode 為您的構建生成 dSYM。
1. 單擊全部，然後搜索debug information format 。
2. 對於所有構建類型DWARF with dSYM File將調試信息格式設置為 DWARF。
單擊“構建階段”選項卡，然後完成以下步驟，以便 Xcode 可以處理您的 dSYM 並上傳文件。
1. 單擊 > “新建運行腳本階段” 。
  確保這個新的運行腳本階段是項目的最後一個構建階段；否則，Crashlytics 無法正確處理 dSYM。
2. 展開新的運行腳本部分。
  注意：對於其餘子步驟，請完全按照指定複製並粘貼路徑，Xcode 將解析它們。但是，如果您在 Xcode 解析這些路徑或獨特的項目結構時遇到問題，您可以手動指定路徑。
3. 在腳本字段（位於Shell標籤下）中，添加以下運行腳本。
  此腳本處理項目的 dSYM 文件並將文件上傳到 Crashlytics。
```
"${BUILD_DIR%/Build/*}/SourcePackages/checkouts/firebase-ios-sdk/Crashlytics/run"
```
4. 在“輸入文件”部分中，添加以下文件位置的路徑：
```
${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}
```
```
${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}/Contents/Resources/DWARF/${PRODUCT_NAME}
```
```
${DWARF_DSYM_FOLDER_PATH}/${DWARF_DSYM_FILE_NAME}/Contents/Info.plist
```
```
$(BUILT_PRODUCTS_DIR)/$(UNLOCALIZED_RESOURCES_FOLDER_PATH)/GoogleService-Info.plist
```
```
$(BUILT_PRODUCTS_DIR)/$(EXECUTABLE_PATH)
```
  了解為什麼需要這些文件的位置
  Xcode 在指定位置查找這些輸入文件，以確保構建文件可用於運行腳本。此外，如果啟用了用戶腳本沙箱，Xcode 只允許運行腳本訪問輸入文件中指定的文件。
  - 提供項目 dSYM 文件的位置使 Crashlytics 能夠處理 dSYM。
  - 提供應用的內置GoogleService-Info.plist文件的位置使 Crashlytics 能夠將 dSYM 與您的 Firebase 應用相關聯。
  - 提供應用程序可執行文件的位置允許運行腳本防止重複上傳相同的 dSYM。請注意，不會上傳應用程序二進製文件。

有關 dSYM 文件和 Crashlytics 的更多詳細信息（包括如何手動上傳 dSYM 文件），請訪問獲取反混淆的崩潰報告。

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

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

將代碼添加到您的應用程序中，您可以使用它來強制測試崩潰。

您可以使用以下代碼向應用程序添加一個按鈕，按下該按鈕會導致崩潰。該按鈕標記為“測試崩潰”。

斯威夫特用戶界面

Button("Crash") {
  fatalError("Crash was triggered")
}

用戶界面工具包

迅速

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 調試器的連接。 Xcode 調試器會阻止將崩潰報告發送到 Crashlytics。
1. 單擊 Build，然後運行當前方案以在測試設備或模擬器上構建您的應用程序。
2. 等待您的應用程序運行，然後單擊 ”停止運行該方案或操作以關閉應用程序的初始實例。此初始實例包含干擾 Crashlytics 的調試器。
強制測試崩潰以發送應用程序的第一個崩潰報告：
1. 從測試設備或模擬器的主屏幕打開您的應用程序。
2. 在您的應用程序中，按您使用上面的代碼添加的“測試崩潰”按鈕。
3. 您的應用程序崩潰後，從 Xcode 再次運行它，以便您的應用程序可以將崩潰報告發送到 Firebase。
轉到 Firebase 控制台的Crashlytics 儀表板以查看測試崩潰。
如果刷新控制台後五分鐘後仍未看到測試崩潰，請啟用調試日誌記錄以查看應用程序是否正在發送崩潰報告。

就是這樣！ Crashlytics 現在正在監控您的應用程序是否崩潰。訪問Crashlytics 儀表板以查看和調查您的所有報告和統計數據。

下一步

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