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, cho phép bạn 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ẽ 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 xuống tất cả mã này từ kho lưu trữ firebase/quickstart-android trên GitHub.

Bước 1: Thêm Firebase và SDK Remote Config vào ứng dụng

Nếu bạn chưa thực hiện, hãy thêm Firebase vào dự án Android.
Đố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. Nhớ bật Google Analytics trong dự án của bạn.
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 Config và Analytics 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 Firebase SDK cho Google Analytics vào ứng dụng.
```
dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:34.10.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.
(Phương án 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 của phiên bản đó.

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 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.0.1")
    implementation("com.google.firebase:firebase-analytics:23.0.0")
}
```

Bước 2: Tải đố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

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

Java

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

Đố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. 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 hoạt động như dự định trước khi kết nối với phần phụ trợ Remote Configvà để có sẵn các giá trị mặc định nếu không có giá trị nào được đặt trong phần phụ trợ.

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ần phụ trợ Remote Config, bạn có thể tải một tệp XML đã tạo xuống, bao gồm tất cả các giá trị mặc định và lưu 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 thẻ Tham số, hãy mở Trình đơn, rồi chọn Tải giá trị mặc định xuống.
2. Khi được nhắc, hãy bật .xml cho Android, sau đó nhấp vào Tải tệp xuống.

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

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

Bây giờ, 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ợ, tìm nạp các giá trị đó rồi kích hoạt, thì ứng dụng của bạn sẽ có các giá trị đó. 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 mã sau đây ánh xạ đến kiểu dữ liệu mà ứng dụng của bạn mong đợi, cung cấp khoá tham số làm đối số:

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

Bằng cách 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 nhắm mục tiêu đến 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.

Trong Firebase bảng điều khiển của Firebase, hãy mở dự án của bạn.
Chọn Remote Config trong trình đơn để xem trang tổng quan Remote Config.
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 (giá trị này 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 Remote Config Tham số và điều kiện.

Nếu sử dụng đ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 biết 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ị

Để tìm nạp giá trị tham số từ phần phụ trợ 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.

Để 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ợ 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, nên bạn cần kích hoạt các giá trị đã tìm nạp vào thời điểm đảm bảo trải nghiệm mượt mà cho người dùng, chẳng hạn như 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: Lắng nghe các bản cập nhật theo thời gian thực

Sau khi tìm nạp giá trị tham số, bạn có thể sử dụng Remote Config để lắng nghe các bản cập nhật từ phần phụ trợ Remote Config. Tín hiệu theo thời gian thực Remote Config đế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 bạn phát hành Remote Config phiên bản mới.

Các bản cập nhật theo thời gian thực được hỗ trợ bởi Firebase 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).

Trong ứng dụng, hãy sử dụng addOnConfigUpdateListener() để bắt đầu lắng nghe 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);
        }
    });

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 của bạn và lắng nghe 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 nhiều 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ấ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ủ. Để đáp ứng 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ờ, nghĩa là 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:

Tham số trong fetch(long)
Tham số trong FirebaseRemoteConfigSettings.setMinimumFetchIntervalInSeconds(long)
Giá trị mặc định là 12 giờ

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

Bắt đầu sử dụng Remote Config trên Android Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.

Bước 1: Thêm Firebase và SDK Remote Config vào ứng dụng

Bước 2: Tải đối tượng singleton Remote Config

Kotlin

Java

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

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

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

Kotlin

Java

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

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

Kotlin

Java

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

Kotlin

Java

Bước 7: Lắng nghe các bản cập nhật theo thời gian thực

Kotlin

Java

Điều tiết

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