Bắt đầu sử dụng tính năng Kiểm tra ứng dụng qua một nhà cung cấp tuỳ chỉnh trên Android

Trang này cho bạn biết cách bật App Check trong ứng dụng Android bằng nhà cung cấp App Check tuỳ chỉnh. Khi bạn bật App Check, bạn giúp đảm bảo rằng chỉ ứng dụng của bạn mới có thể truy cập vào tài nguyên Firebase của dự án.

Nếu bạn muốn sử dụng App Check với nhà cung cấp API Tính toàn vẹn của Play mặc định, hãy xem Bật App Check bằng API Tính toàn vẹn của Play trên Android.

Trước khi bắt đầu

1. Thêm thư viện App Check vào ứng dụng của bạn

Trong tệp Gradle mô-đun (cấp ứng dụng) (thường là <project>/<app-module>/build.gradle.kts hoặc <project>/<app-module>/build.gradle), thêm phần phụ thuộc cho thư viện App Check cho Android. Bạn nên sử dụng Firebase Android BoM để kiểm soát việc tạo phiên bản thư viện. 

dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.2.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")
}

Khi sử dụng Firebase Android BoM, ứng dụng của bạn sẽ luôn sử dụng các phiên bản tương thích của thư viện Android trên Firebase.

(Phương án thay thế) Thêm các phần phụ thuộc của thư viện Firebase mà không sử dụng BoM

Nếu chọn không sử dụng Firebase BoM, bạn phải chỉ định từng phiên bản thư viện Firebase trong dòng phụ thuộc.

Lưu ý rằng nếu bạn sử dụng nhiều thư viện Firebase trong ứng dụng của mình, chúng tôi thực sự bạn nên sử dụng BoM để quản lý các phiên bản thư viện. Việc này đảm bảo rằng tất cả các phiên bản đều tương thích. 

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")
}
Bạn đang tìm một mô-đun thư viện dành riêng cho Kotlin? Bắt đầu sau Tháng 10 năm 2023 (Firebase BoM 32.5.0), cả nhà phát triển Kotlin và Java đều có thể phụ thuộc vào mô-đun thư viện chính (để biết thông tin chi tiết, hãy xem Câu hỏi thường gặp về sáng kiến này).

2. Triển khai giao diện App Check

Trước tiên, bạn cần tạo các lớp triển khai AppCheckProvider và Giao diện AppCheckProviderFactory.

Lớp AppCheckProvider của bạn phải có một phương thức getToken() để thu thập bất kỳ thông tin nào mà nhà cung cấp App Check tuỳ chỉnh của bạn yêu cầu làm bằng chứng về xác thực và gửi mã đó đến dịch vụ thu thập mã thông báo của bạn để đổi lấy Mã thông báo App Check. SDK App Check xử lý việc lưu mã thông báo vào bộ nhớ đệm, vì vậy, hãy luôn nhận được mã thông báo mới trong quá trình triển khai 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

Ngoài ra, hãy triển khai lớp AppCheckProviderFactory để tạo các bản sao của Cách triển khai 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. Khởi chạy App Check

Thêm mã khởi động sau đây vào ứng dụng để chạy trước khi bạn sử dụng bất kỳ Firebase SDK nào khác:

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

Các bước tiếp theo

Sau khi thư viện App Check được cài đặt trong ứng dụng, hãy bắt đầu phân phối được cập nhật ứng dụng cho người dùng của mình.

Ứng dụng khách đã cập nhật sẽ bắt đầu gửi App Check mã thông báo cùng với mỗi yêu cầu gửi mã đó đến Firebase, nhưng các sản phẩm của Firebase sẽ không yêu cầu mã có hiệu lực cho đến khi bạn cho phép thực thi trong phần App Check của bảng điều khiển của Firebase.

Theo dõi các chỉ số và cho phép thực thi

Tuy nhiên, trước khi bật tính năng thực thi, bạn nên đảm bảo rằng việc bật chế độ thực thi sẽ không làm gián đoạn những người dùng hợp lệ hiện tại. Mặt khác, nếu bạn thấy sử dụng tài nguyên ứng dụng của bạn một cách đáng ngờ, bạn có thể muốn cho phép thực thi sớm hơn.

Để đưa ra quyết định này, bạn có thể xem xét các chỉ số App Check về dịch vụ bạn sử dụng:

Cho phép thực thi App Check

Khi bạn hiểu được App Check sẽ ảnh hưởng như thế nào đến người dùng của mình và bạn đã sẵn sàng tiếp tục, bạn có thể bật tính năng thực thi App Check:

Sử dụng App Check trong môi trường gỡ lỗi

Nếu sau khi đăng ký ứng dụng cho App Check, bạn muốn chạy ứng dụng trong một môi trường mà App Check thường không phân loại là hợp lệ, chẳng hạn như trình mô phỏng trong quá trình phát triển hoặc từ quá trình tích hợp liên tục (CI) bạn có thể tạo một bản gỡ lỗi của ứng dụng sử dụng Trình cung cấp gỡ lỗi App Check thay vì một nhà cung cấp dịch vụ chứng thực thực.

Xem phần Sử dụng App Check với trình cung cấp gỡ lỗi trên Android.