Bắt đầu sử dụng Remote Config trên Android

Chọn nền tảng: iOS+ Android Web Flutter Unity C++


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

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, Google Analytics là bắt buộc để nhắm mục tiêu các phiên bản ứng dụng đến thuộc tính người dùng và đối tượng một cách có điều kiện. Hãy nhớ bật Google Analytics trong dự án của bạn.

  3. 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 các phần phụ thuộc cho thư viện Remote ConfigAnalytics 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.

    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.

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

    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 tương ứng.

    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ý phiên bản thư viện nhằm đảm bảo 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:23.1.0")
    implementation("com.google.firebase:firebase-analytics:23.2.0")
    }

Bước 2: Nhận đối tượng singleton của 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

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ác giá trị tham số đã cập nhật từ phần phụ trợ và kiểm soát thời điểm cung cấp các giá trị đã tìm nạp cho ứng dụng.

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 các giá trị tham số mặc định trong ứng dụng trong đối tượng Remote Config để ứng dụng hoạt động như dự kiến trước khi kết nối với phần phụ trợ Remote Configvà để các giá trị mặc định có sẵn 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 tham số và giá trị tham số mặc định bằng cách sử dụng đối tượng Map hoặc 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 khởi động nhanh Remote Config sử dụng tệp XML để xác định tên và giá trị tham số mặc định.

    Nếu đã định cấu hình các giá trị tham số phụ trợ Remote Config, bạn có thể tải một tệp XML đã tạo xuống, trong đó có 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ạn có thể tạo mã thông báo người mang bằng cách chạy lệnh sau bằng Google Cloud CLI hoặc Cloud Shell:

    gcloud auth print-access-token
    

    Mã thông báo này chỉ tồn tại trong thời gian ngắn, vì vậy, bạn có thể cần tạo lại mã thông báo này nếu gặp lỗi xác thực.

    Bảng điều khiển của Firebase

    1. Trong bảng điều khiển của Firebase, hãy chuyển đến trang DevOps & Engagement > Remote Config > Parameters (DevOps và Tương tác > Cấu hình từ xa > Tham số).

    2. Mở Menu , rồi chọn Download default values.

    3. Khi được nhắc, hãy bật .xml for Android, sau đó nhấp vào Download file.

  2. Thêm các giá trị này vào đối tượng Remote Config bằng setDefaultsAsync(int), như minh hoạ dưới đây:

    Kotlin

    remoteConfig.setDefaultsAsync(R.xml.remote_config_defaults)

    Java

    mFirebaseRemoteConfig.setDefaultsAsync(R.xml.remote_config_defaults);

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

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

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

Bằng cách sử dụng bảng điều khiển Firebase hoặc Remote Config API phần phụ trợ, 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 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 của Firebase để tạo các giá trị này.

  1. Trong bảng điều khiển của Firebase, hãy chuyển đến trang DevOps & Engagement > Remote Config > Parameters (DevOps và Tương tác > Cấu hình từ xa > Tham số).

  2. 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. Đối với mỗi tham số, bạn có thể đặt giá trị mặc định (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 các giá trị có điều kiện. Để tìm hiểu thêm, hãy xem phần Remote Config Tham số và điều kiện.

  3. Nếu bạn sử dụng các điều kiện tín hiệu tuỳ chỉnh , hãy xác định các thuộc tính và giá trị của chúng. Các ví dụ sau đây cho thấy cách xác định điều kiện tín hiệu tuỳ chỉnh.

    Kotlin

            val customSignals = customSignals {
                put("city", "Tokyo")
                put("preferred_event_category", "sports")
            }
    
            remoteConfig.setCustomSignals(customSignals)
        

    Java

            CustomSignals customSignals = new CustomSignals.Builder()
                .put("city", "Tokyo")
                .put("preferred_event_category", "sports")
                .build();
    
            mFirebaseRemoteConfig.setCustomSignals(customSignals);
    
        

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

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

    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ợ của Remote Config và cung cấp các giá trị đó cho ứng dụng:

    Kotlin

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

Vì các giá trị tham số đã 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 vào thời điểm đảm bảo mang lại 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ở ứng dụng của bạn. Hãy xem phần 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 các bản 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 dõi các bản cập nhật từ phần phụ trợ của Remote Config. Theo thời gian thực Remote Config sẽ gửi tín hiệu đến các thiết bị được 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 bạn xuất bản phiên bản Remote Config mới.

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

  1. Trong ứng dụng, hãy sử dụng addOnConfigUpdateListener() để bắt đầu theo dõi các bản cập nhật và tự động tìm nạp mọi giá trị tham 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

    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. Vào lần tiếp theo bạn xuất bản phiên bản mới của Remote Config, các thiết bị đang chạy ứng dụng của bạn 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, các lệnh gọi tìm nạp sẽ bị điều tiết và SDK sẽ trả về FirebaseRemoteConfigFetchThrottledException. Trước phiên bản SDK 17.0.0, giới hạn là 5 yêu cầu tìm nạp trong khoảng thời gian 60 phút (các phiên bản mới hơn có giới hạn cho phép cao hơn).

Trong quá trình phát triển ứng dụng, bạn có thể muốn tìm nạp và kích hoạt các cấu hình rất thường xuyên (nhiều lần mỗi giờ) để có thể nhanh chóng lặp lại khi phát triển và kiểm thử ứng dụng. Các bản cập nhật Remote Config theo thời gian thực sẽ tự động bỏ qua bộ nhớ đệm khi cấu hình được cập nhật trên máy chủ. Để hỗ trợ việc lặp lại nhanh chóng trên một dự án có tối đa 10 nhà phát triển, bạn có thể tạm thời đặ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.

Khoảng thời gian tìm nạp tối thiểu mặc định cho Remote Config là 12 giờ, điều này có nghĩa là các cấu hình sẽ không được tìm nạp từ phần phụ trợ nhiều hơn một 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 tế đượ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 là 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).