Bắt đầu sử dụng 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

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 API Tính toàn vẹn của Play được tích hợp sẵ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. Xem bài viết Tổng quan về tính năng này.

Hiện tại, trình cung cấp dịch vụ API Tính toàn vẹn của Play tích hợp sẵn chỉ hỗ trợ các ứng dụng Android do Google Play phân phối. Để sử dụng các tính năng của API Tính toàn vẹn của Play ngoài Play hoặc để sử dụng tính năng Kiểm tra ứng dụng với nhà cung cấp tuỳ chỉnh của riêng bạn, hãy xem bài viết Triển khai nhà cung cấp Kiểm tra ứng dụng tuỳ chỉnh.

1. Thiết lập dự án Firebase

  1. Thêm Firebase vào dự án Android nếu bạn chưa thực hiện việc này.

  2. Bật API Tính toàn vẹn của Play:

    1. Trong Google Play Console, hãy chọn hoặc thêm ứng dụng của bạn nếu bạn chưa thêm.

    2. Trong phần Bản phát hành, hãy nhấp vào Tính toàn vẹn của ứng dụng.

    3. Chuyển đến mục API Tính toàn vẹn của Play của trang này, nhấp vào Liên kết dự án trên đám mây, sau đó chọn dự án Firebase của bạn trong danh sách các dự án trên Google Cloud. Dự án bạn chọn ở đây phải giống với dự án Firebase mà bạn đăng ký ứng dụng của mình (xem bước tiếp theo).

  3. Đăng ký ứng dụng của bạ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 trong mục Kiểm tra ứng dụng của bảng điều khiển của Firebase. Bạn cần cung cấp vân tay số SHA-256 của chứng chỉ ký của ứng dụng.

    Thông thường, bạn cần đăng ký tất cả ứng dụng trong dự án của mình, vì sau khi bạn bật chế độ thực thi cho một sản phẩm Firebase, chỉ những ứng dụng đã đăng ký mới có thể truy cập vào tài nguyên phụ trợ của sản phẩm.

  4. Không bắt buộc: Trong phần cài đặt đăng ký ứng dụng, hãy đặt thời gian tồn tại (TTL) tuỳ chỉnh cho mã thông báo Kiểm tra ứng dụng do nhà cung cấp cấp. Bạn có thể đặt TTL thành bất kỳ giá trị nào trong khoảng từ 30 phút đến 7 ngày. Khi thay đổi giá trị này, hãy lưu ý đến những yếu tố đánh đổi sau:

    • Bảo mật: TTL ngắn hơn mang lại khả năng bảo mật mạnh mẽ hơn vì giúp giảm khoảng thời gian mà mã thông báo bị rò rỉ hoặc bị chặn có thể bị kẻ tấn công lợi dụng.
    • Hiệu suất: TTL ngắn hơn nghĩa là ứng dụng sẽ thực hiện quy trình chứng thực thường xuyên hơn. Vì quy trình chứng thực ứng dụng sẽ tăng thêm độ trễ cho các yêu cầu mạng mỗi khi thực hiện, nên một TTL ngắn có thể ảnh hưởng đến hiệu suất của ứng dụng.
    • Hạn mức và chi phí: TTL ngắn hơn và việc chứng thực lại thường xuyên làm giảm hạn mức nhanh hơn. Trong khi đó, đối với các dịch vụ có tính phí, chi phí có thể cao hơn. Xem Hạn mức và giới hạn.

    Đối với hầu hết các ứng dụng, TTL mặc định là 1 giờ. Xin lưu ý rằng thư viện Kiểm tra ứng dụng làm mới các mã thông báo trong khoảng thời gian khoảng một nửa thời lượng TTL.

2. 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.2"))

    // Add the dependencies for the App Check libraries
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-appcheck-playintegrity")
}

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 dependencies for the App Check libraries
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-appcheck-playintegrity: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).

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 = this)
Firebase.appCheck.installAppCheckProviderFactory(
    PlayIntegrityAppCheckProviderFactory.getInstance(),
)

Java

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

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.