Android पर डेटा की सूचियों के साथ काम करें

इस दस्तावेज़ में Firebase में डेटा की सूचियों के साथ काम करना शामिल है। फायरबेस डेटा पढ़ने और लिखने की मूल बातें जानने के लिए Android पर डेटा पढ़ें और लिखें देखें।

डेटाबेस संदर्भ प्राप्त करें

डेटाबेस से डेटा पढ़ने और लिखने के लिए, आपको DatabaseReference का एक उदाहरण चाहिए:

private lateinit var database: DatabaseReference
// ...
database = Firebase.database.reference
ReadAndWriteSnippets.kt

private DatabaseReference mDatabase;
// ...
mDatabase = FirebaseDatabase.getInstance().getReference();
ReadAndWriteSnippets.java

सूचियाँ पढ़ें और लिखें

डेटा की सूची में संलग्न करें

बहुउपयोगकर्ता अनुप्रयोगों में सूची में डेटा जोड़ने के लिए push() विधि का उपयोग करें। push() विधि निर्दिष्ट फायरबेस संदर्भ में एक नया बच्चा जोड़े जाने पर हर बार एक अनूठी कुंजी उत्पन्न करती है। सूची में प्रत्येक नए तत्व के लिए इन ऑटो-जेनरेट की गई कुंजियों का उपयोग करके, कई ग्राहक एक ही स्थान पर एक ही समय में बिना किसी विरोध के बच्चों को जोड़ सकते हैं। push() द्वारा उत्पन्न अद्वितीय कुंजी टाइमस्टैम्प पर आधारित होती है, इसलिए सूची आइटम स्वचालित रूप से कालानुक्रमिक रूप से क्रमबद्ध होते हैं।

आप push() विधि द्वारा लौटाए गए नए डेटा के संदर्भ का उपयोग बच्चे की ऑटो-जेनरेट की गई कुंजी या बच्चे के लिए सेट डेटा प्राप्त करने के लिए कर सकते हैं। push() संदर्भ पर getKey() कॉल करना ऑटो-जेनरेट की गई कुंजी का मान देता है।

आप अपनी डेटा संरचना को सरल बनाने के लिए इन ऑटो-जेनरेट की गई कुंजियों का उपयोग कर सकते हैं। अधिक जानकारी के लिए, डेटा फैन-आउट उदाहरण देखें।

बाल घटनाओं के लिए सुनो

सूचियों के साथ काम करते समय, आपके एप्लिकेशन को एकल वस्तुओं के लिए उपयोग की जाने वाली मूल्य घटनाओं के बजाय बाल घटनाओं को सुनना चाहिए।

बाल घटनाओं को विशिष्ट संचालन के जवाब में ट्रिगर किया जाता है जो किसी ऑपरेशन से नोड के बच्चों के लिए होता है जैसे कि push() विधि के माध्यम से जोड़ा गया एक नया बच्चा या updateChildren() विधि के माध्यम से अद्यतन किया जा रहा बच्चा। इनमें से प्रत्येक एक साथ डेटाबेस में किसी विशिष्ट नोड में परिवर्तनों को सुनने के लिए उपयोगी हो सकता है।

DatabaseReference पर बाल घटनाओं को सुनने के लिए, एक ChildEventListener संलग्न करें:

उदाहरण के लिए, एक सामाजिक ब्लॉगिंग ऐप किसी पोस्ट की टिप्पणियों में गतिविधि पर नज़र रखने के लिए इन विधियों का एक साथ उपयोग कर सकता है, जैसा कि नीचे दिखाया गया है:

val childEventListener = object : ChildEventListener {
    override fun onChildAdded(dataSnapshot: DataSnapshot, previousChildName: String?) {
        Log.d(TAG, "onChildAdded:" + dataSnapshot.key!!)

        // A new comment has been added, add it to the displayed list
        val comment = dataSnapshot.getValue<Comment>()

        // ...
    }

    override fun onChildChanged(dataSnapshot: DataSnapshot, previousChildName: String?) {
        Log.d(TAG, "onChildChanged: ${dataSnapshot.key}")

        // A comment has changed, use the key to determine if we are displaying this
        // comment and if so displayed the changed comment.
        val newComment = dataSnapshot.getValue<Comment>()
        val commentKey = dataSnapshot.key

        // ...
    }

    override fun onChildRemoved(dataSnapshot: DataSnapshot) {
        Log.d(TAG, "onChildRemoved:" + dataSnapshot.key!!)

        // A comment has changed, use the key to determine if we are displaying this
        // comment and if so remove it.
        val commentKey = dataSnapshot.key

        // ...
    }

    override fun onChildMoved(dataSnapshot: DataSnapshot, previousChildName: String?) {
        Log.d(TAG, "onChildMoved:" + dataSnapshot.key!!)

        // A comment has changed position, use the key to determine if we are
        // displaying this comment and if so move it.
        val movedComment = dataSnapshot.getValue<Comment>()
        val commentKey = dataSnapshot.key

        // ...
    }

    override fun onCancelled(databaseError: DatabaseError) {
        Log.w(TAG, "postComments:onCancelled", databaseError.toException())
        Toast.makeText(context, "Failed to load comments.",
                Toast.LENGTH_SHORT).show()
    }
}
databaseReference.addChildEventListener(childEventListener)
QueryActivity.kt

ChildEventListener childEventListener = new ChildEventListener() {
    @Override
    public void onChildAdded(DataSnapshot dataSnapshot, String previousChildName) {
        Log.d(TAG, "onChildAdded:" + dataSnapshot.getKey());

        // A new comment has been added, add it to the displayed list
        Comment comment = dataSnapshot.getValue(Comment.class);

        // ...
    }

    @Override
    public void onChildChanged(DataSnapshot dataSnapshot, String previousChildName) {
        Log.d(TAG, "onChildChanged:" + dataSnapshot.getKey());

        // A comment has changed, use the key to determine if we are displaying this
        // comment and if so displayed the changed comment.
        Comment newComment = dataSnapshot.getValue(Comment.class);
        String commentKey = dataSnapshot.getKey();

        // ...
    }

    @Override
    public void onChildRemoved(DataSnapshot dataSnapshot) {
        Log.d(TAG, "onChildRemoved:" + dataSnapshot.getKey());

        // A comment has changed, use the key to determine if we are displaying this
        // comment and if so remove it.
        String commentKey = dataSnapshot.getKey();

        // ...
    }

    @Override
    public void onChildMoved(DataSnapshot dataSnapshot, String previousChildName) {
        Log.d(TAG, "onChildMoved:" + dataSnapshot.getKey());

        // A comment has changed position, use the key to determine if we are
        // displaying this comment and if so move it.
        Comment movedComment = dataSnapshot.getValue(Comment.class);
        String commentKey = dataSnapshot.getKey();

        // ...
    }

    @Override
    public void onCancelled(DatabaseError databaseError) {
        Log.w(TAG, "postComments:onCancelled", databaseError.toException());
        Toast.makeText(mContext, "Failed to load comments.",
                Toast.LENGTH_SHORT).show();
    }
};
databaseReference.addChildEventListener(childEventListener);
QueryActivity.java

महत्वपूर्ण घटनाओं के लिए सुनो

डेटा की सूचियों को पढ़ने के लिए ChildEventListener उपयोग करने की अनुशंसा की जाती है, लेकिन ऐसी स्थितियाँ होती हैं जहाँ ValueEventListener को सूची संदर्भ में संलग्न करना उपयोगी होता है।

डेटा की सूची में ValueEventListener संलग्न करने से डेटा की पूरी सूची एक DataSnapshot के रूप में वापस आ जाएगी, जिसे आप अलग-अलग बच्चों तक पहुंचने के लिए लूप कर सकते हैं।

भले ही क्वेरी के लिए केवल एक ही मैच हो, स्नैपशॉट अभी भी एक सूची है; इसमें केवल एक आइटम है। आइटम तक पहुँचने के लिए, आपको परिणाम पर लूप करने की आवश्यकता है:

// My top posts by number of stars
myTopPostsQuery.addValueEventListener(object : ValueEventListener {
    override fun onDataChange(dataSnapshot: DataSnapshot) {
        for (postSnapshot in dataSnapshot.children) {
            // TODO: handle the post
        }
    }

    override fun onCancelled(databaseError: DatabaseError) {
        // Getting Post failed, log a message
        Log.w(TAG, "loadPost:onCancelled", databaseError.toException())
        // ...
    }
})
QueryActivity.kt

// My top posts by number of stars
myTopPostsQuery.addValueEventListener(new ValueEventListener() {
    @Override
    public void onDataChange(@NonNull DataSnapshot dataSnapshot) {
        for (DataSnapshot postSnapshot: dataSnapshot.getChildren()) {
            // TODO: handle the post
        }
    }

    @Override
    public void onCancelled(@NonNull DatabaseError databaseError) {
        // Getting Post failed, log a message
        Log.w(TAG, "loadPost:onCancelled", databaseError.toException());
        // ...
    }
});
QueryActivity.java

