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 của mình 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 của bạn mà không 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
Nếu bạn chưa làm như vậy, thêm Firebase vào dự án Android của bạn.
Đối với Cấu hình từ xa, bạn cần 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 với thuộc tính người dùng và đối tượ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) (thường là
<project>/<app-module>/build.gradle.ktshoặc<project>/<app-module>/build.gradle), 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 Bảng kê khai thành phần của Firebase cho Android để 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 bạn.
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.
(Phương án 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ụ thuộc.
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ự 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:22.0.0") implementation("com.google.firebase:firebase-analytics:22.0.2") }
Bước 2: Lấy đối tượng singleton Cấu hình từ xa
Tải một bản sao đối tượng Cấu hình từ xa và đặt giá trị 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ập nhật các giá trị tham số từ phần phụ trợ và kiểm soát thời điểm các giá trị được 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 giá trị 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 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 để có thể sử dụng các giá trị mặc định nếu không có giá trị nào thiết lập trong phần phụ trợ.
Xác định một tập hợp tên thông số và giá trị thông số mặc định bằng cách sử dụng Ánh xạ hoặc một đối tượng Tệp tài nguyên XML được lưu trữ trong thư mục
res/xmlcủa ứng dụng. Bắt đầu nhanh Cấu hình từ xa ứng dụng mẫu dùng một Tệp XML để xác định tên và giá trị thông số mặc định.Nếu bạn đã định cấu hình giá trị thông số phụ trợ Cấu hình từ xa, bạn có thể tải một tệp XML đã 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: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 ngăn Parameters (Tham số) tab, mở Trình đơn và chọn Tải xuống giá trị mặc định.
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 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ị 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ị đó
các giá trị đó có sẵn cho ứng dụng của bạn. Nếu không, bạn sẽ nhận được ứng dụng
các giá trị thông số đượ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ạ đến loại 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ị thông số trong phần phụ trợ Cấu hình từ xa
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 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.
- 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 trên trình đơn để xem Cấu hình từ xa bảng điều khiển.
- 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 bạn. Đối với mỗi thông số, bạn có thể đặt giá trị mặc định (giá trị này sẽ 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 Thông số Cấu hình từ xa và Điều kiện.
Bước 6: Tìm nạp và kích hoạt các giá trị
- Để 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(). Hệ thống sẽ tìm nạp mọi giá trị mà bạn đã thiết lập trong phần phụ trợ và được lưu trữ trong đối tượng Cấu hình từ xa. Để ứ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 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ấu hình từ xa và cung cấp các công cụ này 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(); } });
Bởi 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, 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ở . 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 thông tin cập nhật từ phần phụ trợ Cấu hình từ xa. Theo thời gian thực Cấu hình từ xa gửi tín hiệu đế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 xuất bản một Cấu hình từ xa mới .
SDK Firebase dành cho Android phiên bản 21.3.0 trở lên (Firebase BoM) hỗ trợ bản cập nhật theo thời gian thực phiên bản 31.2.4 trở lên).
Trong ứng dụng, hãy dùng
addOnConfigUpdateListener()để bắt đầu nghe thông tin cập nhật và tự động tìm nạp mọi giá trị thông số mới. Triển khaionUpdate()lệnh gọi lại để 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 một phiên bản mới của Cấu hình từ xa, thiết bị đang chạy ứng dụng của bạn và theo dõi các thay đổi sẽ gọi hàm
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 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
thường xuyên (nhiều lần mỗi giờ) để giúp bạn nhanh chóng lặp lại khi bạn phát triển và
thử nghiệm ứng dụng của bạn. Các bản cập nhật Cấu hình từ xa theo thời gian thực tự động bỏ qua
lưu vào 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
cho 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 bạn.
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ờ, tức là có nghĩa là hệ thống sẽ không tìm nạp cấu hình từ phần phụ trợ nhiều lần trong 12 giờ bất kể có bao nhiêu 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 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
Khám phá Cấu hình từ xa nếu bạn chưa thực hiện việc này trường hợp sử dụng và hãy xem một số các khái niệm chính và tài liệu chiến lược nâng cao, bao gồm: