Bắt đầu sử dụng Remote Config trên Unity

Chọn nền tảng: iOS+ Android Web Flutter Unity C++


Bạn có thể sử dụng Firebase Remote Config để xác định các tham số trong ứng dụng và cập nhật giá trị của các tham số đó trên đám mây. Nhờ đó, bạn có thể sửa đổi hình thức 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.

Thư viện Remote Config đượ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ợ của Remote Config và kiểm soát thời điểm cung cấp các giá trị đã tìm nạp cho ứng dụng. Để tìm hiểu thêm, hãy xem bài viết Chiến lược tải Remote Config.

Hướng dẫn này sẽ hướng dẫn bạn các bước để bắt đầu và cung cấp một số mã mẫu . Bạn có thể sao chép hoặc tải xuống tất cả mã mẫu này từ kho lưu trữ firebase/quickstart-unity trên GitHub.

Bước 1: Thêm Remote Config vào ứng dụng

Trước khi có thể sử dụng Remote Config, bạn cần:

  • Đăng ký dự án Unity 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ì dự án đó đã được đăng ký và định cấu hình cho Firebase.

    • Nếu không có dự án Unity, bạn có thể tải xuống ứng dụng mẫu.

  • Thêm SDK Firebase Unity (cụ thể là FirebaseRemoteConfig.unitypackage) vào dự án Unity.

Xin lưu ý rằng việc thêm Firebase vào dự án Unity bao gồm các tác vụ trong cả bảng điều khiển của Firebase và dự án Unity đang mở (ví dụ: bạn tải tệp cấu hình Firebase xuống từ bảng điều khiển, sau đó di chuyển các tệp đó vào dự án Unity).Firebase

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

Bạn có thể đặt giá trị tham số mặc định trong ứng dụng trong đối tượng Remote Config để ứng dụng hoạt động như dự kiến trước khi kết nối với phần phụ trợ của Remote Configvà để các giá trị mặc định có sẵn nếu không có giá trị nào được đặt 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 vào đó các cặp khoá-giá trị đại diện cho các giá trị mặc định mà bạn muốn thêm. Nếu đã định cấu hình Remote Config các giá trị tham số phần phụ trợ, bạn có thể tải một tệp chứa các cặp khoá-giá trị này xuống và sử dụng tệp đó để tạo từ điển chuỗi. Để biết thêm thông tin, hãy xem Tải Remote Config các giá trị mặc định của mẫu.

(Các thuộc tính không phải là chuỗi sẽ được chuyển đổi thành 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 giá trị tham số để sử dụng trong ứng dụng

Giờ đây, bạn có thể nhận giá trị tham số từ đối tượng Remote Config. Nếu bạn đặt giá trị trong phần phụ trợ Remote Config, tìm nạp các giá trị đó rồi kích hoạt, 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ị tham số trong ứng dụng đượ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, 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ị tham số

  1. Trong Firebase bảng điều khiển của Firebase, hãy mở dự án của bạn.
  2. Chọn Remote Config trong trình đơn để xem trang tổng quan Remote Config.
  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. Đối với mỗi tham số, bạn có thể đặt giá trị mặc định (giá trị này 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 Remote Config tham số và điều kiện.

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ị tham số từ phần phụ trợ của Remote Config, 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à lưu vào bộ nhớ đệm trong đối tượng Remote Config.

// 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ước đó, FetchComplete là một phương thức có chữ ký khớp với các tham số của một trong các phương thức nạp chồng của ContinueWithOnMainThread().

Trong mã mẫu sau đây, phương thức FetchComplete được truyền vào tác vụ trước đó (fetchTask), cho phép FetchComplete xác định xem tác vụ đó đã hoàn tất hay chưa. Sau đó, mã sẽ sử dụng Info.LastFetchStatus để xác định xem quá trình hoàn tất có cũng thành công hay không. Nếu có, Remote Config thì các giá trị tham số sẽ đượ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() sẽ được lưu vào bộ nhớ đệm cục bộ khi quá trình tìm nạp hoàn tất, nhưng sẽ không được cung cấp cho đến khi ActivateAsync() được gọi. Điều này cho phép bạn đảm bảo rằng các giá trị mới không được áp dụng trong quá trình tính toán hoặc vào những thời điểm khác có thể gây ra vấn đề hoặc hành vi bất thường.

Bước 6: Theo dõi các bản 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 Remote Config theo thời gian thực để theo dõi các bản cập nhật từ phần phụ trợ của Remote Config. Theo thời gian thực Remote Config 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 Remote Config phiên bản mới.

SDK Firebase Unity phiên bản 11.0.0 trở lên hỗ trợ các bản cập nhật theo thời gian thực cho nền tảng Android và Apple.

  1. Trong ứng dụng, hãy thêm OnConfigUpdateListener để 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 hoặc đã cập nhật. Sau đó, hãy tạo ConfigUpdateListenerEventHandler để xử lý các sự kiện cập nhật. Ví dụ sau đây theo dõi các bản cập nhật và sử dụng các giá trị mới tìm nạp để hiển thị thông điệp chào mừng đã 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 phiên bản Remote Config mới, 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 trình xử lý hoàn tất.