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

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

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

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

ขั้นตอนที่ 1: เพิ่ม Remote Config ลงในแอป

คุณต้องดำเนินการต่อไปนี้ก่อนจึงจะใช้ Remote Config ได้

• ลงทะเบียนโปรเจ็กต์ Unity และกำหนดค่าให้ใช้ Firebase

  • หากโปรเจ็กต์ Unity ใช้ Firebase อยู่แล้ว โปรเจ็กต์ดังกล่าวจะได้รับการลงทะเบียนและกําหนดค่าสําหรับ 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()

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

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

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

• จัดการเวอร์ชันเทมเพลต Remote Config
• กลยุทธ์การโหลดการกําหนดค่า