यह प्रतिमान तब उपयोगी हो सकता है जब आप अतिरिक्त onChildAdded ईवेंट सुनने के बजाय किसी सूची के सभी चिल्ड्रन को एक ही ऑपरेशन में लाना चाहते हैं।

श्रोताओं को अलग करें

आपके फायरबेस डेटाबेस संदर्भ पर removeEventListener() विधि को कॉल करके कॉलबैक हटा दिए जाते हैं।

यदि एक श्रोता को डेटा स्थान पर कई बार जोड़ा गया है, तो इसे प्रत्येक घटना के लिए कई बार कहा जाता है, और इसे पूरी तरह से हटाने के लिए आपको इसे समान संख्या में अलग करना होगा।

पेरेंट श्रोता पर removeEventListener() को कॉल करने से उसके चाइल्ड नोड्स पर पंजीकृत श्रोता स्वचालित रूप से नहीं हटते हैं; कॉलबैक को हटाने के लिए किसी भी बाल श्रोताओं पर removeEventListener() भी कॉल किया जाना चाहिए।

डेटा को सॉर्ट करना और फ़िल्टर करना

आप कुंजी द्वारा, मान द्वारा, या किसी चाइल्ड के मान द्वारा सॉर्ट किए गए डेटा को पुनः प्राप्त करने के लिए रीयलटाइम डेटाबेस Query क्लास का उपयोग कर सकते हैं। आप सॉर्ट किए गए परिणाम को विशिष्ट संख्या में परिणामों या कुंजियों या मानों की श्रेणी में भी फ़िल्टर कर सकते हैं।

डेटा क्रमबद्ध करें

सॉर्ट किए गए डेटा को पुनः प्राप्त करने के लिए, यह निर्धारित करने के लिए कि कैसे परिणाम ऑर्डर किए जाते हैं, ऑर्डर-बाय विधियों में से एक को निर्दिष्ट करके प्रारंभ करें:

आप एक समय में केवल एक ऑर्डर-बाय विधि का उपयोग कर सकते हैं। ऑर्डर-बाय विधि को एक ही क्वेरी में कई बार कॉल करने से त्रुटि होती है।

निम्नलिखित उदाहरण दर्शाता है कि आप किसी उपयोगकर्ता की स्टार संख्या द्वारा क्रमबद्ध की गई शीर्ष पोस्ट की सूची कैसे प्राप्त कर सकते हैं:

// My top posts by number of stars
val myUserId = uid
val myTopPostsQuery = databaseReference.child("user-posts").child(myUserId)
    .orderByChild("starCount")

myTopPostsQuery.addChildEventListener(object : ChildEventListener {
    // TODO: implement the ChildEventListener methods as documented above
    // ...
})
QueryActivity.kt

// My top posts by number of stars
String myUserId = getUid();
Query myTopPostsQuery = databaseReference.child("user-posts").child(myUserId)
        .orderByChild("starCount");
myTopPostsQuery.addChildEventListener(new ChildEventListener() {
    // TODO: implement the ChildEventListener methods as documented above
    // ...
});
QueryActivity.java

यह एक क्वेरी को परिभाषित करता है जो एक बाल श्रोता के साथ संयुक्त होने पर क्लाइंट को उपयोगकर्ता की पोस्ट के साथ डेटाबेस में उनके उपयोगकर्ता आईडी के आधार पर सिंक्रनाइज़ करता है, प्रत्येक पोस्ट को प्राप्त सितारों की संख्या के आधार पर। इंडेक्स कुंजियों के रूप में आईडी का उपयोग करने की इस तकनीक को डेटा फैन आउट कहा जाता है, आप इसके बारे में स्ट्रक्चर योर डेटाबेस में अधिक पढ़ सकते हैं।

orderByChild() विधि के लिए कॉल परिणाम को ऑर्डर करने के लिए चाइल्ड कुंजी को निर्दिष्ट करता है। इस मामले में, पदों को उनके संबंधित "starCount" चाइल्ड के मान के अनुसार क्रमबद्ध किया जाता है। प्रश्नों को नेस्टेड चिल्ड्रन द्वारा भी आदेशित किया जा सकता है, यदि आपके पास ऐसा डेटा है जो इस तरह दिखता है:

