תחילת העבודה עם הגדרת תצורה מרחוק ב-Firebase


אפשר להשתמש ב-Firebase Remote Config כדי להגדיר פרמטרים באפליקציה ולעדכן את הערכים שלהם בענן, וכך לשנות את המראה וההתנהגות של האפליקציה בלי להפיץ עדכון לאפליקציה.

הספרייה Remote Config משמשת לאחסון ערכי ברירת מחדל של פרמטרים באפליקציה, לאחזור ערכי פרמטרים מעודכנים מקצה העורפי של Remote Config ולשליטה במועד שבו ערכים שאוחזרו יהיו זמינים לאפליקציה. למידע נוסף, ראו אסטרטגיות טעינה של Remote Config.

המדריך הזה ידריך אותך לבצע את השלבים לתחילת העבודה ומספקת קוד לדוגמה, שזמינות לשכפול או להורדה מאגר firebase/quickstart-unity ב-GitHub.

שלב 1: הוספה של Remote Config לאפליקציה

כדי להשתמש ב-Remote Config, צריך:

  • רושמים את הפרויקט ב-Unity ומגדירים אותו לשימוש ב-Firebase.

    • אם כבר משתמשים ב-Firebase בפרויקט שלכם ב-Unity, הוא כבר רשום ב-Firebase ועבר הגדרה.

    • אם אין לכם פרויקט ב-Unity, תוכלו להוריד אפליקציה לדוגמה.

  • מוסיפים את Firebase Unity SDK (במיוחד FirebaseRemoteConfig.unitypackage) לפרויקט ב-Unity.

חשוב לזכור שההוספה של Firebase לפרויקט Unity כוללת משימות, במסוף Firebase ובפרויקט Unity הפתוח (לדוגמה, אתם מורידים קובצי תצורה של Firebase מהמסוף, ואז מעבירים אותם בפרויקט ב-Unity).

שלב 2: מגדירים ערכי פרמטרים שמוגדרים כברירת מחדל באפליקציה

אפשר להגדיר ערכי ברירת מחדל של פרמטרים באפליקציה באובייקט Remote Config, כדי שהאפליקציה תפעל כמצופה לפני שהיא מתחברת לקצה העורפי של Remote Config, וכדי שערכי ברירת המחדל יהיו זמינים אם לא הוגדרו ערכי ברירת מחדל בקצה העורפי.

לשם כך, צריך ליצור מילון מחרוזות ולאכלס אותו בצמדי מפתח/ערך. שמייצגים את ברירות המחדל שרוצים להוסיף. אם כבר הגדרתם ערכים של פרמטרים לקצה העורפי של Remote Config, תוכלו להוריד קובץ שמכיל את זוגות המפתח/ערך האלה ולהשתמש בו כדי ליצור את מילון המחרוזות. למידע נוסף, ראו הורדת ברירת המחדל של התבנית Remote 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: מגדירים ערכי פרמטרים

  1. פותחים את הפרויקט במסוף Firebase.
  2. בוחרים באפשרות Remote Config מהתפריט כדי להציג את מרכז הבקרה של Remote Config.
  3. הגדרת פרמטרים עם שמות זהים לפרמטרים שהגדרתם באפליקציה שלך. לכל פרמטר אפשר להגדיר ערך ברירת מחדל (שהוא הם יבטלו בסופו של דבר את ערך ברירת המחדל בתוך האפליקציה) ואת הערכים המותנים. מידע נוסף זמין במאמר הבא: Remote Config פרמטרים ותנאים.

שלב 5: מאחזרים ומפעילים ערכים (לפי הצורך)

כדי לאחזר ערכי פרמטרים מהקצה העורפי 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().

בקוד לדוגמה שבהמשך, ה-method 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() מופעל. כך אפשר לוודא שהערכים החדשים לא יוחלו באמצע כל חישוב, או בזמנים אחרים שעלולים לגרום לבעיות או או התנהגות המשתמשים.

שלב 6: האזנה לעדכונים בזמן אמת

אחרי שמאחזרים ערכי פרמטרים, אפשר להשתמש בפונקציה Remote Config בזמן אמת כדי להאזין לעדכונים מהקצה העורפי של Remote Config. Remote Config מאותת למכשירים מחוברים בזמן אמת כשיש עדכונים זמינים, ומאחזר את השינויים באופן אוטומטי אחרי שמפרסמים גרסה חדשה של Remote Config.

עדכונים בזמן אמת נתמכים על ידי Firebase Unity SDK מגרסה 11.0.0 ואילך עבור בפלטפורמות Android ו-Apple.

  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, מכשירים שמפעילים את האפליקציה ומאזינים לשינויים, יקראו ל-handler של ההשלמה.

השלבים הבאים

אם עדיין לא עשיתם זאת, כדאי לעיין בRemote Configתרחישים לדוגמה ולקרוא את המסמכים בנושא מושגים מרכזיים ואסטרטגיות מתקדמות, כולל: