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

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

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

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

Java

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

Kotlin+KTX

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

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

डेटा की सूची में जोड़ें

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

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

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

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

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

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

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

श्रोता घटना कॉलबैक विशिष्ट उपयोग
ChildEventListener onChildAdded() मदों की सूची प्राप्त करें या मदों की सूची में परिवर्धन के लिए सुनें। यह कॉलबैक प्रत्येक मौजूदा बच्चे के लिए एक बार ट्रिगर किया जाता है और फिर हर बार एक नया बच्चा निर्दिष्ट पथ में जोड़ा जाता है। श्रोता को दिए गए DataSnapshot में नए बच्चे का डेटा होता है।
onChildChanged() सूची में आइटम में परिवर्तन के लिए सुनें। किसी भी समय चाइल्ड नोड को संशोधित करने पर इस घटना को निकाल दिया जाता है, जिसमें चाइल्ड नोड के वंशजों में कोई भी संशोधन शामिल है। इवेंट श्रोता को पास किए गए डेटा DataSnapshot में बच्चे के लिए अद्यतन डेटा होता है।
onChildRemoved() सूची से हटाए जा रहे आइटमों को सुनें। इवेंट कॉलबैक में पास किए गए डेटा DataSnapshot में हटाए गए बच्चे का डेटा होता है।
onChildMoved() एक आदेशित सूची में आइटम के क्रम में परिवर्तन के लिए सुनें। जब भी onChildChanged() कॉलबैक किसी ऐसे अपडेट से ट्रिगर होता है, जो बच्चे को फिर से व्यवस्थित करने का कारण बनता है, तो यह घटना शुरू हो जाती है। इसका उपयोग उस डेटा के साथ किया जाता है जिसे orderByChild या orderByValue के साथ ऑर्डर किया जाता है।

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

Java

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);

Kotlin+KTX

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)

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

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

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

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

Java

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

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

Kotlin+KTX

// 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())
        // ...
    }
})

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

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

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

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

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

डेटा को छाँटना और फ़िल्टर करना

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

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

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

तरीका प्रयोग
orderByChild() किसी निर्दिष्ट चाइल्ड कुंजी या नेस्टेड चाइल्ड पथ के मान के आधार पर परिणाम ऑर्डर करें।
orderByKey() चाइल्ड कीज़ द्वारा परिणाम ऑर्डर करें।
orderByValue() बाल मूल्यों द्वारा आदेश परिणाम।

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

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

Java

// 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
    // ...
});

Kotlin+KTX

// 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
    // ...
})

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

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 कुंजी के तहत नेस्टेड मानों द्वारा हमारे सूची तत्वों को ऑर्डर कर सकते हैं।

Java

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

Kotlin+KTX

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

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

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

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

तरीका प्रयोग
limitToFirst() परिणामों की क्रमबद्ध सूची की शुरुआत से लौटने के लिए अधिकतम आइटम सेट करता है।
limitToLast() परिणामों की आदेशित सूची के अंत से लौटने के लिए आइटम की अधिकतम संख्या सेट करता है।
startAt() चुनी गई ऑर्डर-बाय विधि के आधार पर निर्दिष्ट कुंजी या मान से अधिक या उसके बराबर आइटम लौटाएं।
startAfter() चुनी गई ऑर्डर-बाय विधि के आधार पर निर्दिष्ट कुंजी या मान से अधिक आइटम लौटाएं।
endAt() चुनी गई ऑर्डर-बाय विधि के आधार पर निर्दिष्ट कुंजी या मान से कम या उसके बराबर आइटम लौटाएं।
endBefore() चुनी गई ऑर्डर-बाय विधि के आधार पर निर्दिष्ट कुंजी या मान से कम आइटम लौटाएं।
equalTo() चुनी गई ऑर्डर-बाय विधि के आधार पर निर्दिष्ट कुंजी या मान के बराबर आइटम लौटाएं।

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

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

Java

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

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

Kotlin+KTX

// 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())
        // ...
    }
})

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

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

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

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

Java

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

Kotlin+KTX

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

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

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

प्रश्नों के लिए मनमाना प्रारंभ, समाप्ति और तुल्यता बिंदु चुनने के लिए आप 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() के समान हैं, सिवाय इसके कि नोड के मान का उपयोग निर्दिष्ट चाइल्ड कुंजी के मान के बजाय किया जाता है।

अगले कदम