با Firebase Remote Config شروع کنید


شما می توانید از Firebase Remote Config برای تعریف پارامترها در برنامه خود و به روز رسانی مقادیر آنها در فضای ابری استفاده کنید و به شما امکان می دهد ظاهر و رفتار برنامه خود را بدون توزیع به روز رسانی برنامه تغییر دهید.

کتابخانه Remote Config برای ذخیره مقادیر پارامترهای پیش‌فرض درون برنامه، واکشی مقادیر پارامترهای به‌روزرسانی شده از باطن Remote Config و کنترل زمانی که مقادیر واکشی شده در دسترس برنامه شما قرار می‌گیرد، استفاده می‌شود. برای کسب اطلاعات بیشتر، به استراتژی‌های بارگیری پیکربندی از راه دور مراجعه کنید.

این راهنما شما را در مراحل شروع به کار راهنمایی می کند و نمونه کدی را ارائه می دهد که همگی برای شبیه سازی یا دانلود از مخزن firebase/quickstart-unity GitHub در دسترس هستند.

مرحله 1: Remote Config را به برنامه خود اضافه کنید

قبل از اینکه بتوانید از Remote Config استفاده کنید، باید:

  • پروژه Unity خود را ثبت کرده و آن را برای استفاده از Firebase پیکربندی کنید.

    • اگر پروژه Unity شما قبلاً از Firebase استفاده می‌کند، پس از قبل برای Firebase ثبت و پیکربندی شده است.

    • اگر پروژه یونیتی ندارید، می توانید یک برنامه نمونه دانلود کنید.

  • Firebase Unity SDK (به طور خاص، FirebaseRemoteConfig.unitypackage ) را به پروژه Unity خود اضافه کنید.

توجه داشته باشید که افزودن Firebase به پروژه Unity شما شامل وظایفی در کنسول Firebase و پروژه Unity باز شما می شود (به عنوان مثال، فایل های پیکربندی Firebase را از کنسول دانلود می کنید، سپس آنها را به پروژه Unity خود منتقل می کنید).

مرحله 2: مقادیر پارامترهای پیش فرض درون برنامه را تنظیم کنید

می‌توانید مقادیر پارامترهای پیش‌فرض درون برنامه‌ای را در شی Remote Config تنظیم کنید، به طوری که برنامه شما قبل از اتصال به پشتیبان Remote Config همانطور که می‌خواهید رفتار کند، و اگر مقادیر پیش‌فرض در backend تنظیم نشده باشد، در دسترس باشند.

برای انجام این کار، یک فرهنگ لغت رشته ایجاد کنید و آن را با جفت های کلید/مقدار پر کنید که نشان دهنده پیش فرض هایی است که می خواهید اضافه کنید. اگر قبلاً مقادیر پارامتر Backend Config از راه دور را پیکربندی کرده‌اید، می‌توانید فایلی را دانلود کنید که حاوی این جفت‌های کلید/مقدار است و از آن برای ساخت فرهنگ لغت رشته خود استفاده کنید. برای اطلاعات بیشتر، دانلود پیش‌فرض الگوی پیکربندی از راه دور را ببینید.

