Bắt đầu sử dụng Cấu hình từ xa Firebase


Bạn có thể sử dụng Firebase Remote Config để xác định các tham số trong ứng dụng và cập nhật các giá trị của chúng trên đám mây, cho phép bạn sửa đổi giao diện và hành vi của ứng dụng của bạn mà không phân phối bản cập nhật ứng dụng. Hướng dẫn này sẽ hướng dẫn bạn các bước để bắt đầu và cung cấp một số mã mẫu. Bạn có thể sao chép hoặc tải tất cả mã này xuống từ kho lưu trữ GitHub firebase/quickstart-android.

Bước 1: Thêm Firebase và SDK Cấu hình từ xa vào ứng dụng

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

  2. Đối với Remote Config, bạn phải sử dụng Google Analytics để nhắm mục tiêu có điều kiện các phiên bản ứng dụng đến thuộc tính người dùng và đối tượng. Đảm bảo rằng bạn bật Google Analytics trong dự án của mình.

  3. Trong tệp Gradle (ở cấp ứng dụng) của 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 Remote Config 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.

    Ngoài ra, trong quá trình thiết lập Analytics, bạn cần thêm SDK Firebase cho Google Analytics vào ứng dụng của mình.

    dependencies {
        // Import the BoM for the Firebase platform
        implementation(platform("com.google.firebase:firebase-bom:33.4.0"))
    
        // Add the dependencies for the Remote Config and Analytics libraries
        // When using the BoM, you don't specify versions in Firebase library dependencies
        implementation("com.google.firebase:firebase-config")
        implementation("com.google.firebase:firebase-analytics")
    }
    

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

    (Phương án thay thế)  Thêm các phần phụ thuộc 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ụ thuộc.

    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ự bạn nên sử dụng BoM để quản lý các phiên bản thư viện. Việc 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 Remote Config and Analytics libraries
        // When NOT using the BoM, you must specify versions in Firebase library dependencies
        implementation("com.google.firebase:firebase-config:22.0.0")
        implementation("com.google.firebase:firebase-analytics:22.1.2")
    }
    
    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, hãy xem Câu hỏi thường gặp về sáng kiến này).

Bước 2: Lấy đối tượng singleton Remote Config

Tải một phiên bản đối tượng Remote Config và đặt khoảng thời gian tìm nạp tối thiểu để cho phép làm mới thường xuyên:

Kotlin+KTX

val remoteConfig: FirebaseRemoteConfig = Firebase.remoteConfig
val configSettings = remoteConfigSettings {
    minimumFetchIntervalInSeconds = 3600
}
remoteConfig.setConfigSettingsAsync(configSettings)

Java

FirebaseRemoteConfig mFirebaseRemoteConfig = FirebaseRemoteConfig.getInstance();
FirebaseRemoteConfigSettings configSettings = new FirebaseRemoteConfigSettings.Builder()
        .setMinimumFetchIntervalInSeconds(3600)
        .build();
mFirebaseRemoteConfig.setConfigSettingsAsync(configSettings);

Đối tượng singleton được dùng để lưu trữ các giá trị tham số mặc định trong ứng dụng, tìm nạp đã cập nhật các giá trị tham số từ phần phụ trợ và kiểm soát thời điểm các giá trị được tìm nạp được cung cấp cho ứng dụng của bạn.

Trong quá trình phát triển, bạn nên đặt khoảng thời gian tìm nạp tối thiểu tương đối thấp. Hãy xem phần Điều tiết để biết thêm thông tin.

Bước 3: Đặt giá trị tham số mặc định trong ứng dụng

Bạn có thể đặt giá trị tham số mặc định trong ứng dụng trong đối tượng Remote Config để ứng dụng của bạn hoạt động như dự kiến trước khi kết nối với phần phụ trợ Remote Config và để có giá trị mặc định nếu không có giá trị nào được đặt trong phần phụ trợ.

  1. Xác định một tập hợp tên thông số và giá trị thông số mặc định bằng cách sử dụng Ánh xạ hoặc một đối tượng Tệp tài nguyên XML được lưu trữ trong thư mục res/xml của ứng dụng. Ứng dụng mẫu nhanh Remote Config sử dụng tệp XML để xác định tên và giá trị thông số mặc định.

    Nếu bạn đã định cấu hình Remote Config giá trị tham số phụ trợ, bạn có thể tải một tệp XML đã tạo bao gồm tất cả các giá trị mặc định và lưu tệp đó vào thư mục res/xml của ứng dụng:

    Kiến trúc chuyển trạng thái đại diện (REST)

    curl --compressed -D headers -H "Authorization: Bearer token" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig:downloadDefaults?format=XML -o remote_config_defaults.xml
    

    Bảng điều khiển Firebase

    1. Trong ngăn Parameters (Tham số) tab, mở Trình đơn và chọn Tải xuống giá trị mặc định.

    2. Khi được nhắc, hãy bật .xml cho Android, sau đó nhấp vào Tải tệp xuống.

  2. Thêm các giá trị này vào đối tượng Remote Config bằng cách sử dụng setDefaultsAsync(int) thân mến! như được hiển thị:

    Kotlin+KTX

    remoteConfig.setDefaultsAsync(R.xml.remote_config_defaults)

    Java

    mFirebaseRemoteConfig.setDefaultsAsync(R.xml.remote_config_defaults);

Bước 4: Nhận giá trị thông số để sử dụng trong ứng dụng

Bây giờ, bạn có thể lấy giá trị tham số từ đối tượng Remote Config. Nếu bạn đặt các giá trị trong phần phụ trợ, tìm nạp rồi kích hoạt các giá trị đó các giá trị đó có sẵn cho ứng dụng của bạn. Nếu không, bạn sẽ nhận được ứng dụng các giá trị thông số được định cấu hình bằng cách sử dụng setDefaultsAsync(int). Để lấy các giá trị này, hãy gọi phương thức được liệt kê bên dưới ánh xạ đến loại dữ liệu mà ứng dụng của bạn dự kiến, cung cấp khoá tham số dưới dạng đối số:

Bước 5: Đặt giá trị cho tham số trong phần phụ trợ Remote Config

Khi sử dụng bảng điều khiển Firebase hoặc API phần phụ trợ Remote Config, bạn có thể tạo các giá trị mặc định mới phía máy chủ để ghi đè các giá trị trong ứng dụng theo logic có điều kiện hoặc tiêu chí nhắm mục tiêu người dùng mà bạn muốn. Phần này mô tả các bước trong bảng điều khiển Firebase để tạo các giá trị này.

  1. Trong bảng điều khiển Firebase, hãy mở dự án của bạn.
  2. Chọn Remote Config trong trình đơn để xem trang tổng quan Remote Config.
  3. Xác định các tham số có cùng tên với các tham số mà bạn đã xác định trong ứng dụng của bạn. Đối với mỗi thông số, bạn có thể đặt giá trị mặc định (giá trị này sẽ cuối cùng sẽ ghi đè giá trị mặc định tương ứng trong ứng dụng) và bạn cũng có thể đặt giá trị có điều kiện. Để tìm hiểu thêm, hãy xem phần Thông số và điều kiện Remote Config.

Bước 6: Tìm nạp và kích hoạt các giá trị

  1. Để tìm nạp giá trị tham số từ phần phụ trợ Remote Config, hãy gọi phương thức fetch(). Hệ thống sẽ tìm nạp mọi giá trị mà bạn đã thiết lập trong phần phụ trợ và được lưu trữ trong đối tượng Remote Config.
  2. Để cung cấp giá trị tham số đã tìm nạp cho ứng dụng, hãy gọi phương thức activate().

    Trong trường hợp bạn muốn tìm nạp và kích hoạt các giá trị trong một lệnh gọi, bạn có thể sử dụng yêu cầu fetchAndActivate() để tìm nạp các giá trị từ phần phụ trợ Remote Config và cung cấp các giá trị đó cho ứng dụng:

    Kotlin+KTX

    remoteConfig.fetchAndActivate()
        .addOnCompleteListener(this) { task ->
            if (task.isSuccessful) {
                val updated = task.result
                Log.d(TAG, "Config params updated: $updated")
                Toast.makeText(
                    this,
                    "Fetch and activate succeeded",
                    Toast.LENGTH_SHORT,
                ).show()
            } else {
                Toast.makeText(
                    this,
                    "Fetch failed",
                    Toast.LENGTH_SHORT,
                ).show()
            }
            displayWelcomeMessage()
        }

    Java

    mFirebaseRemoteConfig.fetchAndActivate()
            .addOnCompleteListener(this, new OnCompleteListener<Boolean>() {
                @Override
                public void onComplete(@NonNull Task<Boolean> task) {
                    if (task.isSuccessful()) {
                        boolean updated = task.getResult();
                        Log.d(TAG, "Config params updated: " + updated);
                        Toast.makeText(MainActivity.this, "Fetch and activate succeeded",
                                Toast.LENGTH_SHORT).show();
    
                    } else {
                        Toast.makeText(MainActivity.this, "Fetch failed",
                                Toast.LENGTH_SHORT).show();
                    }
                    displayWelcomeMessage();
                }
            });

Bởi vì các giá trị thông số được cập nhật này ảnh hưởng đến hành vi và giao diện của ứng dụng, bạn nên kích hoạt các giá trị đã tìm nạp cùng một lúc để đảm bảo trải nghiệm mượt mà cho người dùng, chẳng hạn như vào lần tiếp theo người dùng mở . Xem chiến lược tải Cấu hình từ xa để biết thêm thông tin và ví dụ.

Bước 7: Theo dõi thông tin cập nhật theo thời gian thực

Sau khi tìm nạp các giá trị tham số, bạn có thể sử dụng Remote Config theo thời gian thực để nghe thông tin cập nhật từ phần phụ trợ Remote Config. Theo thời gian thực Remote Config tín hiệu được gửi đến các thiết bị đã kết nối khi có bản cập nhật và tự động tìm nạp các thay đổi sau khi xuất bản một Remote Config mới .

SDK Firebase hỗ trợ bản cập nhật theo thời gian thực dành cho Android phiên bản 21.3.0 trở lên (Firebase BoM phiên bản 31.2.4 trở lên).

  1. Trong ứng dụng, hãy dùng addOnConfigUpdateListener() để bắt đầu nghe thông tin cập nhật và tự động tìm nạp mọi giá trị thông số mới. Triển khai lệnh gọi lại onUpdate() để kích hoạt cấu hình đã cập nhật.

    Kotlin+KTX

    remoteConfig.addOnConfigUpdateListener(object : ConfigUpdateListener {
        override fun onUpdate(configUpdate : ConfigUpdate) {
           Log.d(TAG, "Updated keys: " + configUpdate.updatedKeys);
    
           if (configUpdate.updatedKeys.contains("welcome_message")) {
               remoteConfig.activate().addOnCompleteListener {
                   displayWelcomeMessage()
               }
           }
        }
    
        override fun onError(error : FirebaseRemoteConfigException) {
            Log.w(TAG, "Config update error with code: " + error.code, error)
        }
    })
    

    Java

    mFirebaseRemoteConfig.addOnConfigUpdateListener(new ConfigUpdateListener() {
        @Override
        public void onUpdate(ConfigUpdate configUpdate) {
            Log.d(TAG, "Updated keys: " + configUpdate.getUpdatedKeys());
            mFirebaseRemoteConfig.activate().addOnCompleteListener(new OnCompleteListener<Boolean>() {
                @Override
                public void onComplete(@NonNull Task<Boolean> task) {
                    displayWelcomeMessage();
                }
            });
        }
        @Override
        public void onError(FirebaseRemoteConfigException error) {
            Log.w(TAG, "Config update error with code: " + error.getCode(), error);
        }
    });
    
  2. Trong lần tiếp theo bạn phát hành phiên bản mới của Remote Config, các thiết bị đang chạy ứng dụng và theo dõi các thay đổi sẽ gọi ConfigUpdateListener.

Điều tiết

Nếu một ứng dụng tìm nạp quá nhiều lần trong một khoảng thời gian ngắn, thì các lệnh gọi tìm nạp sẽ bị điều tiết và SDK sẽ trả về FirebaseRemoteConfigFetchThrottledException. Trước SDK phiên bản 17.0.0, giới hạn là 5 yêu cầu tìm nạp trong 60 phút (các phiên bản mới hơn có nhiều giới hạn thoải mái hơn).

Trong quá trình phát triển ứng dụng, bạn nên tìm nạp và kích hoạt các cấu hình thường xuyên (nhiều lần mỗi giờ) để giúp bạn nhanh chóng lặp lại khi bạn phát triển và thử nghiệm ứng dụng của bạn. Các bản cập nhật theo thời gian thực của Remote Config sẽ tự động bỏ qua lưu vào bộ nhớ đệm khi cấu hình được cập nhật trên máy chủ. Để phù hợp với việc lặp lại nhanh cho một dự án có tối đa 10 nhà phát triển, bạn có thể tạm thời đặt một Đối tượng FirebaseRemoteConfigSettings có khoảng thời gian tìm nạp tối thiểu thấp (setMinimumFetchIntervalInSeconds) trong ứng dụng của bạn.

Khoảng thời gian tìm nạp tối thiểu mặc định cho Remote Config là 12 giờ, nghĩa là các cấu hình sẽ không được tìm nạp từ phần phụ trợ nhiều lần trong khoảng thời gian 12 giờ, bất kể số lượng lệnh gọi tìm nạp thực sự được thực hiện. Cụ thể, khoảng thời gian tìm nạp tối thiểu được xác định theo thứ tự sau:

  1. Tham số trong fetch(long)
  2. Tham số trong FirebaseRemoteConfigSettings.setMinimumFetchIntervalInSeconds(long)
  3. Giá trị mặc định của 12 giờ

Để đặt khoảng thời gian tìm nạp tối thiểu thành một giá trị tuỳ chỉnh, hãy sử dụng FirebaseRemoteConfigSettings.Builder.setMinimumFetchIntervalInSeconds(long).

Các bước tiếp theo

Hãy khám phá Remote Config trường hợp sử dụng và xem một số các khái niệm chính và tài liệu chiến lược nâng cao, bao gồm: