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

iOS+ Android Web Flutter Unity C++

Lưu ý quan trọng: Phần này mô tả các bước định cấu hình Remote Config với ứng dụng di động và web. Đối với môi trường máy chủ, hãy xem phần Sử dụng Remote Config trong môi trường máy chủ.

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, 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 Remote Config dùng để lưu trữ các giá trị tham số mặc định trong ứng dụng, tìm nạp giá trị tham số đã cập nhật từ phần phụ trợ Remote Config 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. Để tìm hiểu thêm, hãy xem 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 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 chưa có dự án Unity, bạn có thể tải ứng dụng mẫu xuống.

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

Xem hướng dẫn chi tiết về các nhiệm vụ thiết lập ban đầu này trong phần Thêm Firebase vào dự án Unity.

Lưu ý rằng việc thêm Firebase vào dự án Unity bao gồm các thao tác trong cả bảng điều khiển Firebase và trong 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 chúng vào dự án Unity).

Bước 2: Đặt giá trị tham 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 ở đố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ợ Remote Config, và để các giá trị mặc định sẽ có sẵn nếu không có giá trị nào được đặt trong phần phụ trợ.

Lưu ý quan trọng: Không lưu trữ dữ liệu bí mật trong các khoá hoặc giá trị tham số Remote Config. Dữ liệu Remote Config được mã hoá trong quá trình truyền, nhưng người dùng cuối có thể truy cập vào bất kỳ tham số Remote Config mặc định hoặc được tìm nạp nào có sẵn cho thực thể ứng dụng khách của họ.

Để thực hiện việc này, hãy tạo một từ điển chuỗi và điền sẵn 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 vào từ điển đó. Nếu đã định cấu hình các giá trị tham số phụ trợ Remote Config, bạn có thể tải một tệp chứa các cặp khoá/giá trị này xuống và dùng tệp đó để tạo từ điển chuỗi của mình. Để biết thêm thông tin, hãy xem phần Tải các giá trị mặc định của mẫu Remote Config xuống.

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

Bây giờ, bạn có thể nhận các 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 rồi kích hoạt các giá trị đó, thì ứng dụng của bạn sẽ có các giá trị đó. 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().

Để lấy các giá trị này, hãy sử dụng GetValue(), cung cấp khoá thông 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ị thông số

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

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ị tham số từ phần phụ trợ 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ê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 tác vụ đó đã hoàn tất hay chưa. Mã này sử dụng Info.LastFetchStatus để xác định xem quá trình kết thúc có thành công hay không. Nếu có, các giá trị tham số Remote Config 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 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 mà có thể gây ra sự cố 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 các giá trị tham số, bạn có thể sử dụng Remote Config theo thời gian thực để nghe thông tin cập nhật từ phần phụ trợ Remote Config. Remote Config theo thời gian thực phát tín hiệu đến 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 phát hành phiên bản Remote Config mới.

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

Lưu ý quan trọng: Remote Config theo thời gian thực cũng yêu cầu API theo thời gian thực Firebase Remote Config. Bạn phải bật API này. Để xác minh, hãy mở bảng điều khiển Google Cloud, chọn dự án của bạn rồi mở trang API và dịch vụ. API sẽ xuất hiện ở trạng thái bật. Nếu API này bị thiếu hoặc chưa được bật, hãy nhấp vào Bật API và dịch vụ, tìm Firebase Remote Config Realtime API (API theo thời gian thực Firebase Remote Config) rồi bật API đó.

1. Trong ứng dụng, hãy thêm OnConfigUpdateListener để bắt đầu nghe 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 một ConfigUpdateListenerEventHandler để xử lý các sự kiện cập nhật. Ví dụ sau đây sẽ theo dõi thông tin cập nhật và sử dụng các giá trị mới tìm nạp để hiển thị 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;
}

Trong lần tới khi bạn phát hành phiên bản mới của Remote Config, các thiết bị đang chạy ứng dụng và theo dõi các thay đổi sẽ gọi trình xử lý hoàn tất.

Các bước tiếp theo

Nếu bạn chưa từng khám phá, hãy tìm hiểu các trường hợp sử dụng của Remote Config và xem một số khái niệm chính cũng như tài liệu về chiến lược nâng cao, bao gồm:

• Quản lý phiên bản mẫu Remote Config
• Chiến lược tải cấu hình