(هنگامی که SetDefaultsAsync() فراخوانی شود، ویژگی های غیر رشته ای به نوع خاصیت تبدیل می شوند).

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 => {

مرحله 3: مقادیر پارامتر را برای استفاده در برنامه خود دریافت کنید

اکنون می توانید مقادیر پارامتر را از شی Remote Config دریافت کنید. اگر مقادیری را در Remote Config تنظیم کنید، آنها را واکشی کرده و سپس فعال کنید، این مقادیر برای برنامه شما در دسترس هستند. در غیر این صورت، مقادیر پارامتر درون برنامه را با استفاده از SetDefaultsAsync() پیکربندی می‌کنید.

برای دریافت این مقادیر، از GetValue() استفاده کنید و کلید پارامتر را به عنوان آرگومان ارائه کنید. این یک ConfigValue را برمی‌گرداند که دارای ویژگی‌هایی برای تبدیل مقدار به انواع پایه مختلف است.

مرحله 4: برنامه خود را در کنسول Firebase وصل کنید

در کنسول Firebase ، برنامه خود را به پروژه Firebase خود اضافه کنید.

مرحله 5: مقادیر پارامتر را تنظیم کنید

  1. در کنسول Firebase ، پروژه خود را باز کنید.
  2. Remote Config را از منو انتخاب کنید تا داشبورد Remote Config را مشاهده کنید.
  3. پارامترهایی را با همان نام پارامترهایی که در برنامه خود تعریف کرده اید تعریف کنید. برای هر پارامتر، می توانید یک مقدار پیش فرض (که در نهایت مقدار پیش فرض درون برنامه را لغو می کند) و مقادیر شرطی تنظیم کنید. برای کسب اطلاعات بیشتر، به پارامترها و شرایط Remote Config مراجعه کنید.

مرحله 6: واکشی و فعال کردن مقادیر (در صورت نیاز)

برای واکشی مقادیر پارامتر از باطن Remote Config، متد FetchAsync() را فراخوانی کنید. هر مقداری که در باطن تنظیم می‌کنید در شی 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);
}

در کد بالا، FetchComplete متدی است که امضای آن با پارامترهای یکی از اضافه بارهای ContinueWithOnMainThread() مطابقت دارد.

در کد نمونه زیر، متد FetchComplete به وظیفه قبلی ( fetchTask ) منتقل می‌شود، که به FetchComplete اجازه می‌دهد تعیین کند که آیا تمام شده است یا خیر. کد از Info.LastFetchStatus استفاده می کند تا مشخص کند که آیا پایان نیز موفقیت آمیز بوده است یا خیر. در این صورت، مقادیر پارامتر Remote Config سپس با استفاده از 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}.");
    });
}

مقادیری که با استفاده از FetchAsync() واکشی می شوند، پس از تکمیل واکشی به صورت محلی ذخیره می شوند، اما تا زمانی که ActivateAsync() فراخوانی نشود، در دسترس قرار نمی گیرند. این به شما امکان می دهد اطمینان حاصل کنید که مقادیر جدید در اواسط محاسبه اعمال نمی شوند، یا در زمان های دیگر که ممکن است باعث ایجاد مشکلات یا رفتار عجیب شود.

مرحله ۷: به‌روزرسانی‌ها را در زمان واقعی گوش دهید

پس از واکشی مقادیر پارامتر، می‌توانید از Remote Config بی‌درنگ برای گوش دادن به به‌روزرسانی‌های Remote Config استفاده کنید. زمانی که به‌روزرسانی‌ها در دسترس هستند، پیکربندی از راه دور به دستگاه‌های متصل سیگنال می‌دهد و پس از انتشار نسخه پیکربندی از راه دور جدید، به‌طور خودکار تغییرات را واکشی می‌کند.

به‌روزرسانی‌های بی‌درنگ توسط Firebase Unity SDK نسخه 11.0.0 و بالاتر برای پلتفرم‌های اندروید و اپل پشتیبانی می‌شوند.

  1. در برنامه خود، یک OnConfigUpdateListener اضافه کنید تا شروع به شنیدن به‌روزرسانی‌ها کند و به‌طور خودکار مقادیر پارامترهای جدید یا به‌روزرسانی‌شده را واکشی کند. سپس، یک ConfigUpdateListenerEventHandler برای پردازش رویدادهای به روز رسانی ایجاد کنید. مثال زیر به‌روزرسانی‌ها را گوش می‌دهد و از مقادیر تازه واکشی شده برای نمایش یک پیام خوش‌آمدگویی به‌روز استفاده می‌کند.
// 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;
}

دفعه بعد که نسخه جدیدی از Remote Config خود را منتشر می کنید، دستگاه هایی که برنامه شما را اجرا می کنند و به تغییرات گوش می دهند با کنترل کننده تکمیل تماس می گیرند.

مراحل بعدی

اگر قبلاً این کار را نکرده اید ، موارد استفاده از راه دور از پیکربندی را کاوش کنید و به برخی از مفاهیم کلیدی و مستندات استراتژی های پیشرفته ، از جمله: