在 Apple 平台上通過調試提供程序使用 App Check

如果在為 App Check 註冊您的應用程序後，您希望在 App Check 通常不會歸類為有效的環境中運行您的應用程序，例如開發期間的模擬器，或在持續集成 (CI) 環境中，您可以創建應用程序的調試版本，該版本使用 App Check 調試提供程序而不是真正的證明提供程序。

在模擬器中使用調試提供程序

要在模擬器中以交互方式運行應用程序時（例如在開發期間）使用調試提供程序，請執行以下操作：

  1. 在調試版本中，在使用任何 Firebase 後端服務之前，創建並設置 App Check 調試提供程序工廠：

    迅速

    let providerFactory = AppCheckDebugProviderFactory()
AppCheck.setAppCheckProviderFactory(providerFactory)

FirebaseApp.configure()

    Objective-C

    FIRAppCheckDebugProviderFactory *providerFactory =
      [[FIRAppCheckDebugProviderFactory alloc] init];
[FIRAppCheck setAppCheckProviderFactory:providerFactory];

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

  2. 在 Xcode 項目（v11.0 或更高版本）中啟用調試日誌記錄：

    1. 打開產品 > 方案 > 編輯方案。
    2. 從左側菜單中選擇“運行” ，然後選擇“參數”選項卡。
    3. 在“啟動時傳遞的參數”部分中，添加-FIRDebugEnabled 。

  3. 啟動應用程序。當 SDK 嘗試向後端發送請求時，將記錄本地調試令牌。例如：

    [Firebase/AppCheck][I-FAA001001] Firebase App Check Debug Token:
123a4567-b89c-12d3-e456-789012345678

  4. 在 Firebase 控制台的“應用檢查”部分中，從應用的溢出菜單中選擇“管理調試令牌” 。然後，註冊您在上一步中登錄的調試令牌。

    “管理調試令牌”菜單項的屏幕截圖

註冊令牌後，Firebase 後端服務會將其視為有效。

由於此令牌允許在沒有有效設備的情況下訪問您的 Firebase 資源，因此保持其私密性至關重要。不要將其提交到公共存儲庫，如果註冊的令牌遭到洩露，請立即在 Firebase 控制台中撤銷它。

在 CI 環境中使用調試提供程序

要在持續集成 (CI) 環境中使用調試提供程序，請執行以下操作：

  1. 在 Firebase 控制台的“應用檢查”部分中，從應用的溢出菜單中選擇“管理調試令牌” 。然後，創建一個新的調試令牌。您在下一步中將需要該令牌。

    由於此令牌允許在沒有有效設備的情況下訪問您的 Firebase 資源，因此保持其私密性至關重要。不要將其提交到公共存儲庫，如果註冊的令牌遭到洩露，請立即在 Firebase 控制台中撤銷它。

    “管理調試令牌”菜單項的屏幕截圖

  2. 將您剛剛創建的調試令牌添加到 CI 系統的安全密鑰存儲中（例如 GitHub Actions 的加密密鑰或 Travis CI 的加密變量）。

  3. 如有必要，請配置 CI 系統以使調試令牌在 CI 環境中作為環境變量可用。將變量命名為APP_CHECK_DEBUG_TOKEN_FROM_CI之類的名稱。

  4. 在 Xcode 中，將一個環境變量添加到您的測試方案中，其名稱為FIRAAppCheckDebugToken ，其值類似於$(APP_CHECK_DEBUG_TOKEN) 。

  5. 配置 CI 測試腳本以將調試令牌作為環境變量傳遞。例如：

    xcodebuild test -scheme YourTestScheme -workspace YourProject.xcworkspace \
APP_CHECK_DEBUG_TOKEN=$(APP_CHECK_DEBUG_TOKEN_FROM_CI)

  6. 在調試版本中，在使用任何 Firebase 後端服務之前，創建並設置 App Check 調試提供程序工廠：

    迅速

    let providerFactory = AppCheckDebugProviderFactory()
AppCheck.setAppCheckProviderFactory(providerFactory)

FirebaseApp.configure()

    Objective-C

    FIRAppCheckDebugProviderFactory *providerFactory =
      [[FIRAppCheckDebugProviderFactory alloc] init];
[FIRAppCheck setAppCheckProviderFactory:providerFactory];

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

當您的應用程序在 CI 環境中運行時，Firebase 後端服務將接受其發送的有效令牌。