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 giá trị của các thông số đó trên đám mây. Điều nà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ả các mã này đề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 của bạn
Thêm Firebase vào dự án Android của bạn nếu bạn chưa thực hiện.
Đố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.
Trong tệp Gradle mô-đun (cấp ứng dụng) (thường là
<project>/<app-module>/build.gradle.ktshoặ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:32.8.1")) // 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 Firebase.
(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 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 tương ứng.
Xin lưu ý rằng nếu sử dụng nhiều thư viện Firebase trong ứng dụng của mình, 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 mọi 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:21.6.3") implementation("com.google.firebase:firebase-analytics:21.6.2") }
Bước 2: Tải đối tượng singleton Cấu hình từ xa
Nhận 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ữ giá trị tham số mặc định trong ứng dụng, tìm nạp các giá trị thông 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, cũng như để có sẵn các giá trị mặc định nếu không có giá trị mặc định nào được đặt trong phần phụ trợ.
Xác định 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/xmlcủa ứng dụng. Ứng dụng mẫu bắt đầu nhanh Cấu hình từ xa sử dụng 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ủa Cấu hình từ xa, bạn có thể tải tệp XML đã tạo xuống. Tệp này có chứa tất cả giá trị mặc định và lưu tệp đó vào thư mục
res/xmlcủ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
Trong thẻ Parameters (Tham số), hãy mở Trình đơn rồi chọn Tải giá trị mặc định xuống.
Khi được nhắc, hãy bật .xml cho Android, sau đó nhấp vào Download file (Tải tệp xuống).
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ư minh hoạ:Kotlin+KTX
remoteConfig.setDefaultsAsync(R.xml.remote_config_defaults)
Java
mFirebaseRemoteConfig.setDefaultsAsync(R.xml.remote_config_defaults);
Bước 4: Lấy các giá trị tham số để dùng trong ứng dụng
Bây giờ, bạn có thể nhận giá trị thông số từ đối tượng Cấu hình từ xa. Nếu bạn đặt 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ó sẵn cho ứng dụng của bạn. Nếu không, bạn sẽ nhận được giá trị thông 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 liệt kê ở bên dưới. Phương thức này liên kết tới loại 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 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 mong muốn. Phần này mô tả các bước trong bảng điều khiển của Firebase để tạo những giá trị này.
- Trong bảng điều khiển của Firebase, hãy mở dự án của bạn.
- Chọn Cấu hình từ xa từ trình đơn để xem trang tổng quan Cấu hình từ xa.
- Hãy xác định tham số có tên giống với tham số 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 giá trị mặc định (giá trị này 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 Tham 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ị
- Để tìm nạp 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. Để cung cấp các giá trị tham số đã tìm nạp cho ứng dụng của bạn, hãy gọi phương thức
activate().Đối với trường hợp 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ị tham 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ở ứ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 giá trị tham 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 bản 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 báo hiệu cho 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 xuất bản một phiên bản Cấu hình từ xa mới.
SDK Firebase 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ợ tính năng cập nhật theo thời gian thực.
Trong ứng dụng của bạn, hãy dùng
addOnConfigUpdateListener()để bắt đầu theo dõi thông tin 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ạionUpdate()để 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); } }); Lần tiếp theo bạn phát hành phiên bản Cấu hình từ xa mới, các thiết bị đang chạy ứng dụng của bạn và đang 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 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ó 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ờ) để nhanh chóng lặp lại trong quá trình 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ủ. Để đáp ứng 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à các cấu hình sẽ chỉ được tìm nạp qua phần phụ trợ nhiều lần trong khoảng thời gian 12 giờ, bất kể số 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:
- 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 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ấu hình từ xa (nếu bạn chưa thực hiện), đồng thời 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: