使用帶有 Flutter 的調試提供程序使用 App Check

在您為應用程序檢查註冊應用程序後,您的應用程序通常不會在模擬器或持續集成 (CI) 環境中運行,因為這些環境不符合有效設備的條件。如果您想在開發和測試期間在此類環境中運行應用程序,您可以創建應用程序的調試版本,該版本使用 App Check 調試提供程序而不是真正的證明提供程序。

蘋果平台

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

  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 項目(v11.0 或更高版本)中啟用調試日誌記錄:

    1. 打開產品 > 方案 > 編輯方案
    2. 從左側菜單中選擇“運行” ,然後選擇“參數”選項卡。
    3. “啟動時傳遞的參數”部分中,添加-FIRDebugEnabled
  3. 使用 Xcode 打開ios/Runner.xcworkspace並在模擬器中運行您的應用程序。當 Firebase 嘗試向後端發送請求時,您的應用程序會將本地調試令牌打印到調試輸出。例如:

    Firebase App Check Debug Token:
    123a4567-b89c-12d3-e456-789012345678
  4. 在 Firebase 控制台的“應用檢查”部分中,從應用的溢出菜單中選擇“管理調試令牌” 。然後,註冊您在上一步中記錄的調試令牌。

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

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

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

安卓

要在 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 控制台的“應用檢查”部分中,從應用的溢出菜單中選擇“管理調試令牌” 。然後,註冊您在上一步中記錄的調試令牌。

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

註冊令牌後,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 控制台的“應用檢查”部分中,從應用的溢出菜單中選擇“管理調試令牌” 。然後,註冊您在上一步中登錄的調試令牌。

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

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

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