शुरू करने से पहले
Realtime Database का इस्तेमाल करने से पहले, आपको ये काम करने होंगे:
अपना Unity प्रोजेक्ट रजिस्टर करें और इसे Firebase का इस्तेमाल करने के लिए कॉन्फ़िगर करें.
अगर आपका Unity प्रोजेक्ट पहले से ही Firebase का इस्तेमाल करता है, तो इसका मतलब है कि वह Firebase के लिए पहले से ही रजिस्टर और कॉन्फ़िगर है.
अगर आपके पास Unity प्रोजेक्ट नहीं है, तो ऐप्लिकेशन का सैंपल डाउनलोड किया जा सकता है.
अपने Unity प्रोजेक्ट में Firebase Unity SDK टूल (खास तौर पर,
FirebaseDatabase.unitypackage
) जोड़ें.
ध्यान दें कि अपने Unity प्रोजेक्ट में Firebase जोड़ने के लिए, Firebase कंसोल और अपने खुले हुए Unity प्रोजेक्ट, दोनों में टास्क शामिल होते हैं. उदाहरण के लिए, कंसोल से Firebase कॉन्फ़िगरेशन फ़ाइलें डाउनलोड करके, उन्हें अपने Unity प्रोजेक्ट में ले जाना.
डेटा सेव करना
Firebase Realtime Database में डेटा लिखने के पांच तरीके हैं:
तरीका | सामान्य तौर पर क्वेरी की सूची का इस्तेमाल इस तरह किया जाता है |
---|---|
SetValueAsync() |
किसी तय पाथ, जैसे कि
users/<user-id>/<username> में डेटा लिखें या बदलें. |
SetRawJsonValueAsync() |
डेटा को रॉ Json से बदलें या रॉ 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# ऑब्जेक्ट का इस्तेमाल किया जाता है, तो ऑब्जेक्ट को रॉ JSON में बदलने और SetRawJsonValueAsync()
को कॉल करने के लिए, पहले से मौजूद JsonUtility.ToJson()
का इस्तेमाल किया जा सकता है.
उदाहरण के लिए, आपके पास 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()
तरीके से मिले नए डेटा के रेफ़रंस का इस्तेमाल करके, चाइल्ड की अपने-आप जनरेट हुई कुंजी की वैल्यू पाई जा सकती है या चाइल्ड के लिए डेटा सेट किया जा सकता है. Push()
रेफ़रंस पर Key
को कॉल करने से, अपने-आप जनरेट हुई कुंजी की वैल्यू दिखती है.
चुनिंदा फ़ील्ड अपडेट करना
अन्य चाइल्ड नोड को ओवरराइट किए बिना, किसी नोड के खास चिल्ड्रेन को एक साथ लिखने के लिए, 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
पर उपयोगकर्ता के स्कोर में दूसरी एंट्री बनाई जा सकती है.
इन पाथ का इस्तेमाल करके, UpdateChildrenAsync()
को एक बार कॉल करके, JSON ट्री में एक साथ कई जगहों को अपडेट किया जा सकता है. उदाहरण के लिए, यह उदाहरण दोनों जगहों पर नई एंट्री कैसे बनाता है. एक साथ किए गए अपडेट, ऐटॉमिक होते हैं: या तो सभी अपडेट पूरे हो जाते हैं या सभी अपडेट पूरे नहीं हो पाते.
डेटा मिटाना
डेटा मिटाने का सबसे आसान तरीका यह है कि उस डेटा की जगह के रेफ़रंस पर RemoveValue()
को कॉल किया जाए.
वैल्यू के तौर पर null
को तय करके भी मिटाया जा सकता है.
जैसे, SetValueAsync()
या UpdateChildrenAsync()
. एक ही एपीआई कॉल में कई बच्चों की जानकारी मिटाने के लिए, UpdateChildrenAsync()
के साथ इस तकनीक का इस्तेमाल किया जा सकता है.
जानें कि आपका डेटा कब कमिट किया गया.
यह जानने के लिए कि आपका डेटा Firebase Realtime Database सर्वर पर कब भेजा गया, आपके पास जारी रखने का विकल्प है. SetValueAsync()
और UpdateChildrenAsync()
, दोनों एक Task
दिखाते हैं. इससे आपको यह पता चलता है कि कार्रवाई पूरी हो गई है या नहीं. अगर किसी वजह से कॉल पूरा नहीं हो पाता है, तो Tasks IsFaulted
की वैल्यू 'सही' होगी. साथ ही, Exception
प्रॉपर्टी से यह पता चलेगा कि कॉल पूरा न होने की वजह क्या है.
डेटा को लेन-देन के तौर पर सेव करना
इंक्रीमेंटल काउंटर जैसे बदलावों की वजह से खराब हो सकने वाले डेटा के साथ काम करते समय, ट्रांज़ैक्शन ऑपरेशन का इस्तेमाल किया जा सकता है.
इस ऑपरेशन को Func
दिया जाता है. यह अपडेट Func
, डेटा की मौजूदा स्थिति को आर्ग्युमेंट के तौर पर लेता है और वह नई स्थिति दिखाता है जिसे आपको लिखना है. अगर आपकी नई वैल्यू को स्टोर करने से पहले कोई दूसरा क्लाइंट उस जगह पर डेटा लिखता है, तो अपडेट फ़ंक्शन को नई मौजूदा वैल्यू के साथ फिर से कॉल किया जाता है और डेटा को स्टोर करने की कोशिश फिर से की जाती है.
उदाहरण के लिए, किसी गेम में उपयोगकर्ताओं को सबसे ज़्यादा पांच स्कोर के साथ लीडरबोर्ड अपडेट करने की अनुमति दी जा सकती है:
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 क्लाइंट उस डेटा को रिमोट डेटाबेस सर्वर और अन्य क्लाइंट के साथ "बेहतर तरीके से" सिंक करता है.
इस वजह से, डेटाबेस में किए गए सभी बदलाव, सर्वर में किसी भी डेटा को लिखने से पहले, तुरंत लोकल इवेंट को ट्रिगर करते हैं. इसका मतलब है कि नेटवर्क के इंतज़ार या कनेक्टिविटी के बावजूद, आपका ऐप्लिकेशन काम करता रहेगा.
कनेक्शन फिर से चालू होने के बाद, आपके ऐप्लिकेशन को इवेंट का सही सेट मिलता है, ताकि क्लाइंट को कोई कस्टम कोड लिखे बिना, सर्वर की मौजूदा स्थिति के साथ सिंक किया जा सके.