Bắt đầu sử dụng Cấu hình từ xa Firebase


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 các tham 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.

Thư viện Cấu hình từ xa được dùng để lưu trữ giá trị thông số mặc định trong ứng dụng, tìm nạp 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 thời điểm ứng dụng của bạn có thể tải các giá trị đã tìm nạp. Để tìm hiểu thêm, hãy xem phần Chiến lược tải Cấu hình từ xa.

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-unity.

Bước 1: Thêm Cấu hình từ xa vào ứng dụng

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

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

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

Xin lưu ý rằng việc thêm Firebase vào dự án Unity sẽ bao gồm cả các thao tác trong cả bảng điều khiển của Firebase và trong dự án Unity đang 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, sau đó di chuyển các tệp đó 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 đố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ợ.

Để thực hiện việc này, hãy tạo một từ điển chuỗi và điền vào đó bằng 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 các giá trị tham số phụ trợ Cấu hình từ xa, bạn có thể tải xuống một tệp chứa các cặp giá trị/khoá này và sử dụng tệp đó để tạo từ điển chuỗi của bạn. Để biết thêm thông tin, hãy xem phần 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 phải 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: 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ợ Cấu hình từ xa, tìm nạp rồi kích hoạt 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 cách sử dụ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ề ConfigValue, trong đó 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ố

  1. Trong bảng điều khiển của Firebase, hãy mở dự án của bạn.
  2. Chọn Cấu hình từ xa từ trình đơn để xem trang tổng quan Cấu hình từ xa.
  3. Hãy xác định các 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 (rốt cuộc sẽ ghi đè giá trị mặc định trong ứng dụng) và 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ủa 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 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à 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 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 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 đã hoàn tất hay chưa. Sau đó, mã này sẽ sử dụng Info.LastFetchStatus để xác định xem việc hoàn tất có thành công cũng hay không. Nếu có, giá trị thông số Cấu hình từ xa 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 giú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 lạ.

Bước 6: 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 Unity phiên bản 11.0.0 trở lên của Firebase hỗ trợ bản cập nhật theo thời gian thực cho các nền tảng Android và Apple.

  1. Trong ứng dụng của bạn, hãy thêm OnConfigUpdateListener để 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 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 thông tin cập nhật và sử dụng các giá trị mới tìm nạp được để cho thấy thông báo 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 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à theo dõi các thay đổi sẽ gọi trình xử lý hoàn thành.

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: