在 Android 上将 App Check 与调试提供程序一起使用

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

在模拟器中使用调试提供程序

要在以交互方式在模拟器中运行您的应用程序时(例如在开发期间)使用调试提供程序,请执行以下操作:

  1. 在您的模块(应用级)Gradle 文件(通常是app/build.gradle )中,声明 App Check Android 库的依赖项:

    Java

    dependencies {
        implementation 'com.google.firebase:firebase-appcheck-debug:16.0.0'
    }
    

    Kotlin+KTX

    dependencies {
        implementation 'com.google.firebase:firebase-appcheck-debug:16.0.0'
    }
    
  2. 在您的调试版本中,将 App Check 配置为使用调试提供程序工厂:

    Java

    FirebaseApp.initializeApp(/*context=*/ this);
    FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance();
    firebaseAppCheck.installAppCheckProviderFactory(
            DebugAppCheckProviderFactory.getInstance());

    Kotlin+KTX

    FirebaseApp.initializeApp(/*context=*/this)
    val firebaseAppCheck = FirebaseAppCheck.getInstance()
    firebaseAppCheck.installAppCheckProviderFactory(
        DebugAppCheckProviderFactory.getInstance()
    )
  3. 启动应用并触发对 Firebase 后端服务的调用。当 SDK 尝试向后端发送请求时,将记录本地调试令牌。例如:

    D DebugAppCheckProvider: Enter this debug secret into the allow list in
    the Firebase Console for your project: 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. 在您的模块(应用程序级)Gradle 文件(通常是app/build.gradle )中:

    1. 声明 App Check Android 调试库的测试依赖项:

      Java

      dependencies {
          androidTestImplementation 'com.google.firebase:firebase-appcheck-debug-testing:16.0.0'
      }
      

      Kotlin+KTX

      dependencies {
          androidTestImplementation 'com.google.firebase:firebase-appcheck-debug-testing:16.0.0'
      }
      
    2. 将以下内容添加到 CI 构建变体的配置中:

      testInstrumentationRunnerArgument "firebaseAppCheckDebugSecret", System.getenv("APP_CHECK_DEBUG_TOKEN_FROM_CI") ?: ''
      
  5. 在您的测试类中,使用DebugAppCheckTestHelper包装任何需要 App Check 令牌的代码:

    Java

    @RunWith(AndroidJunit4.class)
    public class YourTests {
        private final DebugAppCheckTestHelper debugAppCheckTestHelper =
                DebugAppCheckTestHelper.fromInstrumentationArgs();
    
        @Test
        public void testWithDefaultApp() {
            debugAppCheckTestHelper.withDebugProvider(() -> {
                // Test code that requires a debug AppCheckToken.
            });
        }
    
        @Test
        public void testWithNonDefaultApp() {
            debugAppCheckTestHelper.withDebugProvider(
                    FirebaseApp.getInstance("nonDefaultApp"),
                    () -> {
                        // Test code that requires a debug AppCheckToken.
                    });
        }
    }
    

    Kotlin+KTX

    @RunWith(AndroidJunit4::class)
    class MyTests {
        private val debugAppCheckTestHelper =
            DebugAppCheckTestHelper.fromInstrumentationArgs()
    
        @Test
        fun testWithDefaultApp() {
            debugAppCheckTestHelper.withDebugProvider {
                // Test code that requires a debug AppCheckToken.
            }
        }
    
        @Test
        fun testWithNonDefaultApp() {
            debugAppCheckTestHelper.withDebugProvider(
                FirebaseApp.getInstance("nonDefaultApp")
            ) {
                // Test code that requires a debug AppCheckToken.
            }
        }
    }
    

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