搭配 Android 偵錯供應商使用 App Check

註冊 App Check 的應用程式後，如果您想在 App Check 通常不會歸類為有效的環境中執行應用程式，例如開發期間的模擬器，或從持續整合 (CI) 環境，您可以建立應用程式的偵錯版本，使用 App Check 偵錯提供者，而非實際的認證提供者。

在模擬器中使用偵錯提供者

如要在互動式地在模擬器中執行應用程式時 (例如在開發期間) 使用偵錯提供者，請執行下列操作：

在模組 (應用程式層級) Gradle 檔案 (通常是 <project>/<app-module>/build.gradle.kts 或 <project>/<app-module>/build.gradle) 中，加入 Android 的 App Check 程式庫依附元件。建議您使用 Firebase Android BoM 來控制程式庫版本。
```
dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.7.0"))

    // Add the dependencies for the App Check libraries
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-appcheck-debug")
}
```
只要使用 Firebase Android BoM，應用程式就會一律使用相容的 Firebase Android 程式庫版本。
(替代做法) 不使用 BoM 新增 Firebase 程式庫依附元件

如果您選擇不使用 Firebase BoM，則必須在依附元件行中指定每個 Firebase 程式庫版本。

請注意，如果您在應用程式中使用多個 Firebase 程式庫，強烈建議您使用 BoM 來管理程式庫版本，確保所有版本皆相容。
```
dependencies {
    // Add the dependencies for the App Check libraries
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-appcheck-debug:18.0.0")
}
```
想尋找 Kotlin 專屬的程式庫模組嗎？自 2023 年 10 月 (Firebase BoM 32.5.0)起，Kotlin 和 Java 開發人員都可以依附主要程式庫模組 (詳情請參閱這項計畫的常見問題)。

在偵錯版本中，設定 App Check 以使用偵錯提供者工廠：

Kotlin+KTX

Firebase.initialize(context = this)
Firebase.appCheck.installAppCheckProviderFactory(
    DebugAppCheckProviderFactory.getInstance(),
)MainActivity.kt

Java

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

啟動應用程式並觸發對 Firebase 後端服務的呼叫。SDK 嘗試將要求傳送至後端時，系統會記錄本機偵錯符記。例如：
```
D DebugAppCheckProvider: Enter this debug secret into the allow list in
the Firebase Console for your project: 123a4567-b89c-12d3-e456-789012345678
```
在 Firebase 控制台的 App Check 部分，從應用程式的溢位選單中選擇「管理偵錯符記」。接著，請註冊您在上一個步驟中記錄的偵錯權杖。

註冊憑證後，Firebase 後端服務會將其視為有效憑證。

由於這組權杖可在沒有有效裝置的情況下存取 Firebase 資源，因此請務必保密。請勿將其提交至公開存放區，如果註冊的權杖遭到入侵，請立即在 Firebase 控制台中撤銷。

在 CI 環境中使用偵錯提供者進行單元測試

如要在持續整合 (CI) 環境中使用偵錯提供者進行單元測試，請執行下列操作：

在 Firebase 控制台的 App Check 部分，從應用程式的溢位選單中選擇「管理偵錯符記」。接著，請建立新的偵錯權杖。您將在下一個步驟中使用這組符記。

由於這組權杖可讓使用者在沒有有效裝置的情況下存取 Firebase 資源，因此請務必妥善保管。請勿將其提交至公開存放區，如果註冊的權杖遭到入侵，請立即在 Firebase 控制台中撤銷。
將剛剛建立的偵錯權杖新增至 CI 系統的安全金鑰存放區 (例如 GitHub Actions 的加密祕密或 Travis CI 的加密變數)。
如有需要，請設定持續整合系統，讓偵錯符記碼可在持續整合環境中做為環境變數使用。為變數命名，例如 APP_CHECK_DEBUG_TOKEN_FROM_CI。
在模組 (應用程式層級) Gradle 檔案 (通常是 <project>/<app-module>/build.gradle.kts 或 <project>/<app-module>/build.gradle) 中，加入 Android 的 App Check 程式庫依附元件。建議您使用 Firebase Android BoM 來控制程式庫版本。
Kotlin+KTX
```
dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.7.0"))

    // Add the dependency for the App Check library
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-appcheck-debug")
}
```
只要使用 Firebase Android BoM，應用程式就會一律使用相容的 Firebase Android 程式庫版本。
(替代做法) 不使用 BoM 新增 Firebase 程式庫依附元件

如果您選擇不使用 Firebase BoM，則必須在依附元件行中指定每個 Firebase 程式庫版本。

請注意，如果您在應用程式中使用多個 Firebase 程式庫，強烈建議您使用 BoM 來管理程式庫版本，確保所有版本皆相容。
dependencies { // Add the dependency for the App Check library // When NOT using the BoM, you must specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-appcheck-debug:18.0.0") }
想尋找 Kotlin 專屬的程式庫模組嗎？自 2023 年 10 月 (Firebase BoM 32.5.0)起，Kotlin 和 Java 開發人員都可以依附主要程式庫模組 (詳情請參閱這項計畫的常見問題)。
Java
```
dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.7.0"))

    // Add the dependency for the App Check library
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-appcheck-debug")
}
```
只要使用 Firebase Android BoM，應用程式就會一律使用相容的 Firebase Android 程式庫版本。
(替代做法) 不使用 BoM 新增 Firebase 程式庫依附元件

如果您選擇不使用 Firebase BoM，則必須在依附元件行中指定每個 Firebase 程式庫版本。

請注意，如果您在應用程式中使用多個 Firebase 程式庫，強烈建議您使用 BoM 來管理程式庫版本，確保所有版本皆相容。
dependencies { // Add the dependency for the App Check library // When NOT using the BoM, you must specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-appcheck-debug:18.0.0") }
想尋找 Kotlin 專屬的程式庫模組嗎？自 2023 年 10 月 (Firebase BoM 32.5.0)起，Kotlin 和 Java 開發人員都可以依附主要程式庫模組 (詳情請參閱這項計畫的常見問題)。

將下列內容新增至 CI 建構變化版本的設定：

testInstrumentationRunnerArguments["firebaseAppCheckDebugSecret"] =
    System.getenv("APP_CHECK_DEBUG_TOKEN_FROM_CI") ?: ""

在測試類別中，使用 DebugAppCheckTestHelper 包裝需要 App Check 符記的任何程式碼：

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

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

當應用程式在 CI 環境中執行時，Firebase 後端服務會將其傳送的權杖視為有效。