搭配偵錯供應商使用 App Check 和 Flutter

為應用程式註冊 App Check 後,應用程式通常不會在模擬器或持續整合 (CI) 環境中執行,因為這些環境不符合有效裝置的資格。如果您想在開發和測試期間在這種環境中執行應用程式,可以建立應用程式的偵錯版本,使用 App Check 偵錯提供者,而非實際的認證提供者。

Apple 平台

如要在互動式模擬器中執行應用程式時 (例如在開發期間) 使用偵錯提供者,請執行下列操作:

  1. 初始化 Firebase 應用程式後,立即透過偵錯供應商啟用 App Check:

    import 'package:flutter/material.dart';
    import 'package:firebase_core/firebase_core.dart';
    
    // Import the firebase_app_check plugin
    import 'package:firebase_app_check/firebase_app_check.dart';
    
    Future<void> main() async {
      WidgetsFlutterBinding.ensureInitialized();
      await Firebase.initializeApp();
      await FirebaseAppCheck.instance.activate(
        // Set appleProvider to `AppleProvider.debug`
        appleProvider: AppleProvider.debug,
      );
      runApp(App());
    }
    
  2. 在 Xcode 專案 (11.0 以上版本) 中啟用偵錯記錄:

    1. 依序開啟「Product」>「Scheme」>「Edit scheme」
    2. 從左選單中選取「執行」,然後選取「引數」分頁標籤。
    3. 在「Arguments Passed on Launch」部分中,新增 -FIRDebugEnabled
  3. 使用 Xcode 開啟 ios/Runner.xcworkspace,然後在模擬器中執行應用程式。當 Firebase 嘗試傳送要求至後端時,應用程式會將本機偵錯權杖列印至偵錯輸出內容。例如:

    Firebase App Check Debug Token:
    123a4567-b89c-12d3-e456-789012345678
  4. Firebase 主控台的 App Check 部分,從應用程式的溢位選單中選擇「管理偵錯符記」。接著,請註冊您在上一個步驟中記錄的偵錯權杖。

    「管理偵錯權杖」選單項目的螢幕截圖

註冊憑證後,Firebase 後端服務會將其視為有效憑證。

由於這組權杖可在沒有有效裝置的情況下存取 Firebase 資源,因此請務必保密。請勿將其提交至公開存放區,如果註冊的權杖遭到入侵,請立即在 Firebase 主控台中撤銷。

Android

如要在 Android 環境中執行 Flutter 應用程式時使用偵錯提供者,請在 Flutter 應用程式中實作下列程式碼:

import 'package:flutter/material.dart';
import 'package:firebase_core/firebase_core.dart';

// Import the firebase_app_check plugin
import 'package:firebase_app_check/firebase_app_check.dart';

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await Firebase.initializeApp();
  await FirebaseAppCheck.instance.activate(
    webRecaptchaSiteKey: 'recaptcha-v3-site-key',
    // Set androidProvider to `AndroidProvider.debug`
    androidProvider: AndroidProvider.debug,
  );
  runApp(App());
}

當 Firebase 嘗試傳送要求至後端時,您的應用程式會將本機偵錯權杖列印至偵錯輸出內容。例如:

D DebugAppCheckProvider: Enter this debug secret into the allow list in
the Firebase Console for your project: 123a4567-b89c-12d3-e456-789012345678
  1. Firebase 主控台的 App Check 部分,從應用程式的溢位選單中選擇「管理偵錯符記」。接著,請註冊您在上一個步驟中記錄的偵錯權杖。

    「管理偵錯權杖」選單項目的螢幕截圖

註冊憑證後,Firebase 後端服務會將其視為有效憑證。

網路

如要在 localhost 中執行應用程式時 (例如在開發期間) 使用偵錯供應器,請執行下列操作:

  1. web/index.html 檔案中,將 self.FIREBASE_APPCHECK_DEBUG_TOKEN 設為 true 來啟用偵錯模式:

    <body>
      <script>
        self.FIREBASE_APPCHECK_DEBUG_TOKEN = true;
      </script>
    
      ...
    
    </body>
    
  2. 在本機上執行網路應用程式,然後開啟瀏覽器的開發人員工具。在偵錯主控台中,您會看到偵錯符記:

    AppCheck debug token: "123a4567-b89c-12d3-e456-789012345678". You will
    need to safelist it in the Firebase console for it to work.

    這個權杖儲存在本機瀏覽器中,每當您在相同機器上的相同瀏覽器中使用應用程式時,都會使用這個權杖。如果您想在其他瀏覽器或其他電腦上使用權杖,請將 self.FIREBASE_APPCHECK_DEBUG_TOKEN 設為權杖字串,而非 true

  3. Firebase 主控台的 App Check 部分,從應用程式的溢位選單中選擇「管理偵錯符記」。接著,請註冊您在上一個步驟中記錄的偵錯權杖。

    「管理偵錯權杖」選單項目的螢幕截圖

註冊憑證後,Firebase 後端服務會將其視為有效憑證。

由於這個權杖可在沒有有效裝置的情況下存取您的 Firebase 資源,因此請務必確保其私密性。請勿將其提交至公開存放區,如果註冊的權杖遭到入侵,請立即在 Firebase 主控台中撤銷。