Sử dụng tính năng Kiểm tra ứng dụng bằng trình cung cấp gỡ lỗi trên Android

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ừ môi trường tích hợp liên tục (CI), bạn có thể tạo bản gỡ lỗi của ứng dụng sử dụng nhà cung cấp gỡ lỗi của App Check thay vì nhà cung cấp chứng thực thực.

Sử dụng nhà cung cấp gỡ lỗi trong trình mô phỏng

Để sử dụng nhà cung cấp gỡ lỗi trong khi chạy ứng dụng trong trình mô phỏng một cách tương tác (ví dụ: trong quá trình phát triển), hãy làm như sau:

  1. Trong tệp Gradle của mô-đun (cấp ứng dụng) (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 App Check cho Android. Bạn nên sử dụng Firebase Android BoM để kiểm soát việc quản lý phiên bản thư viện. 

    dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:34.13.0"))

    // 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-debug")
}

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

    (Giải pháp thay thế)  Thêm 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ần phụ thuộc.

    Xin lưu ý rằng nếu bạn sử dụng nhiều thư viện Firebase trong ứng dụng, bạn nên sử dụng BoM để quản lý các phiên bản thư viện nhằm đảm bảo rằng 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-debug:19.0.2")
}

  2. Trong bản gỡ lỗi, hãy định cấu hình App Check để sử dụng nhà máy nhà cung cấp gỡ lỗi:

    Kotlin 

    Firebase.initialize(context = this)
Firebase.appCheck.installAppCheckProviderFactory(
    DebugAppCheckProviderFactory.getInstance(),
)

    Java 

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

  3. Chạy ứng dụng và kích hoạt lệnh gọi đến dịch vụ phụ trợ của Firebase. Mã gỡ lỗi cục bộ sẽ được ghi lại khi SDK cố gắng gửi yêu cầu đến phần phụ trợ. Ví dụ:

    D DebugAppCheckProvider: Enter this debug secret into the allow list in
the Firebase Console for your project: 123a4567-b89c-12d3-e456-789012345678

  4. Trong bảng điều khiển Firebase, hãy chuyển đến phần Bảo mật > Kiểm tra ứng dụng.

  5. Đăng ký mã gỡ lỗi mà bạn vừa ghi lại.

    1. Trong thẻ Ứng dụng, hãy tìm ứng dụng của bạn.
    2. Trong trình đơn mục bổ sung của ứng dụng, hãy chọn Quản lý mã gỡ lỗi.
    3. Làm theo hướng dẫn trên màn hình để đăng ký mã gỡ lỗi.

    Ảnh chụp màn hình mục trong trình đơn Manage Debug Tokens (Quản lý mã gỡ lỗi)

Sau khi bạn đăng ký mã này, các dịch vụ phụ trợ của Firebase sẽ chấp nhận mã này là hợp lệ.

Vì mã này cho phép truy cập vào các tài nguyên Firebase mà không cần thiết bị hợp lệ, nên bạn phải giữ mã này ở chế độ riêng tư. Đừng cam kết mã này vào kho lưu trữ công khai và nếu mã đã đăng ký bị xâm phạm, hãy thu hồi ngay mã đó trong bảng điều khiển Firebase.

Sử dụng nhà cung cấp gỡ lỗi để kiểm thử đơn vị trong môi trường CI

Để sử dụng nhà cung cấp gỡ lỗi để kiểm thử đơn vị trong môi trường tích hợp liên tục (CI), hãy làm như sau:

  1. Trong bảng điều khiển Firebase, hãy chuyển đến phần Bảo mật > Kiểm tra ứng dụng.

  2. Tạo mã gỡ lỗi. Bạn sẽ cần mã này ở bước tiếp theo.

    1. Trong thẻ Ứng dụng, hãy tìm ứng dụng của bạn.
    2. Trong trình đơn mục bổ sung của ứng dụng, hãy chọn Quản lý mã gỡ lỗi.
    3. Làm theo hướng dẫn trên màn hình để tạo mã gỡ lỗi mới.

    Vì mã này cho phép truy cập vào các tài nguyên Firebase mà không cần thiết bị hợp lệ, nên bạn phải giữ mã này ở chế độ riêng tư. Đừng cam kết mã này vào kho lưu trữ công khai và nếu mã đã đăng ký bị xâm phạm, hãy thu hồi ngay mã đó trong bảng điều khiển Firebase.

    Ảnh chụp màn hình mục trong trình đơn Manage Debug Tokens (Quản lý mã gỡ lỗi)

  3. Thêm mã gỡ lỗi mà bạn vừa tạo vào kho khoá an toàn của hệ thống CI (ví dụ: bí mật được mã hoá của GitHub Actions hoặc các biến được mã hoá của Travis CI).

  4. Nếu cần, hãy định cấu hình hệ thống CI để cung cấp mã gỡ lỗi trong môi trường CI dưới dạng biến môi trường. Đặt tên biến là APP_CHECK_DEBUG_TOKEN_FROM_CI.

  5. Trong tệp Gradle của mô-đun (cấp ứng dụng) (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 App Check cho Android. Bạn nên sử dụng Firebase Android BoM để kiểm soát việc quản lý phiên bản thư viện.

    Kotlin 

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

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

    (Giải pháp thay thế)  Thêm 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ần phụ thuộc.

    Xin lưu ý rằng nếu bạn sử dụng nhiều thư viện Firebase trong ứng dụng, bạn nên sử dụng BoM để quản lý các phiên bản thư viện nhằm đả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-debug:19.0.2")
}

    Java 

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

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

    (Giải pháp thay thế)  Thêm 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ần phụ thuộc.

    Xin lưu ý rằng nếu bạn sử dụng nhiều thư viện Firebase trong ứng dụng, bạn nên sử dụng BoM để quản lý các phiên bản thư viện nhằm đả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-debug:19.0.2")
}

  6. Thêm phần sau vào cấu hình của biến thể bản dựng CI:

    testInstrumentationRunnerArguments["firebaseAppCheckDebugSecret"] =
    System.getenv("APP_CHECK_DEBUG_TOKEN_FROM_CI") ?: ""

  7. Trong các lớp kiểm thử, hãy sử dụng DebugAppCheckTestHelper để gói mọi mã cần mã thông báo App Check:

    Kotlin 

    @RunWith(AndroidJunit4::class)
class MyTests {
    private val debugAppCheckTestHelper =
        DebugAppCheckTestHelper.fromInstrumentationArgs()

    @Test
    fun testWithDefaultApp() {
        debugAppCheckTestHelper.withDebugProvider {
            // Test code that requires a debug AppCheckToken.
        }
    }

    @Test
    fun testWithNonDefaultApp() {
        debugAppCheckTestHelper.withDebugProvider(
            FirebaseApp.getInstance("nonDefaultApp")
        ) {
            // Test code that requires a debug AppCheckToken.
        }
    }
}

    Java 

    @RunWith(AndroidJunit4.class)
public class YourTests {
    private final DebugAppCheckTestHelper debugAppCheckTestHelper =
            DebugAppCheckTestHelper.fromInstrumentationArgs();

    @Test
    public void testWithDefaultApp() {
        debugAppCheckTestHelper.withDebugProvider(() -> {
            // Test code that requires a debug AppCheckToken.
        });
    }

    @Test
    public void testWithNonDefaultApp() {
        debugAppCheckTestHelper.withDebugProvider(
                FirebaseApp.getInstance("nonDefaultApp"),
                () -> {
                    // Test code that requires a debug AppCheckToken.
                });
    }
}

Khi ứng dụng của bạn chạy trong môi trường CI, các dịch vụ phụ trợ của Firebase sẽ chấp nhận mã thông báo mà ứng dụng gửi là hợp lệ.