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 đăng ký ứng dụng của mình để Kiểm tra ứng dụng, bạn muốn chạy ứng dụng của mình trong 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 giả lập 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 của bạn 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ự.

Sử dụng trình cung cấp gỡ lỗi trong trình giả lập

Để sử dụng trình cung cấp gỡ lỗi trong khi chạy ứng dụng của bạn 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 mô-đun (cấp ứng dụng) của bạn (thường là app/build.gradle ), hãy khai báo phần phụ thuộc cho thư viện App Check Android:

    Java

    dependencies {
        implementation 'com.google.firebase:firebase-appcheck-debug:16.0.0'
    }
    

    Kotlin+KTX

    dependencies {
        implementation 'com.google.firebase:firebase-appcheck-debug:16.0.0'
    }
    
  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:

    Java

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

    Kotlin+KTX

    FirebaseApp.initializeApp(/*context=*/this)
    val 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, chọn Quản lý mã thông báo gỡ lỗi từ menu mục bổ sung của ứng dụng của bạn. 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 nó 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ệ, điều quan trọng là bạn phải giữ nó ở chế độ riêng tư. Đừng chuyển nó vào một kho lưu trữ công cộng và nếu một mã thông báo đã đăng ký bị xâm phạm, hãy thu hồi nó ngay lập tức trong bảng điều khiển Firebase.

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

Để sử dụng trình cung cấp gỡ lỗi cho kiểm tra đơ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, chọn Quản lý mã thông báo gỡ lỗi từ menu mục bổ sung của ứng dụng của bạn. 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ệ, điều quan trọng là bạn phải giữ nó ở chế độ riêng tư. Đừng chuyển nó vào một kho lưu trữ công cộng và nếu một mã thông báo đã đăng ký bị xâm phạm, hãy thu hồi nó 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ã gỡ lỗi bạn vừa tạo vào kho khóa bảo mật của hệ thống CI của bạn (ví dụ: bí mật được mã hóa của GitHub Actions hoặc cá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 của bạn 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à app/build.gradle ):

    1. Khai báo phần phụ thuộc thử nghiệm cho thư viện gỡ lỗi App Check Android:

      Java

      dependencies {
          androidTestImplementation 'com.google.firebase:firebase-appcheck-debug-testing:16.0.0'
      }
      

      Kotlin+KTX

      dependencies {
          androidTestImplementation 'com.google.firebase:firebase-appcheck-debug-testing:16.0.0'
      }
      
    2. Thêm phần sau vào cấu hình của biến thể bản dựng CI của bạn:

      testInstrumentationRunnerArgument "firebaseAppCheckDebugSecret", System.getenv("APP_CHECK_DEBUG_TOKEN_FROM_CI") ?: ''
      
  5. 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:

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

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

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