了解 2023 年 Google I/O 大会上介绍的 Firebase 亮点。了解详情

Sử dụng Kiểm tra ứng dụng với nhà cung cấp gỡ lỗi trên Android

Nếu sau khi bạn đã đăng ký ứng dụng của mình cho Kiểm tra ứng dụng, bạn muốn chạy ứng dụng của mình trong một môi trường mà Kiểm tra ứng dụng thường không được 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 dựng gỡ lỗi của ứng dụng sử dụng nhà cung cấp gỡ lỗi Kiểm tra ứng dụng 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 giả lập

Để sử dụng nhà cung cấp gỡ lỗi trong khi chạy ứng dụng của bạn trong trình giả lập 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 mô-đun (cấp ứng dụng) của bạn (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 Kiểm tra ứng dụng Thư viện Android. Chúng tôi khuyên bạn nên sử dụng Firebase Android BoM để kiểm soát việc lập phiên bản thư viện.

    Kotlin+KTX

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

    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 Firebase.

    (Thay thế) Thêm phụ thuộc thư viện Firebase mà không cần 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 của nó.

    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ự khuyên bạn nên sử dụng BoM để quản lý các phiên bản thư viện, điều này đả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:17.0.1")
    implementation("com.google.firebase:firebase-appcheck-ktx:17.0.1")
    }

    Java

    dependencies {
        // Import the BoM for the Firebase platform
        implementation(platform("com.google.firebase:firebase-bom:32.3.1"))
    
        // 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 các phiên bản tương thích của thư viện Android Firebase.

    (Thay thế) Thêm phụ thuộc thư viện Firebase mà không cần 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 của nó.

    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ự khuyên bạn nên sử dụng BoM để quản lý các phiên bản thư viện, điều này đả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:17.0.1")
    }
    

  2. Trong bản dựng gỡ lỗi của bạn, hãy định cấu hình Kiểm tra ứng dụng để sử dụng nhà máy của nhà cung cấp gỡ lỗi:

    Kotlin+KTX

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

    Java

    FirebaseApp.initializeApp(/*context=*/ this);
    FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance();
    firebaseAppCheck.installAppCheckProviderFactory(
            DebugAppCheckProviderFactory.getInstance());
  3. Khởi chạy ứng dụng và kích hoạt cuộc gọi đến dịch vụ phụ trợ Firebase. Mã thông báo 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 phần Kiểm tra ứng dụng của bảng điều khiển Firebase, hãy chọn Quản lý mã thông báo gỡ lỗi từ menu mục bổ sung của ứng dụng. Sau đó, đăng ký mã thông báo gỡ lỗi mà bạn đã đăng nhập ở bước trước.

    Ảnh chụp màn hình của mục menu Quản lý mã thông báo gỡ lỗi

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

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

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

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

  1. Trong phần Kiểm tra ứng dụng của bảng điều khiển Firebase, hãy chọn Quản lý mã thông báo gỡ lỗi từ menu mục bổ sung của ứng dụng. Sau đó, tạo mã thông báo gỡ lỗi mới. Bạn sẽ cần mã thông báo trong bước tiếp theo.

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

    Ảnh chụp màn hình của mục menu Quản lý mã thông báo gỡ lỗi

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

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

  4. Trong tệp Gradle mô-đun (cấp ứng dụng) của bạn (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 Kiểm tra ứng dụng Thư viện Android. Chúng tôi khuyên bạn nên sử dụng Firebase Android BoM để kiểm soát việc lập phiên bản thư viện.

    Kotlin+KTX

    dependencies {
        // Import the BoM for the Firebase platform
        implementation(platform("com.google.firebase:firebase-bom:32.3.1"))
    
        // Add the dependency for the App Check library
        // When using the BoM, you don't specify versions in Firebase library dependencies
        androidTestImplementation("com.google.firebase:firebase-appcheck-debug-testing")
    }
    

    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 Firebase.

    (Thay thế) Thêm phụ thuộc thư viện Firebase mà không cần 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 của nó.

    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ự khuyên bạn nên sử dụng BoM để quản lý các phiên bản thư viện, điều 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
        androidTestImplementation("com.google.firebase:firebase-appcheck-debug-testing:17.0.1")
    }
    

    Java

    dependencies {
        // Import the BoM for the Firebase platform
        implementation(platform("com.google.firebase:firebase-bom:32.3.1"))
    
        // Add the dependency for the App Check library
        // When using the BoM, you don't specify versions in Firebase library dependencies
        androidTestImplementation("com.google.firebase:firebase-appcheck-debug-testing")
    }
    

    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 Firebase.

    (Thay thế) Thêm phụ thuộc thư viện Firebase mà không cần 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 của nó.

    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ự khuyên bạn nên sử dụng BoM để quản lý các phiên bản thư viện, điều 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
        androidTestImplementation("com.google.firebase:firebase-appcheck-debug-testing:17.0.1")
    }
    

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

    testInstrumentationRunnerArguments["firebaseAppCheckDebugSecret"] =
        System.getenv("APP_CHECK_DEBUG_TOKEN_FROM_CI") ?: ""
    
  6. Trong các lớp thử nghiệm của bạn, hãy sử dụng DebugAppCheckTestHelper để bọc bất kỳ mã nào cần mã thông báo Kiểm tra ứng dụng:

    Kotlin+KTX

    @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à nó gửi là hợp lệ.