ก่อนเริ่มต้น
ก่อนที่จะใช้ Realtime Database ได้ คุณจะต้องทำสิ่งต่อไปนี้
ลงทะเบียนโปรเจ็กต์ Unity และกำหนดค่าให้ใช้ Firebase
หากโปรเจ็กต์ Unity ใช้ Firebase อยู่แล้ว แสดงว่าโปรเจ็กต์ได้รับการลงทะเบียนและกำหนดค่าสำหรับ Firebase แล้ว
หากไม่มีโปรเจ็กต์ Unity คุณก็ดาวน์โหลดแอปตัวอย่างได้
เพิ่ม Firebase Unity SDK (โดยเฉพาะ
FirebaseDatabase.unitypackage
) ลงในโปรเจ็กต์ Unity
โปรดทราบว่าการเพิ่ม Firebase ลงในโปรเจ็กต์ Unity จะเกี่ยวข้องกับงานทั้งในคอนโซล Firebase และในโปรเจ็กต์ Unity ที่เปิดอยู่ (เช่น เมื่อคุณดาวน์โหลดไฟล์การกำหนดค่า Firebase จากคอนโซล จากนั้นย้ายไฟล์เหล่านั้นไปยังโปรเจ็กต์ Unity)
กำลังบันทึกข้อมูล
การเขียนข้อมูลไปยังฐานข้อมูลเรียลไทม์ของ Firebase มี 5 วิธีดังนี้
วิธีการ | การใช้งานทั่วไป |
---|---|
SetValueAsync() |
เขียนหรือแทนที่ข้อมูลในเส้นทางที่กำหนด เช่น users/<user-id>/<username> |
SetRawJsonValueAsync() |
เขียนหรือแทนที่ข้อมูลด้วย Json แบบข้อมูลดิบ เช่น users/<user-id>/<username> |
Push() |
เพิ่มลงในรายการข้อมูล ทุกครั้งที่คุณเรียกใช้ Push() Firebase จะสร้างคีย์ที่ไม่ซ้ำกันซึ่งใช้เป็นตัวระบุที่ไม่ซ้ำกันได้ด้วย เช่น user-scores/<user-id>/<unique-score-id> |
UpdateChildrenAsync() |
อัปเดตคีย์บางรายการสำหรับเส้นทางที่กำหนดโดยไม่ต้องแทนที่ข้อมูลทั้งหมด |
RunTransaction() |
อัปเดตข้อมูลที่ซับซ้อนที่อาจเสียหายจากการอัปเดตพร้อมกัน |
รับ DatabaseReference
ในการเขียนข้อมูลไปยังฐานข้อมูล คุณต้องมีอินสแตนซ์ของ 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()
ในตัวเพื่อแปลงออบเจ็กต์เป็น 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()
เพื่อดูค่าของคีย์ที่สร้างขึ้นโดยอัตโนมัติหรือชุดข้อมูลย่อยของผู้เผยแพร่โฆษณาย่อยได้ การเรียกใช้ 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; } }
ในการสร้างลีดเดอร์บอร์ดEntryและอัปเดตไปเป็นฟีดคะแนนล่าสุดและรายการคะแนนของผู้ใช้เอง เกมจะใช้โค้ดดังนี้
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
จากนั้นจะใช้คีย์เพื่อสร้างรายการที่ 2 ในคะแนนของผู้ใช้ที่ /user-scores/$userid/$key
ได้
การใช้เส้นทางเหล่านี้จะช่วยให้คุณอัปเดตหลายตำแหน่งพร้อมกันในโครงสร้าง JSON ด้วยการเรียก UpdateChildrenAsync()
ครั้งเดียวได้ เช่น วิธีที่ตัวอย่างนี้สร้างรายการใหม่ในทั้ง 2 ตำแหน่ง การอัปเดตที่เกิดขึ้นพร้อมกันด้วยวิธีนี้มีผลอย่างมาก ไม่ว่าจะเป็นการอัปเดตสำเร็จหรือล้มเหลว
ลบข้อมูล
วิธีที่ง่ายที่สุดในการลบข้อมูลคือการเรียกใช้ 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 จะซิงค์ข้อมูลนั้นกับเซิร์ฟเวอร์ฐานข้อมูลระยะไกลและกับไคลเอ็นต์อื่นๆ อย่าง "ดีที่สุด"
ด้วยเหตุนี้ การเขียนทั้งหมดไปยังฐานข้อมูลจะทริกเกอร์เหตุการณ์ในเครื่องทันที ก่อนที่จะมีการเขียนข้อมูลไปยังเซิร์ฟเวอร์ ซึ่งหมายความว่าแอปจะยังคงตอบสนองอยู่เสมอไม่ว่าเครือข่ายจะใช้เวลาในการตอบสนองหรือการเชื่อมต่อเป็นอย่างไร
เมื่อมีการเชื่อมต่ออีกครั้ง แอปจะได้รับชุดเหตุการณ์ที่เหมาะสมเพื่อให้ไคลเอ็นต์ซิงค์กับสถานะเซิร์ฟเวอร์ปัจจุบันโดยไม่ต้องเขียนโค้ดที่กำหนดเองใดๆ