欢迎参加我们将于 2022 年 10 月 18 日举办的 Firebase 峰会(线上线下同时进行),了解 Firebase 如何帮助您加快应用开发速度、满怀信心地发布应用并在之后需要时轻松地扩大应用规模。立即报名

将 App Check 与 Web 应用程序中的调试提供程序一起使用

如果在您为 App Check 注册了您的应用程序后,您希望在 App Check 通常不会归类为有效的环境中运行您的应用程序,例如在开发期间本地运行,或者从持续集成 (CI) 环境中运行您的应用程序,您可以创建使用 App Check 调试提供程序而不是真正的证明提供程序的应用程序的调试版本。

在 localhost 上使用调试提供程序

要在从localhost运行您的应用程序时(例如在开发期间)使用调试提供程序,请执行以下操作:

  1. 在您的调试版本中,通过在初始化 App Check 之前将self.FIREBASE_APPCHECK_DEBUG_TOKEN设置为true来启用调试模式。例如:

    Web version 9

    self.FIREBASE_APPCHECK_DEBUG_TOKEN = true;
    initializeAppCheck(app, { /* App Check options */ });
    

    Web version 8

    self.FIREBASE_APPCHECK_DEBUG_TOKEN = true;
    firebase.appCheck().activate(/* site key or provider */);
    
  2. 在本地访问您的 Web 应用程序并打开浏览器的开发人员工具。在调试控制台中,您将看到一个调试令牌:

    AppCheck debug token: "123a4567-b89c-12d3-e456-789012345678". You will
    need to safelist it in the Firebase console for it to work.
  3. 在 Firebase 控制台的应用检查部分,从应用的溢出菜单中选择管理调试令牌。然后,注册您在上一步中登录的调试令牌。

    “管理调试令牌”菜单项的屏幕截图

注册令牌后,Firebase 后端服务会将其视为有效。

由于此令牌允许在没有有效设备的情况下访问您的 Firebase 资源,因此将其保密至关重要。不要将其提交到公共存储库,如果已注册的令牌遭到破坏,请立即在 Firebase 控制台中将其撤消。

此令牌本地存储在您的浏览器中,每当您在同一台机器上的同一浏览器中使用您的应用程序时都会使用此令牌。如果您想在另一个浏览器或另一台机器上使用令牌,请将self.FIREBASE_APPCHECK_DEBUG_TOKEN设置为令牌字符串而不是true

在 CI 环境中使用调试提供程序

要在持续集成 (CI) 环境中使用调试提供程序,请执行以下操作:

  1. 在 Firebase 控制台的应用检查部分,从应用的溢出菜单中选择管理调试令牌。然后,创建一个新的调试令牌。您将在下一步中需要该令牌。

    由于此令牌允许在没有有效设备的情况下访问您的 Firebase 资源,因此将其保密至关重要。不要将其提交到公共存储库,如果已注册的令牌遭到破坏,请立即在 Firebase 控制台中将其撤消。

    “管理调试令牌”菜单项的屏幕截图

  2. 将您刚刚创建的调试令牌添加到 CI 系统的安全密钥存储区(例如,GitHub Actions 的加密机密或 Travis CI 的加密变量)。

  3. 如有必要,配置您的 CI 系统以使您的调试令牌在 CI 环境中作为环境变量可用。将变量命名为APP_CHECK_DEBUG_TOKEN_FROM_CI之类的名称。

  4. 在您的调试版本中,通过在导入 App Check 之前将self.FIREBASE_APPCHECK_DEBUG_TOKEN设置为调试令牌环境变量的值来启用调试模式。例如:

    Web version 9

    self.FIREBASE_APPCHECK_DEBUG_TOKEN = process.env.APP_CHECK_DEBUG_TOKEN_FROM_CI;
    initializeAppCheck(app, { /* App Check options */ });
    

    Web version 8

    self.FIREBASE_APPCHECK_DEBUG_TOKEN = process.env.APP_CHECK_DEBUG_TOKEN_FROM_CI;
    firebase.appCheck().activate(/* site key or provider */);
    

当您的应用在 CI 环境中运行时,Firebase 后端服务将接受它发送的有效令牌。