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ị đó trên đám mây, cho phép bạn chỉnh sửa hình thức và của ứng dụng mà không phân phối bản cập nhật ứng dụng.
Thư viện Cấu hình từ xa đượ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ập nhật từ phần phụ trợ Cấu hình từ xa và kiểm soát khi các giá trị được tìm nạp được cung cấp cho ứng dụng của bạn. Để tìm hiểu thêm, xem chiến lược tải Cấu hình từ xa.
Hướng dẫn này sẽ chỉ cho bạn thông qua các bước để bắt đầu và cung cấp một số mã mẫu, tất cả đều để sao chép hoặc tải xuống từ Kho lưu trữ GitHub firebase/quickstart-unity.
Bước 1: Thêm Cấu hình từ xa vào ứng dụng
Trước khi bạn có thể sử dụng Cấu hình từ xa, bạn cần:
Đăng ký dự án Unity của bạn và định cấu hình dự án đó để sử dụng Firebase.
Nếu dự án Unity của bạn đã sử dụng Firebase thì tức là dự án đã đã đăng ký và định cấu hình cho Firebase.
Nếu không có dự án Unity, bạn có thể tải ứng dụng mẫu.
Thêm Firebase Unity SDK (cụ thể là
FirebaseRemoteConfig.unitypackage) vào dự án Unity của bạn.
Lưu ý rằng việc thêm Firebase vào dự án Unity bao gồm cả các tác vụ trong Bảng điều khiển của Firebase và trong dự án Unity mở của bạn (ví dụ: bạn tải các tệp cấu hình Firebase xuống từ bảng điều khiển, rồi di chuyển vào dự án Unity).
Bước 2: Đặ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ợ.
Để thực hiện việc này, hãy tạo một từ điển chuỗi và điền các cặp khoá/giá trị vào từ điển đó thể hiện các giá trị mặc định mà bạn muốn thêm. Nếu bạn đã định cấu hình Các giá trị thông số phụ trợ Cấu hình từ xa, bạn có thể tải tệp xuống chứa các cặp khoá/giá trị này và sử dụng cặp khoá/giá trị này để tạo từ điển chuỗi của bạn. Để biết thêm thông tin, hãy xem Tải xuống Giá trị mặc định của mẫu Cấu hình từ xa.
(Các thuộc tính không theo chuỗi sẽ là
được chuyển đổi sang loại thuộc tính khi SetDefaultsAsync() được gọi).
System.Collections.Generic.Dictionary<string, object> defaults =
new System.Collections.Generic.Dictionary<string, object>();
// These are the values that are used if we haven't fetched data from the
// server
// yet, or if we ask for values that the server doesn't have:
defaults.Add("config_test_string", "default local string");
defaults.Add("config_test_int", 1);
defaults.Add("config_test_float", 1.0);
defaults.Add("config_test_bool", false);
Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.SetDefaultsAsync(defaults)
.ContinueWithOnMainThread(task => {
Bước 3: 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
trong phần phụ trợ Cấu hình từ xa, tìm nạp các giá trị đó rồi kích hoạt chúng,
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 thông số trong ứng dụng
các giá trị được định cấu hình bằng
SetDefaultsAsync().
Để nhận các giá trị này, hãy sử dụng GetValue(),
cung cấp khoá tham số làm đối số. Thao tác này sẽ trả về một
ConfigValue,
Hàm này có các thuộc tính để chuyển đổi giá trị thành nhiều loại cơ sở.
Bước 4: Đặt giá trị thông số
- 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 trang tổng quan 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 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 trong ứng dụng) và các giá trị có điều kiện. Để tìm hiểu thêm, hãy xem Thông số và điều kiện Cấu hình từ xa.
Bước 5: Tìm nạp và kích hoạt các giá trị (nếu cần)
Để 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
FetchAsync()
. Mọi giá trị mà bạn đặt trên phần phụ trợ đều được tìm nạp và
được lưu vào bộ nhớ đệm trong đối tượng Cấu hình từ xa.
// Start a fetch request.
// FetchAsync only fetches new data if the current data is older than the provided
// timespan. Otherwise it assumes the data is "recent enough", and does nothing.
// By default the timespan is 12 hours, and for production apps, this is a good
// number. For this example though, it's set to a timespan of zero, so that
// changes in the console will always show up immediately.
public Task FetchDataAsync() {
DebugLog("Fetching data...");
System.Threading.Tasks.Task fetchTask =
Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.FetchAsync(
TimeSpan.Zero);
return fetchTask.ContinueWithOnMainThread(FetchComplete);
}
Trong mã trên, FetchComplete là một phương thức có chữ ký khớp với
tham số của một trong
quá tải
trong tổng số ContinueWithOnMainThread().
Trong mã mẫu bên dưới, phương thức FetchComplete được truyền tác vụ trước đó
(fetchTask), cho phép FetchComplete xác định xem trang đã hoàn tất hay chưa.
Mã này sử dụng
Info.LastFetchStatus
để xác định xem liệu kết thúc có cũng thành công hay không. Nếu có,
Sau đó, các giá trị thông số Cấu hình từ xa được kích hoạt bằng ActivateAsync().
private void FetchComplete(Task fetchTask) {
if (!fetchTask.IsCompleted) {
Debug.LogError("Retrieval hasn't finished.");
return;
}
var remoteConfig = FirebaseRemoteConfig.DefaultInstance;
var info = remoteConfig.Info;
if(info.LastFetchStatus != LastFetchStatus.Success) {
Debug.LogError($"{nameof(FetchComplete)} was unsuccessful\n{nameof(info.LastFetchStatus)}: {info.LastFetchStatus}");
return;
}
// Fetch successful. Parameter values must be activated to use.
remoteConfig.ActivateAsync()
.ContinueWithOnMainThread(
task => {
Debug.Log($"Remote data loaded and ready for use. Last fetch time {info.FetchTime}.");
});
}
Các giá trị được tìm nạp bằng
FetchAsync()
được lưu vào bộ nhớ đệm cục bộ khi tìm nạp hoàn tất, nhưng không được cung cấp cho đến
ActivateAsync()
sẽ được gọi. Việc này giúp bạn đảm bảo rằng các giá trị mới sẽ không được áp dụng
trong khi tính toán hoặc vào những thời điểm khác có thể gây ra sự cố hoặc lạ
hành vi.
Bước 6: 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 .
Bản cập nhật theo thời gian thực được hỗ trợ bởi Firebase Unity SDK phiên bản 11.0.0 trở lên cho Nền tảng Android và Apple.
- Trong ứng dụng, hãy thêm một
OnConfigUpdateListenerđể bắt đầu nghe nội dung cập nhật và tự động tìm nạp mọi giá trị thông số mới hoặc đã cập nhật. Sau đó, hãy tạo mộtConfigUpdateListenerEventHandlerđể xử lý các sự kiện cập nhật. Nội dung sau đây ví dụ này theo dõi các nội dung cập nhật và sử dụng các giá trị mới tìm nạp được để hiển thị một tin nhắn chào mừng được cập nhật.
// Invoke the listener.
void Start()
{
Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.OnConfigUpdateListener
+= ConfigUpdateListenerEventHandler;
}
// Handle real-time Remote Config events.
void ConfigUpdateListenerEventHandler(
object sender, Firebase.RemoteConfig.ConfigUpdateEventArgs args) {
if (args.Error != Firebase.RemoteConfig.RemoteConfigError.None) {
Debug.Log(String.Format("Error occurred while listening: {0}", args.Error));
return;
}
Debug.Log("Updated keys: " + string.Join(", ", args.UpdatedKeys));
// Activate all fetched values and then display a welcome message.
remoteConfig.ActivateAsync().ContinueWithOnMainThread(
task => {
DisplayWelcomeMessage();
});
}
// Stop the listener.
void OnDestroy() {
Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.OnConfigUpdateListener
-= ConfigUpdateListenerEventHandler;
}
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, các thiết bị đang chạy ứng dụng và lắng nghe các thay đổi sẽ gọi trình xử lý hoàn thành.
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: