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


Bạn có thể sử dụng Cấu hình từ xa Firebase để xác định các thông 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 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ẽ chỉ cho bạn các bước để bắt đầu và cung cấp một số mã mẫu, tất cả đều có sẵn để sao chép hoặc tải 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. Thêm Firebase vào dự án Android của bạn nếu bạn chưa thêm.

  2. Đối với Cấu hình từ xa, 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. Hãy nhớ bật Google Analytics trong dự án của bạn.

  3. Trong tệp Gradle (cấp ứng dụng) 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 Cấu hình từ xa 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 Firebase SDK 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.1.2"))
    
        // 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 các phiên bản tương thích của thư viện Android trên Firebase.

    (Thay thế) Thêm các 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 BoM của Firebase, bạn phải chỉ định từng phiên bản thư viện Firebase trong dòng phần phụ thuộc.

    Xin lưu ý rằng nếu sử dụng nhiều thư viện Firebase trong ứng dụng, thì bạn nên sử dụng BoM để quản lý các phiên bản thư viện, qua đó đả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:22.0.0")
        implementation("com.google.firebase:firebase-analytics:22.0.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, vui lòng 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 Cấu hình từ xa

Tải một thực thể đối tượng Cấu hình từ xa 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ác giá trị tham số đã cập nhật từ phần phụ trợ và kiểm soát thời điểm các giá trị đã 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. Xem phần Điều tiết để biết thêm thông tin.

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

Bạn có thể đặt giá trị thông số mặc định trong ứng dụng trong đối tượng Cấu hình từ xa để ứng dụng hoạt động như dự kiến trước khi kết nối với phần phụ trợ Cấu hình từ xa, và để 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ợ.

  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 (Bản đồ) 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 bắt đầu nhanh Cấu hình từ xa sử dụng một tệp XML để xác định tên và giá trị thông số mặc định.

    Nếu đã định cấu hình các giá trị tham số phụ trợ Cấu hình từ xa, bạn có thể tải tệp XML đã tạo xuống có chứa tất cả giá trị mặc định rồi 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ảng điều khiển của Firebase

    1. Trong thẻ Thông 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.

  2. Thêm các giá trị này vào đối tượng Cấu hình từ xa bằng cách sử dụng setDefaultsAsync(int) như sau:

    Kotlin+KTX

    remoteConfig.setDefaultsAsync(R.xml.remote_config_defaults)

    Java

    mFirebaseRemoteConfig.setDefaultsAsync(R.xml.remote_config_defaults);

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

Bây giờ, bạn có thể nhận các giá trị thông số từ đối tượng Cấu hình từ xa. 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ị đó, thì các giá trị đó sẽ được cung cấp cho ứng dụng của bạn. Nếu không, bạn sẽ nhận được các giá trị thông số trong ứng dụng được định cấu hình bằng cách sử dụng setDefaultsAsync(int). Để nhận các giá trị này, hãy gọi phương thức được liệt kê bên dưới. Phương thức này liên kết với kiểu dữ liệu mà ứng dụng của bạn dự kiến, cung cấp khoá tham số làm đối số:

Bước 5: Đặt giá trị thông số trong phần phụ trợ Cấu hình từ xa

Bằng cách sử dụng bảng điều khiển của Firebase hoặc API phụ trợ Cấu hình từ xa, bạn có thể tạo giá trị mặc định phía máy chủ mới 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 theo người dùng mà bạn muốn. Phần này mô tả các bước tạo những giá trị này trên bảng điều khiển của Firebase.

  1. Trong bảng điều khiển của Firebase, hãy mở dự án của bạn.
  2. Chọn Cấu hình từ xa trên trình đơn để xem trang tổng quan Cấu hình từ xa.
  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 mình. Đối với mỗi tham số, bạn có thể đặt một giá trị mặc định (sau cùng, 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 các giá trị có điều kiện. Để tìm hiểu thêm, hãy xem bài viết Thông số và điều kiện Cấu hình từ xa.

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ị thông số từ phần phụ trợ Cấu hình từ xa, 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 Cấu hình từ xa.
  2. Để ứng dụng của bạn có thể sử dụng các giá trị thông số đã tìm nạp, hãy gọi phương thức activate().

    Đối với các trường hợp mà 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ấu hình từ xa 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();
                }
            });

Vì các giá trị thông 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 cùng lúc để đảm bảo trải nghiệm suôn sẻ 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. Hãy 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: Nghe thông tin cập nhật theo thời gian thực

Sau khi tìm nạp các giá trị thông số, bạn có thể sử dụng Cấu hình từ xa theo thời gian thực để theo dõi các thông tin cập nhật từ phần phụ trợ Cấu hình từ xa. Cấu hình từ xa theo thời gian thực gửi tín hiệu đến 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 phiên bản Cấu hình từ xa mới.

Tính năng cập nhật theo thời gian thực được hỗ trợ bởi Firebase SDK 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 của bạn, 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+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() {
                @Override
                public void onComplete(@NonNull Task task) {
                    displayWelcomeMessage();
                }
            });
        }
    
        @Override
        public void onError(FirebaseRemoteConfigException error) {
            Log.w(TAG, "Config update error with code: " + error.getCode(), error);
        }
    });
    
  2. Lần tới khi bạn phát hành phiên bản mới của Cấu hình từ xa, 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, thì các lệnh gọi tìm nạp sẽ được điều tiết và SDK 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 khoảng thời gian 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 rất thường xuyên (nhiều lần mỗi giờ) để cho phép bạn lặp lại nhanh chóng khi phát triển và kiểm thử ứng dụng. Các bản cập nhật Cấu hình từ xa 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ủ. Để phù hợp với việc lặp lại nhanh 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 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 mình.

Khoảng thời gian tìm nạp tối thiểu mặc định cho Cấu hình từ xa là 12 giờ, nghĩa là hệ thống sẽ không tìm nạp các cấu hình qua phần phụ trợ nhiều lần trong khoảng thời gian 12 giờ, bất kể thực tế có bao nhiêu lệnh gọi tìm nạp. 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á các trường hợp sử dụng của Cấu hình từ xa (nếu bạn chưa làm vậy) và xem một số khái niệm chính và tài liệu về chiến lược nâng cao, bao gồm: