คุณใช้การกำหนดค่าระยะไกลของ 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 v11.0.0 ขึ้นไปสำหรับแพลตฟอร์ม Android และ Apple รองรับการอัปเดตแบบเรียลไทม์
- เพิ่ม
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; }
ครั้งต่อไปที่คุณเผยแพร่การกำหนดค่าระยะไกลเวอร์ชันใหม่ อุปกรณ์ที่เรียกใช้แอปและฟังการเปลี่ยนแปลงจะเรียกใช้เครื่องจัดการเสร็จสมบูรณ์
ขั้นตอนถัดไป
หากยังไม่ทราบข้อมูล ให้ลองดูกรณีการใช้งานการกำหนดค่าระยะไกลและดูแนวคิดหลักบางส่วนและเอกสารกลยุทธ์ขั้นสูงซึ่งได้แก่