"posts": {
  "ts-functions": {
    "metrics": {
      "views" : 1200000,
      "likes" : 251000,
      "shares": 1200,
    },
    "title" : "Why you should use TypeScript for writing Cloud Functions",
    "author": "Doug",
  },
  "android-arch-3": {
    "metrics": {
      "views" : 900000,
      "likes" : 117000,
      "shares": 144,
    },
    "title" : "Using Android Architecture Components with Firebase Realtime Database (Part 3)",
    "author": "Doug",
  }
},

इस उदाहरण में, हम अपने orderByChild() कॉल में नेस्टेड चाइल्ड के सापेक्ष पथ निर्दिष्ट करके metrics कुंजी के अंतर्गत नेस्टेड मानों द्वारा अपनी सूची तत्वों को ऑर्डर कर सकते हैं।

// Most viewed posts
val myMostViewedPostsQuery = databaseReference.child("posts")
        .orderByChild("metrics/views")
myMostViewedPostsQuery.addChildEventListener(object : ChildEventListener {
    // TODO: implement the ChildEventListener methods as documented above
    // ...
})
QueryActivity.kt

// Most viewed posts
Query myMostViewedPostsQuery = databaseReference.child("posts")
        .orderByChild("metrics/views");
myMostViewedPostsQuery.addChildEventListener(new ChildEventListener() {
    // TODO: implement the ChildEventListener methods as documented above
    // ...
});
QueryActivity.java

अन्य डेटा प्रकारों को कैसे क्रमित किया जाता है, इस बारे में अधिक जानकारी के लिए, क्वेरी डेटा कैसे क्रमबद्ध किया जाता है देखें।

फ़िल्टरिंग डेटा

डेटा को फ़िल्टर करने के लिए, आप किसी क्वेरी का निर्माण करते समय किसी भी सीमा या श्रेणी विधियों को ऑर्डर-बाय विधि के साथ जोड़ सकते हैं।

ऑर्डर-बाय विधियों के विपरीत, आप कई सीमा या श्रेणी कार्यों को जोड़ सकते हैं। उदाहरण के लिए, आप परिणामों को निर्दिष्ट मानों की सीमा तक सीमित करने के लिए startAt() और endAt() विधियों को जोड़ सकते हैं।

भले ही क्वेरी के लिए केवल एक ही मैच हो, स्नैपशॉट अभी भी एक सूची है; इसमें केवल एक आइटम है। आइटम तक पहुँचने के लिए, आपको परिणाम पर लूप करने की आवश्यकता है:

// My top posts by number of stars
myTopPostsQuery.addValueEventListener(object : ValueEventListener {
    override fun onDataChange(dataSnapshot: DataSnapshot) {
        for (postSnapshot in dataSnapshot.children) {
            // TODO: handle the post
        }
    }

    override fun onCancelled(databaseError: DatabaseError) {
        // Getting Post failed, log a message
        Log.w(TAG, "loadPost:onCancelled", databaseError.toException())
        // ...
    }
})
QueryActivity.kt

// My top posts by number of stars
myTopPostsQuery.addValueEventListener(new ValueEventListener() {
    @Override
    public void onDataChange(@NonNull DataSnapshot dataSnapshot) {
        for (DataSnapshot postSnapshot: dataSnapshot.getChildren()) {
            // TODO: handle the post
        }
    }

    @Override
    public void onCancelled(@NonNull DatabaseError databaseError) {
        // Getting Post failed, log a message
        Log.w(TAG, "loadPost:onCancelled", databaseError.toException());
        // ...
    }
});
QueryActivity.java

परिणामों की संख्या सीमित करें

किसी दिए गए कॉलबैक के लिए सिंक किए जाने वाले बच्चों की अधिकतम संख्या सेट करने के लिए आप limitToFirst() और limitToLast() विधियों का उपयोग कर सकते हैं। उदाहरण के लिए, यदि आप 100 की सीमा निर्धारित करने के लिए limitToFirst() उपयोग करते हैं, तो आप प्रारंभ में केवल 100 onChildAdded() कॉलबैक प्राप्त करते हैं। यदि आपके पास अपने फायरबेस डेटाबेस में 100 से कम आइटम संग्रहीत हैं, तो प्रत्येक आइटम के लिए onChildAdded() कॉलबैक सक्रिय होता है।

जैसे ही आइटम बदलते हैं, आपको उन आइटम्स के लिए onChildAdded() कॉलबैक प्राप्त होते हैं जो क्वेरी में प्रवेश करते हैं और उन आइटम्स के लिए onChildRemoved() कॉलबैक प्राप्त करते हैं जो इससे बाहर हो जाते हैं ताकि कुल संख्या 100 पर बनी रहे।

निम्न उदाहरण दर्शाता है कि कैसे उदाहरण ब्लॉगिंग ऐप सभी उपयोगकर्ताओं द्वारा 100 सबसे हालिया पोस्ट की सूची को पुनः प्राप्त करने के लिए एक क्वेरी को परिभाषित करता है:

// Last 100 posts, these are automatically the 100 most recent
// due to sorting by push() keys.
databaseReference.child("posts").limitToFirst(100)
QueryActivity.kt

// Last 100 posts, these are automatically the 100 most recent
// due to sorting by push() keys
Query recentPostsQuery = databaseReference.child("posts")
        .limitToFirst(100);
QueryActivity.java

यह उदाहरण केवल एक क्वेरी को परिभाषित करता है, डेटा को वास्तव में सिंक्रनाइज़ करने के लिए इसे संलग्न श्रोता की आवश्यकता होती है।

कुंजी या मान द्वारा फ़िल्टर करें

आप startAt() , startAfter() , endAt() , endBefore() , और equalTo() का उपयोग प्रश्नों के लिए मनमाना प्रारंभ, समाप्ति और समतुल्यता बिंदुओं का चयन करने के लिए कर सकते हैं। यह डेटा को पृष्ठांकित करने या बच्चों के साथ उन वस्तुओं को खोजने के लिए उपयोगी हो सकता है जिनका एक विशिष्ट मूल्य है।

क्वेरी डेटा कैसे ऑर्डर किया जाता है

यह खंड बताता है कि Query वर्ग में प्रत्येक ऑर्डर-बाय विधियों द्वारा डेटा को कैसे सॉर्ट किया जाता है।

orderByChild

orderByChild() का उपयोग करते समय, निर्दिष्ट चाइल्ड कुंजी वाले डेटा को निम्नानुसार आदेश दिया जाता है:

1. निर्दिष्ट चाइल्ड कुंजी के लिए null मान वाले बच्चे पहले आते हैं।
2. निर्दिष्ट चाइल्ड कुंजी के लिए false मान वाले बच्चे आगे आते हैं। यदि एक से अधिक चिल्ड्रन का मान false है, तो उन्हें कुंजी द्वारा शब्दकोष के अनुसार क्रमबद्ध किया जाता है।
3. निर्दिष्ट चाइल्ड कुंजी के लिए true मान वाले बच्चे आगे आते हैं। यदि एक से अधिक चिल्ड्रन का मान true है, तो उन्हें कुंजी द्वारा शब्दकोष के अनुसार क्रमबद्ध किया जाता है।
4. संख्यात्मक मान वाले बच्चे आगे आते हैं, आरोही क्रम में क्रमबद्ध होते हैं। यदि निर्दिष्ट चाइल्ड नोड के लिए एकाधिक चिल्ड्रन का संख्यात्मक मान समान है, तो उन्हें कुंजी द्वारा क्रमबद्ध किया जाता है।
5. तार संख्या के बाद आते हैं और आरोही क्रम में शब्दावली के अनुसार क्रमबद्ध होते हैं। यदि निर्दिष्ट चाइल्ड नोड के लिए एकाधिक चिल्ड्रन का मान समान है, तो उन्हें कुंजी द्वारा लेक्सिकोग्राफ़िक रूप से क्रमित किया जाता है।
6. ऑब्जेक्ट सबसे अंत में आते हैं और आरोही क्रम में कुंजी द्वारा लेक्सिकोग्राफ़िक रूप से सॉर्ट किए जाते हैं।

orderByKey

अपने डेटा को सॉर्ट करने के लिए orderByKey() उपयोग करते समय, डेटा को कुंजी द्वारा आरोही क्रम में लौटाया जाता है।

1. एक कुंजी वाले बच्चे जिन्हें 32-बिट पूर्णांक के रूप में पार्स किया जा सकता है, पहले आते हैं, आरोही क्रम में क्रमबद्ध होते हैं।
2. उनकी कुंजी के रूप में एक स्ट्रिंग मान वाले बच्चे आगे आते हैं, आरोही क्रम में लेक्सिकोग्राफ़िक रूप से क्रमबद्ध होते हैं।

orderByValue

orderByValue() उपयोग करते समय, बच्चों को उनके मूल्य द्वारा आदेश दिया जाता है। ऑर्डरिंग मानदंड orderByChild() के समान हैं, नोड के मान को छोड़कर एक निर्दिष्ट चाइल्ड कुंजी के मान के बजाय उपयोग किया जाता है।

अगले कदम

• डेटा की संरचना करना सीखें
• डेटा को ऑफलाइन स्टोर करें