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 tính năng Kiểm tra ứng dụng trong một ứng dụng Android bằng trình cung cấp Kiểm tra ứng dụng tuỳ chỉnh của bạn. Khi bật tính năng Kiểm tra ứng dụng, 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 tính năng Kiểm tra ứng dụng với nhà cung cấp API Tính toàn vẹn của Play mặc định, hãy xem bài viết Bật tính năng Kiểm tra ứng dụng 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 Kiểm tra ứng dụng vào ứng dụng của bạn

Trong tệp Gradle (cấp ứng dụng) trong mô-đun (thường là <project>/<app-module>/build.gradle.kts hoặc <project>/<app-module>/build.gradle), hãy thêm phần phụ thuộc cho thư viện Kiểm tra ứng dụng dành 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.1.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")
}

Bằng cách 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.

(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 BoM của Firebase, bạn phải chỉ định từng phiên bản thư viện Firebase trong dòng phần phụ thuộc.

Xin lưu ý rằng nếu sử dụng nhiều thư viện Firebase trong ứng dụng, thì bạn nên sử dụng BoM để quản lý các phiên bản thư viện, qua đó đảm bảo 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? Kể từ 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, vui lòng xem Câu hỏi thường gặp về sáng kiến này).

2. Triển khai giao diện Kiểm tra ứng dụng

Trước tiên, bạn cần tạo các lớp triển khai giao diện AppCheckProviderAppCheckProviderFactory.

Lớp AppCheckProvider của bạn phải có một phương thức getToken(). Phương thức này sẽ thu thập mọi thông tin mà trình cung cấp tính năng Kiểm tra ứng dụng tuỳ chỉnh của bạn yêu cầu làm bằng chứng về tính xác thực và gửi thông tin đó đến dịch vụ thu nạp mã thông báo để đổi lấy mã thông báo Kiểm tra ứng dụng. SDK Kiểm tra ứng dụng 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 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)
    }
}

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

Ngoài ra, hãy triển khai một lớp AppCheckProviderFactory sẽ tạo các bản sao của quá trình triển khai AppCheckProvider:

Kotlin+KTX

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

Java

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

3. Chạy tính năng Kiểm tra ứng dụng

Thêm mã khởi chạy sau đây vào ứng dụng của bạn để ứ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(),
)

Java

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

Các bước tiếp theo

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

Ứng dụng khách đã cập nhật sẽ bắt đầu gửi mã thông báo Kiểm tra ứng dụng cùng với mọi yêu cầu mà ứng dụng đưa ra đến Firebase. Tuy nhiên, các sản phẩm của Firebase sẽ không bắt buộc mã thông báo phải hợp lệ cho đến khi bạn bật tính năng thực thi trong mục Kiểm tra ứng dụng 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 này sẽ không làm gián đoạn những người dùng hợp lệ hiện tại của bạn. Mặt khác, nếu nhận thấy có dấu hiệu khả nghi trong việc sử dụng tài nguyên ứng dụng của mình, thì bạn nên sớm triển khai biện pháp thực thi.

Để giúp đưa ra quyết định này, bạn có thể xem các chỉ số Kiểm tra ứng dụng cho các dịch vụ mà bạn sử dụng:

Bật chế độ thực thi tính năng Kiểm tra ứng dụng

Khi đã hiểu rõ mức độ ảnh hưởng của tính năng Kiểm tra ứng dụng đến người dùng và đã sẵn sàng tiếp tục, bạn có thể bật tính năng thực thi tính năng Kiểm tra ứng dụng:

Sử dụng tính năng Kiểm tra ứng dụng trong môi trường gỡ lỗi

Nếu sau khi đã đăng ký ứng dụng cho tính năng Kiểm tra ứng dụng, bạn muốn chạy ứng dụng trong một môi trường mà tính năng Kiểm tra ứng dụng 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ừ môi trường tích hợp liên tục (CI), thì 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 dịch vụ gỡ lỗi Kiểm tra ứng dụng thay vì nhà cung cấp chứng thực thực.

Xem bài viết Sử dụng tính năng Kiểm tra ứng dụng với trình cung cấp gỡ lỗi trên Android.