ก่อนที่คุณจะเริ่มต้น
ก่อนที่คุณจะสามารถใช้ Realtime Database ได้ คุณต้อง:
ลงทะเบียนโครงการ Unity ของคุณและกำหนดค่าเพื่อใช้ Firebase
หากโปรเจ็กต์ Unity ของคุณใช้ Firebase อยู่แล้ว แสดงว่ามีการลงทะเบียนและกำหนดค่าสำหรับ Firebase แล้ว
หากคุณไม่มีโครงการ Unity คุณสามารถดาวน์โหลด แอปตัวอย่างได้
เพิ่ม Firebase Unity SDK (โดยเฉพาะ
FirebaseDatabase.unitypackage
) ในโครงการ Unity ของคุณ
โปรดทราบว่าการเพิ่ม Firebase ในโครงการ Unity ของคุณเกี่ยวข้องกับงานทั้งใน คอนโซล Firebase และในโครงการ Unity แบบเปิดของคุณ (เช่น คุณดาวน์โหลดไฟล์การกำหนดค่า Firebase จากคอนโซล จากนั้นย้ายไฟล์เหล่านี้ไปยังโครงการ Unity ของคุณ)
การบันทึกข้อมูล
มีห้าวิธีในการเขียนข้อมูลไปยัง Firebase Realtime Database:
วิธี | การใช้งานทั่วไป |
---|---|
SetValueAsync() | เขียนหรือแทนที่ข้อมูลไปยังพาธที่กำหนด เช่น users/<user-id>/<username> |
SetRawJsonValueAsync() | เขียนหรือแทนที่ข้อมูลด้วย Json ดิบ เช่น users/<user-id>/<username> |
Push() | เพิ่มในรายการข้อมูล ทุกครั้งที่คุณเรียกใช้ Push() Firebase จะสร้างคีย์เฉพาะที่สามารถใช้เป็นตัวระบุเฉพาะได้ เช่น user-scores/<user-id>/<unique-score-id> |
UpdateChildrenAsync() | อัปเดตคีย์บางส่วนสำหรับเส้นทางที่กำหนดโดยไม่ต้องแทนที่ข้อมูลทั้งหมด |
RunTransaction() | อัปเดตข้อมูลที่ซับซ้อนซึ่งอาจเสียหายจากการอัปเดตพร้อมกัน |
รับข้อมูลอ้างอิงฐานข้อมูล
ในการเขียนข้อมูลไปยังฐานข้อมูล คุณต้องมีอินสแตนซ์ของ DatabaseReference
:
using Firebase; using Firebase.Database; public class MyScript: MonoBehaviour { void Start() { // Get the root reference location of the database. DatabaseReference reference = FirebaseDatabase.DefaultInstance.RootReference; } }
เขียน ปรับปรุง หรือลบข้อมูลที่อ้างอิง
การดำเนินการเขียนขั้นพื้นฐาน
สำหรับการดำเนินการเขียนขั้นพื้นฐาน คุณสามารถใช้ SetValueAsync()
เพื่อบันทึกข้อมูลไปยังการอ้างอิงที่ระบุ โดยแทนที่ข้อมูลที่มีอยู่ที่เส้นทางนั้น คุณสามารถใช้วิธีนี้เพื่อส่งประเภทที่สอดคล้องกับประเภท JSON ที่มีดังต่อไปนี้:
-
string
-
long
-
double
-
bool
-
Dictionary<string, Object>
-
List<Object>
หากคุณใช้วัตถุ C# ที่พิมพ์ คุณสามารถใช้ JsonUtility.ToJson()
ในตัวเพื่อแปลงวัตถุเป็น raw Json และเรียก SetRawJsonValueAsync()
ตัวอย่างเช่น คุณอาจมีคลาส User ที่มีลักษณะดังนี้:
public class User { public string username; public string email; public User() { } public User(string username, string email) { this.username = username; this.email = email; } }
คุณสามารถเพิ่มผู้ใช้ด้วย SetRawJsonValueAsync()
ดังนี้:
private void writeNewUser(string userId, string name, string email) { User user = new User(name, email); string json = JsonUtility.ToJson(user); mDatabaseRef.Child("users").Child(userId).SetRawJsonValueAsync(json); }
การใช้ SetValueAsync()
หรือ SetRawJsonValueAsync()
ด้วยวิธีนี้จะเขียนทับข้อมูลที่ตำแหน่งที่ระบุ รวมถึงโหนดย่อยใดๆ อย่างไรก็ตาม คุณยังสามารถอัปเดตรายการย่อยได้โดยไม่ต้องเขียนวัตถุใหม่ทั้งหมด หากคุณต้องการอนุญาตให้ผู้ใช้อัปเดตโปรไฟล์ คุณสามารถอัปเดตชื่อผู้ใช้ได้ดังนี้:
mDatabaseRef.Child("users").Child(userId).Child("username").SetValueAsync(name);
ผนวกเข้ากับรายการข้อมูล
ใช้เมธอด Push()
เพื่อผนวกข้อมูลเข้ากับรายการในแอปพลิเคชันที่มีผู้ใช้หลายคน เมธอด Push()
สร้างคีย์เฉพาะทุกครั้งที่มีการเพิ่มลูกใหม่ไปยังการอ้างอิง Firebase ที่ระบุ ด้วยการใช้คีย์ที่สร้างขึ้นโดยอัตโนมัติเหล่านี้สำหรับแต่ละองค์ประกอบใหม่ในรายการ ไคลเอนต์หลายตัวสามารถเพิ่มลูกไปยังตำแหน่งเดียวกันพร้อมกันได้โดยไม่มีข้อขัดแย้งในการเขียน คีย์เฉพาะที่สร้างโดย Push()
จะขึ้นอยู่กับการประทับเวลา ดังนั้นรายการจะถูกจัดเรียงตามลำดับเวลาโดยอัตโนมัติ
คุณสามารถใช้การอ้างอิงไปยังข้อมูลใหม่ที่ส่งกลับโดยเมธอด Push()
เพื่อรับค่าของคีย์ที่สร้างขึ้นโดยอัตโนมัติของเด็กหรือตั้งค่าข้อมูลสำหรับเด็ก Calling Key
บนการอ้างอิง Push()
ส่งคืนค่าของคีย์ที่สร้างขึ้นโดยอัตโนมัติ
อัปเดตฟิลด์เฉพาะ
เมื่อต้องการเขียนไปยังโหนดย่อยที่ระบุพร้อมกันโดยไม่ต้องเขียนทับโหนดย่อยอื่นๆ ให้ใช้เมธอด UpdateChildrenAsync()
เมื่อเรียก UpdateChildrenAsync()
คุณสามารถอัปเดตค่าลูกระดับล่างได้โดยระบุพาธสำหรับคีย์ หากข้อมูลถูกจัดเก็บไว้ในหลายตำแหน่งเพื่อให้ปรับขนาดได้ดีขึ้น คุณสามารถอัปเดต อินสแตนซ์ทั้งหมดของข้อมูลนั้นโดยใช้การกระจายข้อมูล ตัวอย่างเช่น เกมอาจมีคลาส LeaderboardEntry
ดังนี้:
public class LeaderboardEntry { public string uid; public int score = 0; public LeaderboardEntry() { } public LeaderboardEntry(string uid, int score) { this.uid = uid; this.score = score; } public Dictionary<string, Object> ToDictionary() { Dictionary<string, Object> result = new Dictionary<string, Object>(); result["uid"] = uid; result["score"] = score; return result; } }
ในการสร้าง LeaderboardEntry และอัปเดตเป็นฟีดคะแนนล่าสุดและรายการคะแนนของผู้ใช้พร้อมกัน เกมจะใช้โค้ดดังนี้:
private void WriteNewScore(string userId, int score) { // Create new entry at /user-scores/$userid/$scoreid and at // /leaderboard/$scoreid simultaneously string key = mDatabase.Child("scores").Push().Key; LeaderBoardEntry entry = new LeaderBoardEntry(userId, score); Dictionary<string, Object> entryValues = entry.ToDictionary(); Dictionary<string, Object> childUpdates = new Dictionary<string, Object>(); childUpdates["/scores/" + key] = entryValues; childUpdates["/user-scores/" + userId + "/" + key] = entryValues; mDatabase.UpdateChildrenAsync(childUpdates); }
ตัวอย่างนี้ใช้ Push()
เพื่อสร้างรายการในโหนดที่มีรายการสำหรับผู้ใช้ทั้งหมดที่ /scores/$key
และดึงคีย์พร้อมกันด้วย Key
คีย์สามารถใช้เพื่อสร้างรายการที่สองในคะแนนของผู้ใช้ที่ /user-scores/$userid/$key
เมื่อใช้เส้นทางเหล่านี้ คุณสามารถดำเนินการอัปเดตหลายตำแหน่งพร้อมกันในแผนผัง JSON ด้วยการเรียก UpdateChildrenAsync()
เพียงครั้งเดียว เช่น ตัวอย่างนี้สร้างรายการใหม่ในทั้งสองตำแหน่ง การอัปเดตพร้อมกันด้วยวิธีนี้ถือเป็นแบบปรมาณู: การอัปเดตทั้งหมดสำเร็จหรือการอัปเดตทั้งหมดล้มเหลว
ลบข้อมูล
วิธีที่ง่ายที่สุดในการลบข้อมูลคือการเรียกใช้ RemoveValue()
ในการอ้างอิงตำแหน่งของข้อมูลนั้น
คุณยังสามารถลบโดยระบุ null
เป็นค่าสำหรับการดำเนินการเขียนอื่น เช่น SetValueAsync()
หรือ UpdateChildrenAsync()
คุณสามารถใช้เทคนิคนี้กับ UpdateChildrenAsync()
เพื่อลบรายการย่อยหลายรายการในการเรียก API ครั้งเดียว
รู้ว่าข้อมูลของคุณถูกคอมมิตเมื่อใด
หากต้องการทราบเมื่อข้อมูลของคุณถูกส่งไปยังเซิร์ฟเวอร์ฐานข้อมูลเรียลไทม์ของ Firebase คุณสามารถเพิ่มการดำเนินการต่อได้ ทั้ง SetValueAsync()
และ UpdateChildrenAsync()
ส่งคืน Task
ที่ช่วยให้คุณทราบเมื่อการดำเนินการเสร็จสิ้น หากการโทรไม่สำเร็จไม่ว่าด้วยเหตุผลใดก็ตาม Tasks IsFaulted
จะเป็นจริงพร้อมกับคุณสมบัติ Exception
ที่ระบุว่าเหตุใดจึงเกิดความล้มเหลว
บันทึกข้อมูลเป็นธุรกรรม
เมื่อทำงานกับข้อมูลที่อาจเสียหายจากการแก้ไขพร้อมกัน เช่น ตัวนับส่วนเพิ่ม คุณสามารถใช้ การดำเนินการธุรกรรม ได้ คุณให้การดำเนินการนี้เป็น Func
การอัปเดตนี้ Func
ใช้สถานะปัจจุบันของข้อมูลเป็นอาร์กิวเมนต์และส่งคืนสถานะใหม่ที่คุณต้องการเขียน ถ้าไคลเอนต์อื่นเขียนไปยังตำแหน่งก่อนที่ค่าใหม่ของคุณจะเขียนสำเร็จ ฟังก์ชันการอัพเดทของคุณจะถูกเรียกอีกครั้งด้วยค่าปัจจุบันใหม่ และการเขียนจะถูกลองใหม่
ตัวอย่างเช่น ในเกม คุณสามารถอนุญาตให้ผู้ใช้อัปเดตลีดเดอร์บอร์ดที่มีคะแนนสูงสุด 5 อันดับ:
private void AddScoreToLeaders(string email, long score, DatabaseReference leaderBoardRef) { leaderBoardRef.RunTransaction(mutableData => { List<object> leaders = mutableData.Value as List<object> if (leaders == null) { leaders = new List<object>(); } else if (mutableData.ChildrenCount >= MaxScores) { long minScore = long.MaxValue; object minVal = null; foreach (var child in leaders) { if (!(child is Dictionary<string, object>)) continue; long childScore = (long) ((Dictionary<string, object>)child)["score"]; if (childScore < minScore) { minScore = childScore; minVal = child; } } if (minScore > score) { // The new score is lower than the existing 5 scores, abort. return TransactionResult.Abort(); } // Remove the lowest score. leaders.Remove(minVal); } // Add the new high score. Dictionary<string, object> newScoreMap = new Dictionary<string, object>(); newScoreMap["score"] = score; newScoreMap["email"] = email; leaders.Add(newScoreMap); mutableData.Value = leaders; return TransactionResult.Success(mutableData); }); }
การใช้ธุรกรรมช่วยป้องกันไม่ให้ลีดเดอร์บอร์ดไม่ถูกต้อง หากผู้ใช้หลายคนบันทึกคะแนนพร้อมกันหรือไคลเอนต์มีข้อมูลเก่า หากธุรกรรมถูกปฏิเสธ เซิร์ฟเวอร์จะส่งกลับค่าปัจจุบันไปยังไคลเอ็นต์ ซึ่งจะเรียกใช้ธุรกรรมอีกครั้งด้วยมูลค่าที่อัปเดต สิ่งนี้จะเกิดขึ้นซ้ำๆ จนกว่าการทำธุรกรรมจะได้รับการยอมรับหรือมีการพยายามหลายครั้งเกินไป
เขียนข้อมูลออฟไลน์
หากไคลเอนต์สูญเสียการเชื่อมต่อเครือข่าย แอปของคุณจะทำงานต่อไปอย่างถูกต้อง
ไคลเอนต์ทุกรายที่เชื่อมต่อกับฐานข้อมูล Firebase จะรักษาเวอร์ชันภายในของข้อมูลที่ใช้งานอยู่ เมื่อมีการเขียนข้อมูล จะเขียนลงในเวอร์ชันโลคัลนี้ก่อน จากนั้นไคลเอนต์ Firebase จะซิงโครไนซ์ข้อมูลนั้นกับเซิร์ฟเวอร์ฐานข้อมูลระยะไกลและกับไคลเอนต์อื่น ๆ บนพื้นฐาน "ความพยายามที่ดีที่สุด"
ด้วยเหตุนี้ การเขียนทั้งหมดไปยังฐานข้อมูลจะทริกเกอร์เหตุการณ์ในเครื่องทันที ก่อนที่ข้อมูลใดๆ จะถูกเขียนไปยังเซิร์ฟเวอร์ ซึ่งหมายความว่าแอปของคุณยังคงตอบสนองโดยไม่คำนึงถึงเวลาแฝงของเครือข่ายหรือการเชื่อมต่อ
เมื่อสร้างการเชื่อมต่อใหม่แล้ว แอปของคุณจะได้รับชุดเหตุการณ์ที่เหมาะสมเพื่อให้ไคลเอนต์ซิงค์กับสถานะเซิร์ฟเวอร์ปัจจุบัน โดยไม่ต้องเขียนโค้ดที่กำหนดเองใดๆ