เริ่มต้นการกำหนดค่าระยะไกลของ Firebase

คุณใช้การกำหนดค่าระยะไกลของ Firebase เพื่อกำหนดพารามิเตอร์ในแอปและอัปเดตค่าในระบบคลาวด์ได้ ซึ่งช่วยให้แก้ไขรูปลักษณ์และลักษณะการทำงานของแอปได้โดยไม่ต้องกระจายการอัปเดตแอป

ไลบรารีการกำหนดค่าระยะไกลใช้เพื่อจัดเก็บค่าพารามิเตอร์เริ่มต้นในแอป ดึงข้อมูลค่าพารามิเตอร์ที่อัปเดตแล้วจากแบ็กเอนด์การกำหนดค่าระยะไกล และควบคุมเวลาที่แอปสามารถใช้ค่าที่ดึงมาได้ ดูข้อมูลเพิ่มเติมได้ที่กลยุทธ์การโหลดการกำหนดค่าระยะไกล

คู่มือนี้จะแนะนำขั้นตอนในการเริ่มต้นใช้งานและให้โค้ดตัวอย่าง ซึ่งทั้งหมดนี้จะโคลนหรือดาวน์โหลดจากที่เก็บ GitHub firebase/quickstart-unity

ขั้นตอนที่ 1: เพิ่มการกำหนดค่าระยะไกลลงในแอป

ก่อนที่จะใช้การกำหนดค่าระยะไกล คุณต้องทำดังนี้

ลงทะเบียนโปรเจ็กต์ Unity และกำหนดค่าให้ใช้ Firebase
- หากโปรเจ็กต์ Unity ของคุณใช้ Firebase อยู่แล้ว แสดงว่ามีการลงทะเบียนและกำหนดค่าสำหรับ Firebase แล้ว
- หากไม่มีโปรเจ็กต์ Unity คุณดาวน์โหลดแอปตัวอย่างได้
เพิ่ม Firebase Unity SDK (โดยเฉพาะ FirebaseRemoteConfig.unitypackage) ลงในโปรเจ็กต์ Unity

โปรดทราบว่าการเพิ่ม Firebase ลงในโปรเจ็กต์ Unity จะเกี่ยวข้องกับงานทั้งในคอนโซล Firebase และในโปรเจ็กต์ Unity ที่เปิดอยู่ (เช่น คุณดาวน์โหลดไฟล์การกำหนดค่า Firebase จากคอนโซล แล้วย้ายไฟล์เหล่านั้นไปยังโปรเจ็กต์ Unity)

ขั้นตอนที่ 2: ตั้งค่าค่าพารามิเตอร์เริ่มต้นในแอป

คุณจะตั้งค่าค่าพารามิเตอร์เริ่มต้นในแอปได้ในออบเจ็กต์การกำหนดค่าระยะไกล เพื่อให้แอปทำงานตามที่ต้องการก่อนเชื่อมต่อกับแบ็กเอนด์ของการกำหนดค่าระยะไกล และเพื่อให้ค่าเริ่มต้นพร้อมใช้งานหากไม่มีการตั้งค่าใดๆ ในแบ็กเอนด์

วิธีการคือ ให้สร้างพจนานุกรมสตริงและป้อนข้อมูลด้วยคู่คีย์/ค่าที่แสดงถึงค่าเริ่มต้นที่คุณต้องการเพิ่ม หากกำหนดค่าพารามิเตอร์แบ็กเอนด์ของการกำหนดค่าระยะไกลไว้แล้ว คุณจะดาวน์โหลดไฟล์ที่มีคู่คีย์/ค่าเหล่านี้และใช้เพื่อสร้างพจนานุกรมสตริงได้ โปรดดูข้อมูลเพิ่มเติมที่หัวข้อดาวน์โหลดค่าเริ่มต้นของเทมเพลตการกำหนดค่าระยะไกล

(พร็อพเพอร์ตี้ที่ไม่ใช่สตริงจะแปลงเป็นประเภทของพร็อพเพอร์ตี้เมื่อมีการเรียกใช้ 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: รับค่าพารามิเตอร์ไว้ใช้ในแอป

ตอนนี้คุณสามารถรับค่าพารามิเตอร์จากออบเจ็กต์การกำหนดค่าระยะไกล หากคุณกำหนดค่าในแบ็กเอนด์ของการกำหนดค่าระยะไกล ดึงข้อมูลค่า จากนั้นเปิดใช้งาน ค่าเหล่านั้นจะพร้อมใช้งานในแอป ไม่เช่นนั้นคุณจะได้รับค่าพารามิเตอร์ในแอปที่กำหนดค่าโดยใช้ SetDefaultsAsync()

หากต้องการรับค่าเหล่านี้ ให้ใช้ GetValue() ที่ระบุคีย์พารามิเตอร์เป็นอาร์กิวเมนต์ ซึ่งจะแสดงผล ConfigValue ซึ่งมีพร็อพเพอร์ตี้สำหรับแปลงค่าเป็นฐานประเภทต่างๆ

ขั้นตอนที่ 4: ตั้งค่าค่าพารามิเตอร์

เปิดโปรเจ็กต์ในคอนโซล Firebase
เลือกการกำหนดค่าระยะไกลจากเมนูเพื่อดูแดชบอร์ดการกำหนดค่าระยะไกล
กำหนดพารามิเตอร์ที่มีชื่อเดียวกันกับพารามิเตอร์ที่กำหนดในแอป โดยคุณจะกำหนดค่าเริ่มต้น (ซึ่งสุดท้ายแล้วจะลบล้างค่าเริ่มต้นในแอป) และค่าแบบมีเงื่อนไขได้สำหรับพารามิเตอร์แต่ละรายการ โปรดดูข้อมูลเพิ่มเติมที่หัวข้อพารามิเตอร์และเงื่อนไขการกำหนดค่าระยะไกล

ขั้นตอนที่ 5: ดึงข้อมูลและเปิดใช้งานค่า (ตามความจำเป็น)

หากต้องการดึงค่าพารามิเตอร์จากแบ็กเอนด์การกำหนดค่าระยะไกล ให้เรียกใช้เมธอด FetchAsync() ระบบจะดึงค่าที่คุณกำหนดในแบ็กเอนด์และแคชไว้ในออบเจ็กต์การกำหนดค่าระยะไกล

// 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 เพื่อระบุว่าการเสร็จสิ้นสำเร็จหรือไม่ ในกรณีนี้ ระบบจะเปิดใช้งานค่าพารามิเตอร์การกำหนดค่าระยะไกลโดยใช้ 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: ฟังอัปเดตแบบเรียลไทม์

หลังจากดึงข้อมูลค่าพารามิเตอร์แล้ว คุณจะใช้การกำหนดค่าระยะไกลแบบเรียลไทม์เพื่อฟังการอัปเดตจากแบ็กเอนด์การกำหนดค่าระยะไกลได้ แบบเรียลไทม์ ส่งสัญญาณการกำหนดค่าระยะไกลไปยังอุปกรณ์ที่เชื่อมต่อเมื่อมีอัปเดตพร้อมใช้งานและ จะดึงข้อมูลการเปลี่ยนแปลงโดยอัตโนมัติหลังจากเผยแพร่การกำหนดค่าระยะไกลเวอร์ชันใหม่

Firebase Unity SDK เวอร์ชัน 11.0.0 ขึ้นไปรองรับการอัปเดตแบบเรียลไทม์ สำหรับแพลตฟอร์ม Android และ Apple

สำคัญ: การกำหนดค่าระยะไกลแบบเรียลไทม์จำเป็นต้องใช้ Realtime API ของการกำหนดค่าระยะไกลของ Firebase ด้วย ซึ่งควรเปิดใช้ไว้สำหรับคุณอยู่แล้ว หากต้องการยืนยัน ให้เปิดคอนโซล Google Cloud เลือกโปรเจ็กต์ แล้วเปิดหน้า API และบริการ API ควรปรากฏเป็นเปิดใช้ หากไม่มีหรือไม่ได้เปิดใช้ ให้คลิก เปิดใช้ API และบริการ ค้นหา API เรียลไทม์ของการกำหนดค่าระยะไกลของ Firebase แล้วเปิดใช้

เพิ่ม 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;
}

ครั้งต่อไปที่คุณเผยแพร่การกำหนดค่าระยะไกลเวอร์ชันใหม่ อุปกรณ์ที่เรียกใช้แอปของคุณและรอฟังการเปลี่ยนแปลงจะเรียกตัวแฮนเดิลการทำงานที่สมบูรณ์

ขั้นตอนถัดไป

ลองสำรวจกรณีการใช้งานการกำหนดค่าระยะไกลและดูเอกสารแนวคิดสำคัญและเอกสารกลยุทธ์ขั้นสูงต่อไปนี้หากยังไม่ได้ดู