開始在 Android 裝置上透過自訂供應商使用 App Check

本頁面說明如何使用自訂 App Check 供應器，在 Android 應用程式中啟用 App Check。啟用 App Check 後，您就能確保只有您的應用程式可以存取專案的 Firebase 資源。

如果您想將 App Check 與預設的 Play Integrity 提供者搭配使用，請參閱「在 Android 上使用 Play Integrity 啟用 App Check」。

事前準備

1. 將 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.5.1"))

    // 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")
}

只要使用 Firebase Android BoM，應用程式就會一律使用相容的 Firebase Android 程式庫版本。

(替代做法) 新增 Firebase 程式庫依附元件，「不」使用 BoM

如果選擇不使用 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:18.0.0")
}
 想尋找 Kotlin 專屬的程式庫模組嗎？自 2023 年 10 月 (Firebase BoM 32.5.0) 起，Kotlin 和 Java 開發人員都能使用主要程式庫模組 (詳情請參閱這項計畫的常見問題)。

2. 實作 App Check 介面

首先，您需要建立實作 AppCheckProvider 和 AppCheckProviderFactory 介面的類別。

您的 AppCheckProvider 類別必須具備 getToken() 方法，用於收集自訂 App Check 供應商所需的任何資訊，做為真實性的證明，並將其傳送至權杖取得服務，以換取 App Check 權杖。App Check SDK 會處理權杖快取，因此請一律在 getToken() 實作中取得新的權杖。

Kotlin+KTX 

class YourCustomAppCheckToken(
    private val token: String,
    private val expiration: Long,
) : AppCheckToken() {
    override fun getToken(): String = token
    override fun getExpireTimeMillis(): Long = expiration
}

class YourCustomAppCheckProvider(firebaseApp: FirebaseApp) : AppCheckProvider {
    override fun getToken(): Task<AppCheckToken> {
        // Logic to exchange proof of authenticity for an App Check token and
        //   expiration time.
        // ...

        // Refresh the token early to handle clock skew.
        val expMillis = expirationFromServer * 1000L - 60000L

        // Create AppCheckToken object.
        val appCheckToken: AppCheckToken = YourCustomAppCheckToken(tokenFromServer, expMillis)
        return Tasks.forResult(appCheckToken)
    }
}
CustomProvider.kt

Java 

public class YourCustomAppCheckToken extends AppCheckToken {
    private String token;
    private long expiration;

    YourCustomAppCheckToken(String token, long expiration) {
        this.token = token;
        this.expiration = expiration;
    }

    @NonNull
    @Override
    public String getToken() {
        return token;
    }

    @Override
    public long getExpireTimeMillis() {
        return expiration;
    }
}

public class YourCustomAppCheckProvider implements AppCheckProvider {
    public YourCustomAppCheckProvider(FirebaseApp firebaseApp) {
        // ...
    }

    @NonNull
    @Override
    public Task<AppCheckToken> getToken() {
        // Logic to exchange proof of authenticity for an App Check token and
        //   expiration time.
        // ...

        // Refresh the token early to handle clock skew.
        long expMillis = expirationFromServer * 1000L - 60000L;

        // Create AppCheckToken object.
        AppCheckToken appCheckToken =
                new YourCustomAppCheckToken(tokenFromServer, expMillis);

        return Tasks.forResult(appCheckToken);
    }
}
CustomProvider.java

此外，請實作 AppCheckProviderFactory 類別，以便建立 AppCheckProvider 實作的例項：

Kotlin+KTX 

class YourCustomAppCheckProviderFactory : AppCheckProviderFactory {
    override fun create(firebaseApp: FirebaseApp): AppCheckProvider {
        // Create and return an AppCheckProvider object.
        return YourCustomAppCheckProvider(firebaseApp)
    }
}
CustomProvider.kt

Java 

public class YourCustomAppCheckProviderFactory implements AppCheckProviderFactory {
    @NonNull
    @Override
    public AppCheckProvider create(@NonNull FirebaseApp firebaseApp) {
        // Create and return an AppCheckProvider object.
        return new YourCustomAppCheckProvider(firebaseApp);
    }
}
CustomProvider.java

3. 初始化 App Check

將下列初始化程式碼加入應用程式，讓應用程式在使用任何其他 Firebase SDK 前優先執行：

Kotlin+KTX 

Firebase.initialize(context)
Firebase.appCheck.installAppCheckProviderFactory(
    YourCustomAppCheckProviderFactory(),
)
CustomProvider.kt

Java 

FirebaseApp.initializeApp(/*context=*/ context);
FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance();
firebaseAppCheck.installAppCheckProviderFactory(
        new YourCustomAppCheckProviderFactory());
CustomProvider.java

後續步驟

在應用程式中安裝 App Check 程式庫後，請開始向使用者發布更新版應用程式。

更新後的用戶端應用程式將開始傳送 App Check 權杖，以及對 Firebase 發出的每個要求，但在您於 Firebase 控制台的 App Check 區段啟用強制執行之前，Firebase 產品將不需要權杖有效。

監控指標並啟用強制執行功能

不過，在強制執行之前，您應先確認這樣做不會影響現有的合法使用者。另一方面，如果您發現應用程式資源遭到濫用，建議您盡早啟用強制執行功能。

為協助您做出這項決定，您可以查看所用服務的 App Check 指標：

啟用 App Check 強制執行功能

瞭解 App Check 對使用者的影響，您已準備好進行後續步驟時，可以啟用 App Check 強制執行：

在偵錯環境中使用 App Check

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

請參閱「在 Android 上使用 App Check 與偵錯提供者」。