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

為應用程式註冊 App Check 後,應用程式通常無法正常運作 匯入或擷取來自持續整合 (CI) 環境 環境不算有效的裝置。如果您想在類似的環境下執行應用程式 您在開發與測試期間可以建立偵錯版本 使用 App Check 偵錯供應商 (而非實際認證) 的應用程式 。

Apple 平台

以互動方式在模擬器中執行應用程式時,使用偵錯供應商 (例如在開發期間) 執行下列步驟:

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

    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. 選取左選單中的「Run」(執行),然後選取「Arguments」分頁標籤。
    3. 在「Passed on Launch」區段中,新增 -FIRDebugEnabled
  3. 使用 Xcode 開啟 ios/Runner.xcworkspace,然後在模擬器中執行應用程式。 採用 Firebase 時,您的應用程式會將本機偵錯權杖列印至偵錯輸出內容 嘗試傳送要求至後端。例如:

    Firebase App Check Debug Token:
    123a4567-b89c-12d3-e456-789012345678
  4. 在「App Check」(應用程式檢查) 部分 前往 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. 在「App Check」(應用程式檢查) 部分 前往 Firebase 控制台,然後在應用程式的「管理偵錯權杖」中選擇「管理偵錯權杖」 溢位選單接著,註冊您在先前記錄中登入的偵錯權杖 採用

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

註冊權杖後,Firebase 後端服務會接受該權杖的有效性。

Web

localhost 執行應用程式時使用偵錯供應商 執行以下動作:

  1. web/index.html 檔案中設定以啟用偵錯模式 self.FIREBASE_APPCHECK_DEBUG_TOKENtrue

    <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.

    這個 Token 會儲存在本機瀏覽器中,以供日後 在同一部電腦的相同瀏覽器中使用應用程式。如要使用 權杖 將 self.FIREBASE_APPCHECK_DEBUG_TOKEN 改為權杖字串,而非 true

  3. 在「App Check」(應用程式檢查) 部分 前往 Firebase 控制台,然後在應用程式的「管理偵錯權杖」中選擇「管理偵錯權杖」 溢位選單接著,註冊您在先前記錄中登入的偵錯權杖 採用

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

註冊權杖後,Firebase 後端服務會接受該權杖的有效性。

因為這組權杖可讓您在沒有 有效的裝置,請務必確保該裝置的私密性。請勿將程式碼部署至 公開存放區,如果註冊權杖曾遭駭,請撤銷該組權杖 設定流程