Catch up on everthing we announced at this year's Firebase Summit. Learn more

在 Android 上通過調試提供程序使用 App Check

如果在為 App Check 註冊應用程序後,您希望在 App Check 通常不會將其歸類為有效的環境(例如開發期間的模擬器)或持續集成 (CI) 環境中運行您的應用程序,您可以創建使用 App Check 調試提供程序而不是真正的證明提供程序的應用程序的調試版本。

在模擬器中使用調試提供程序

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

  1. 在你的模塊(應用程序級)搖籃文件(通常是app/build.gradle ),聲明依賴的應用程序查看Android庫:

    爪哇

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

    科特林+KTX

    dependencies {
        implementation 'com.google.firebase:firebase-appcheck-debug:16.0.0-beta03'
    }
    
  2. 在您的調試版本中,將 App Check 配置為使用調試提供程序工廠:

    爪哇

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

    科特林+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 控制台中撤銷它。

在 CI 環境中使用調試提供程序進行單元測試

要在持續集成 (CI) 環境中使用調試提供程序進行單元測試,請執行以下操作:

  1. 項目設置>應用程序檢查的火力地堡控制台部分,從您的應用程序的溢出菜單管理調試令牌。然後,創建一個新的調試令牌。您將在下一步中需要令牌。

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

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

  2. 添加調試令牌,你剛剛創建的CI系統的安全密鑰存儲(例如,GitHub的操作“加密機密或特拉維斯CI的加密變量)。

  3. 如有必要,配置您的 CI 系統,使您的調試令牌在 CI 環境中作為環境變量可用。命名變量類似APP_CHECK_DEBUG_TOKEN_FROM_CI

  4. 在你的模塊(應用程序級)搖籃文件(通常是app/build.gradle ):

    1. 聲明 App Check Android 調試庫的測試依賴項:

      爪哇

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

      科特林+KTX

      dependencies {
          androidTestImplementation 'com.google.firebase:firebase-appcheck-debug-testing:16.0.0-beta03'
      }
      
    2. 將以下內容添加到 CI 構建變體的配置中:

      testInstrumentationRunnerArgument "firebaseAppCheckDebugSecret", System.getenv("APP_CHECK_DEBUG_TOKEN_FROM_CI") ?: ''
      
  5. 在你的測試類,使用DebugAppCheckTestHelper包需要一個應用程序檢查令牌的代碼:

    爪哇

    @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.
                    });
        }
    }
    

    科特林+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 後端服務將接受它發送的有效令牌。