本页介绍了如何使用自定义 App Check 提供程序在 Android 应用中启用 App Check。启用 App Check 有助于确保只有您的应用可以访问项目的 Firebase 资源。
如果您希望将 App Check 与默认的 Play Integrity 提供程序搭配使用,请参阅使用 Play Integrity 启用 App Check (Android)。
准备工作
1. 将 App Check 库添加到您的应用
在您的模块(应用级)Gradle 文件(通常是 app/build.gradle
)中,声明 App Check Android 库的依赖项:
Kotlin+KTX
dependencies {
implementation 'com.google.firebase:firebase-appcheck:16.1.2'
}
Java
dependencies {
implementation 'com.google.firebase:firebase-appcheck:16.1.2'
}
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 {
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!
}
}
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 {
@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
实现的实例:
Kotlin+KTX
class YourCustomAppCheckProviderFactory : AppCheckProviderFactory {
fun create(firebaseApp: FirebaseApp): AppCheckProvider {
// Create and return an AppCheckProvider object.
return YourCustomAppCheckProvider(firebaseApp)
}
}
Java
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 之前运行:
Kotlin+KTX
FirebaseApp.initializeApp(/*context=*/ this)
val firebaseAppCheck = FirebaseAppCheck.getInstance()
firebaseAppCheck.installAppCheckProviderFactory(
YourCustomAppCheckProviderFactory.getInstance())
Java
FirebaseApp.initializeApp(/*context=*/ this);
FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance();
firebaseAppCheck.installAppCheckProviderFactory(
YourCustomAppCheckProviderFactory.getInstance());
后续步骤
将 App Check 库安装到您的应用中之后,开始将更新后的应用分发给用户。
更新后的客户端应用会开始将 App Check 令牌随其发出的每个请求一起发送到 Firebase;不过,您在 Firebase 控制台的 App Check 部分中启用强制执行之前,Firebase 产品并不会要求令牌必须有效。
监控指标并启用强制执行
不过,在启用强制执行之前,您应该确保这样做不会干扰现有的正当用户。另一方面,如果您发现自己的应用资源被非法使用,建议您尽快启用强制执行。
为帮助您做出相关决策,建议您查看自己使用的服务的 App Check 指标:
- 监控 Realtime Database、Cloud Firestore 和 Cloud Storage 的 App Check 请求指标。
- 监控 Cloud Functions 的 App Check 请求指标。
启用 App Check 强制执行
在了解 App Check 对用户有何影响并为后续操作做好准备之后,您便可以启用 App Check 强制执行:
- 为 Realtime Database、Cloud Firestore 和 Cloud Storage 启用 App Check 强制执行。
- 为 Cloud Functions 启用 App Check 强制执行。
在调试环境中使用 App Check
为 App Check 注册应用后,如果您希望在 App Check 通常不会归类为有效提供程序的环境(例如开发期间的模拟器)或持续集成 (CI) 环境中运行您的应用,可以创建应用的调试 build,该 build 使用 App Check 调试提供程序,而不是真正的证明提供程序。
请参阅将 App Check 与调试提供程序搭配使用 (Android)。