Bạn có thể sử dụng Cấu hình từ xa Firebase để xác định các tham số trong ứng dụng của mình và cập nhật giá trị của chúng trong đá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 hướng dẫn bạn qua 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 của bạn
Nếu bạn chưa có, hãy thêm Firebase vào dự án Android của bạn .
Đối với Cấu hình từ xa, cần có Google Analytics để nhắm mục tiêu có điều kiện các phiên bản ứng dụng tới đối tượng và thuộc tính người dùng. Đảm bảo rằng bạn bật Google Analytics trong dự án của mình.
Trong tệp Gradle mô-đun (cấp ứng dụng) của bạn (thường là
<project>/<app-module>/build.gradle), hãy thêm phần phụ thuộc cho thư viện Android Cấu hình từ xa. Chúng tôi khuyên bạn nên sử dụng Firebase Android BoM để kiểm soát việc lập 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 dành cho Google Analytics vào ứng dụng của mình.
Kotlin+KTX
dependencies { // Import the BoM for the Firebase platform implementation platform('com.google.firebase:firebase-bom:32.1.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-ktx' implementation 'com.google.firebase:firebase-analytics-ktx' }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 phụ thuộc thư viện Firebase mà không cần 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 của nó.
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ự khuyên bạn nên sử dụng BoM để quản lý các phiên bản thư viện, điều 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-ktx:21.4.0' implementation 'com.google.firebase:firebase-analytics-ktx:21.3.0' }Java
dependencies { // Import the BoM for the Firebase platform implementation platform('com.google.firebase:firebase-bom:32.1.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 các phiên bản tương thích của thư viện Android Firebase.
(Thay thế) Thêm phụ thuộc thư viện Firebase mà không cần 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 của nó.
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ự khuyên bạn nên sử dụng BoM để quản lý các phiên bản thư viện, điều 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:21.4.0' implementation 'com.google.firebase:firebase-analytics:21.3.0' }
Bước 2: Lấy đối tượng đơn cấu hình từ xa
Lấy một phiên bản đố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ị thông số mặc định trong ứng dụng, tìm nạp các giá trị thông số được cập nhật từ chương trình 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 Throttling để 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 các giá trị tham số mặc định trong ứng dụng trong đối tượng Cấu hình từ xa để ứ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ợ Cấu hình từ xa và để các giá trị mặc định khả dụng 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 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 của bạn. Ứng dụng mẫu khởi động nhanh Cấu hình từ xa sử dụng tệp XML để xác định tên và giá trị tham số mặc định.Nếu bạn đã đị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 xuống tệp XML được 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/xmlcủa ứng dụng:NGHỈ NGƠI
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ăn cứ hỏa lực
Trong tab Tham số , mở Menu và chọn Tải xuống các giá trị mặc định .
Khi được nhắc, hãy bật .xml cho Android , sau đó nhấp vào Tải xuống tệp .
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ư đượ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 các giá trị tham số để sử dụng trong ứng dụng của bạn
Bây giờ bạn có thể lấy các giá trị tham số từ đối tượng Cấu hình từ xa. Nếu bạn đặt các giá trị trong chương trình phụ trợ, hãy tìm nạp chúng rồi kích hoạt chúng, 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 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 ánh xạ tới loại dữ liệu mà ứng dụng của bạn mong đợi, cung cấp khóa tham số làm đối số:
Bước 5: Đặt giá trị tham số trong phụ trợ Cấu hình từ xa
Bằng cách sử dụng bảng điều khiển 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 phía máy chủ mới để ghi đè các giá trị trong ứng dụng theo logic điều kiện mong muốn của bạn hoặc nhắm mục tiêu người dùng. Phần này mô tả các bước của bảng điều khiển Firebase để tạo các giá trị này.
- Trong bảng điều khiển Firebase , hãy mở dự án của bạn.
- Chọn Cấu hình từ xa từ menu để xem bảng điều khiển Cấu hình từ xa.
- 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 thông số, bạn có thể đặt một giá trị mặc định (cuối cùng giá trị này sẽ ghi đè giá trị mặc định trong ứng dụng tương ứ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 Điều kiện và Tham số 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 các giá trị tham 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ị bạn đặt trong chương trình 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 những trường hợp bạn muốn tìm nạp và kích hoạt các giá trị trong một cuộc gọi, bạn có thể sử dụng yêu cầu
fetchAndActivate()để tìm nạp các giá trị từ phụ trợ Cấu hình từ xa và cung cấp chúng 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 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 nên kích hoạt các giá trị được 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 của bạn, chẳng hạn như lần tiếp theo khi người dùng mở ứng dụng của bạn. 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 cập nhật trong thời gian thực
Sau khi tìm nạp các giá trị tham số, bạn có thể sử dụng Cấu hình từ xa theo thời gian thực để lắng nghe 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ị đượ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 Cấu hình từ xa mới.
Cập nhật theo thời gian thực được hỗ trợ bởi SDK Firebase dành cho Android v21.3.0+ (Firebase BoM v31.2.4+).
Trong ứng dụng của bạn, 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 bất kỳ giá trị tham số mới nào. Triển khai 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 tới khi bạn xuất bản 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à lắng nghe các thay đổi sẽ gọi
ConfigUpdateListener.
tiết lưu
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, lệnh gọi tìm nạp sẽ được điều chỉnh 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 cho phép 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ờ) để cho phép bạn lặp lại nhanh chóng khi phát triển và thử nghiệm ứng dụng của mình. Cập nhật cấu hình từ xa theo thời gian thực tự động bỏ qua bộ đệm khi cấu hình được cập nhật trên máy chủ. Để hỗ trợ 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 với 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ờ, có nghĩa là các cấu hình sẽ không được tìm nạp từ chương trình phụ trợ nhiều lần trong khoảng thời gian 12 giờ, bất kể có bao nhiêu cuộc 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 giá trị tùy chỉnh, hãy sử dụng FirebaseRemoteConfigSettings.Builder.setMinimumFetchIntervalInSeconds(long) .
Bước tiếp theo
If you haven't already, explore the Remote Config use cases , and take a look at some of the key concepts and advanced strategies documentation, including: