开始在 Android 上通过自定义提供程序使用 App Check

此页面向您展示如何使用您的自定义 App Check 提供程序在 Android 应用程序中启用 App Check。当您启用 App Check 时，您有助于确保只有您的应用可以访问您项目的 Firebase 资源。

如果您想将 App Check 与默认的 Play Integrity 提供程序一起使用，请参阅在 Android 上启用 App Check with Play Integrity 。

在你开始之前

• 如果您还没有将 Firebase 添加到您的 Android 项目中，请将其添加到您的 Android 项目中。

• 实施您的自定义 App Check 提供商的服务器端逻辑。

1.将App Check库添加到您的应用中

在您的模块（应用级）Gradle 文件（通常是app/build.gradle ）中，声明 App Check Android 库的依赖项：

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

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

2.实现App Check接口

首先，您需要创建实现AppCheckProvider和AppCheckProviderFactory接口的类。

您的AppCheckProvider类必须有一个 getToken getToken()方法，该方法收集您的自定义 App Check 提供商需要的任何信息作为真实性证明，并将其发送到您的令牌获取服务以换取 App Check 令牌。 App Check SDK 处理令牌缓存，因此始终在您的getToken()实现中获取新令牌。

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

    override fun getExpireTimeMillis(): Long {
        return expiration
    }
}

class YourCustomAppCheckProvider : AppCheckProvider {
    val token: Task<AppCheckToken>
        get() {
            // Logic to exchange proof of authenticity for an App Check token.
            // ...

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

            // Create AppCheckToken object.
            val appCheckToken: AppCheckToken =
                    YourCustomAppCheckToken(tokenFromServer, expMillis)

            return appCheckToken!
        }
}

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 {
    @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 * 1000 - 60000;

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

        return appCheckToken;
    }
}

此外，实现一个AppCheckProviderFactory类来创建AppCheckProvider实现的实例：

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

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

3.初始化App Check

将以下初始化代码添加到您的应用程序，以便它在您使用任何其他 Firebase SDK 之前运行：

FirebaseApp.initializeApp(/*context=*/ this)
val firebaseAppCheck = FirebaseAppCheck.getInstance()
firebaseAppCheck.installAppCheckProviderFactory(
    YourCustomAppCheckProviderFactory.getInstance())

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

下一步

在您的应用程序中安装 App Check 库后，开始将更新后的应用程序分发给您的用户。

更新后的客户端应用程序将开始发送 App Check 令牌及其向 Firebase 发出的每个请求，但 Firebase 产品不会要求令牌有效，直到您在 Firebase 控制台的 App Check 部分启用强制执行。

监控指标并启用强制执行

但是，在您启用强制执行之前，您应该确保这样做不会干扰您现有的合法用户。另一方面，如果您发现对应用资源的可疑使用，您可能希望尽快启用强制措施。

为帮助做出此决定，您可以查看您使用的服务的 App Check 指标：

• 监控实时数据库、Cloud Firestore 和 Cloud Storage 的 App Check 请求指标。
• 监控 Cloud Functions 的 App Check 请求指标。

启用 App Check 强制执行

当您了解 App Check 将如何影响您的用户并准备好继续操作时，您可以启用 App Check 强制执行：

• 为实时数据库、Cloud Firestore 和 Cloud Storage启用 App Check 强制执行。
• 为 Cloud Functions 启用 App Check 强制执行。

在调试环境中使用 App Check

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

请参阅将 App Check 与 Android 上的调试提供程序一起使用。

此页面向您展示如何使用您的自定义 App Check 提供程序在 Android 应用程序中启用 App Check。当您启用 App Check 时，您有助于确保只有您的应用可以访问您项目的 Firebase 资源。

如果您想将 App Check 与默认的 Play Integrity 提供程序一起使用，请参阅在 Android 上启用 App Check with Play Integrity 。

在你开始之前

• 如果您还没有将 Firebase 添加到您的 Android 项目中，请将其添加到您的 Android 项目中。

• 实施您的自定义 App Check 提供商的服务器端逻辑。

1.将App Check库添加到您的应用中

在您的模块（应用级）Gradle 文件（通常是app/build.gradle ）中，声明 App Check Android 库的依赖项：

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

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

2.实现App Check接口

首先，您需要创建实现AppCheckProvider和AppCheckProviderFactory接口的类。

您的AppCheckProvider类必须有一个 getToken getToken()方法，该方法收集您的自定义 App Check 提供商需要的任何信息作为真实性证明，并将其发送到您的令牌获取服务以换取 App Check 令牌。 App Check SDK 处理令牌缓存，因此始终在您的getToken()实现中获取新令牌。

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

    override fun getExpireTimeMillis(): Long {
        return expiration
    }
}

class YourCustomAppCheckProvider : AppCheckProvider {
    val token: Task<AppCheckToken>
        get() {
            // Logic to exchange proof of authenticity for an App Check token.
            // ...

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

            // Create AppCheckToken object.
            val appCheckToken: AppCheckToken =
                    YourCustomAppCheckToken(tokenFromServer, expMillis)

            return appCheckToken!
        }
}

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 {
    @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 * 1000 - 60000;

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

        return appCheckToken;
    }
}

此外，实现一个AppCheckProviderFactory类来创建AppCheckProvider实现的实例：

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

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

3.初始化App Check

将以下初始化代码添加到您的应用程序，以便它在您使用任何其他 Firebase SDK 之前运行：

FirebaseApp.initializeApp(/*context=*/ this)
val firebaseAppCheck = FirebaseAppCheck.getInstance()
firebaseAppCheck.installAppCheckProviderFactory(
    YourCustomAppCheckProviderFactory.getInstance())

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

下一步

在您的应用程序中安装 App Check 库后，开始将更新后的应用程序分发给您的用户。

更新后的客户端应用程序将开始发送 App Check 令牌及其向 Firebase 发出的每个请求，但 Firebase 产品不会要求令牌有效，直到您在 Firebase 控制台的 App Check 部分启用强制执行。

监控指标并启用强制执行

但是，在您启用强制执行之前，您应该确保这样做不会干扰您现有的合法用户。另一方面，如果您发现对应用资源的可疑使用，您可能希望尽快启用强制措施。

为帮助做出此决定，您可以查看您使用的服务的 App Check 指标：

• 监控实时数据库、Cloud Firestore 和 Cloud Storage 的 App Check 请求指标。
• 监控 Cloud Functions 的 App Check 请求指标。

启用 App Check 强制执行

当您了解 App Check 将如何影响您的用户并准备好继续操作时，您可以启用 App Check 强制执行：

• 为实时数据库、Cloud Firestore 和 Cloud Storage启用 App Check 强制执行。
• 为 Cloud Functions 启用 App Check 强制执行。

在调试环境中使用 App Check

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

请参阅将 App Check 与 Android 上的调试提供程序一起使用。

此页面向您展示如何使用您的自定义 App Check 提供程序在 Android 应用程序中启用 App Check。当您启用 App Check 时，您有助于确保只有您的应用可以访问您项目的 Firebase 资源。

如果您想将 App Check 与默认的 Play Integrity 提供程序一起使用，请参阅在 Android 上启用 App Check with Play Integrity 。

在你开始之前

• 如果您还没有将 Firebase 添加到您的 Android 项目中，请将其添加到您的 Android 项目中。

• 实施您的自定义 App Check 提供商的服务器端逻辑。

1.将App Check库添加到您的应用中

在您的模块（应用级）Gradle 文件（通常是app/build.gradle ）中，声明 App Check Android 库的依赖项：

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

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

2.实现App Check接口

首先，您需要创建实现AppCheckProvider和AppCheckProviderFactory接口的类。

您的AppCheckProvider类必须有一个 getToken getToken()方法，该方法收集您的自定义 App Check 提供商需要的任何信息作为真实性证明，并将其发送到您的令牌获取服务以换取 App Check 令牌。 App Check SDK 处理令牌缓存，因此始终在您的getToken()实现中获取新令牌。

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

    override fun getExpireTimeMillis(): Long {
        return expiration
    }
}

class YourCustomAppCheckProvider : AppCheckProvider {
    val token: Task<AppCheckToken>
        get() {
            // Logic to exchange proof of authenticity for an App Check token.
            // ...

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

            // Create AppCheckToken object.
            val appCheckToken: AppCheckToken =
                    YourCustomAppCheckToken(tokenFromServer, expMillis)

            return appCheckToken!
        }
}

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 {
    @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 * 1000 - 60000;

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

        return appCheckToken;
    }
}

此外，实现一个AppCheckProviderFactory类来创建AppCheckProvider实现的实例：

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

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

3.初始化App Check

将以下初始化代码添加到您的应用程序，以便它在您使用任何其他 Firebase SDK 之前运行：

FirebaseApp.initializeApp(/*context=*/ this)
val firebaseAppCheck = FirebaseAppCheck.getInstance()
firebaseAppCheck.installAppCheckProviderFactory(
    YourCustomAppCheckProviderFactory.getInstance())

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

下一步

在您的应用程序中安装 App Check 库后，开始将更新后的应用程序分发给您的用户。

更新后的客户端应用程序将开始发送 App Check 令牌及其向 Firebase 发出的每个请求，但 Firebase 产品不会要求令牌有效，直到您在 Firebase 控制台的 App Check 部分启用强制执行。

监控指标并启用强制执行

但是，在您启用强制执行之前，您应该确保这样做不会干扰您现有的合法用户。另一方面，如果您发现对应用资源的可疑使用，您可能希望尽快启用强制措施。

为帮助做出此决定，您可以查看您使用的服务的 App Check 指标：

• 监控实时数据库、Cloud Firestore 和 Cloud Storage 的 App Check 请求指标。
• 监控 Cloud Functions 的 App Check 请求指标。

启用 App Check 强制执行

当您了解 App Check 将如何影响您的用户并准备好继续操作时，您可以启用 App Check 强制执行：

• 为实时数据库、Cloud Firestore 和 Cloud Storage启用 App Check 强制执行。
• 为 Cloud Functions 启用 App Check 强制执行。

在调试环境中使用 App Check

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

请参阅将 App Check 与 Android 上的调试提供程序一起使用。