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

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

DatabaseReference पाएं

डेटाबेस से डेटा पढ़ने और उसमें बदलाव करने के लिए, आपके पास DatabaseReference का एक इंस्टेंस होना चाहिए:

Kotlin+KTX

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

Java

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

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

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

एक से ज़्यादा उपयोगकर्ताओं वाले ऐप्लिकेशन की किसी सूची में डेटा जोड़ने के लिए, push() तरीके का इस्तेमाल करें. push() तरीका, हर बार नई कुंजी जनरेट करता है चाइल्ड को तय किए गए Firebase रेफ़रंस में जोड़ दिया जाता है. सूची में मौजूद हर नए एलिमेंट के लिए, अपने-आप जनरेट हुई इन कुंजियों का इस्तेमाल करके, कई क्लाइंट एक ही समय पर एक ही जगह पर चाइल्ड जोड़ सकते हैं. ऐसा करने पर, डेटा को लिखने में कोई समस्या नहीं होती. push() से जनरेट किया गया यूनीक पासकोड, टाइमस्टैंप पर आधारित होता है. इसलिए, सूची के आइटम अपने-आप समय के हिसाब से क्रम में लग जाते हैं.

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

अपने-आप जनरेट होने वाली इन कुंजियों का इस्तेमाल करके, अपने डेटा को आसानी से बराबर किया जा सकता है स्ट्रक्चर. ज़्यादा जानकारी के लिए, 'फ़ैन-आउट' डेटा देखें उदाहरण के लिए.

बच्चों के लिए बने इवेंट सुनें

सूचियों के साथ काम करते समय, आपके ऐप्लिकेशन को बच्चों के इवेंट सुनने चाहिए का इस्तेमाल करें.

चाइल्ड इवेंट, एक कन्वर्ज़न ऐक्शन की वजह से ट्रिगर होते हैं. एक कार्रवाई के नोड के चिल्ड्रेन जैसे push() तरीका या updateChildren() तरीके से अपडेट किया जा रहा चाइल्ड. किसी खास नोड में हुए बदलावों को सुनने के लिए इन सभी तरीकों को एक साथ इस्तेमाल किया जा सकता है एक डेटाबेस में रखा जा सकता है.

DatabaseReference पर बच्चों के इवेंट को सुनने के लिए, ChildEventListener:

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

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

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)

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

वैल्यू इवेंट सुनें

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

डेटा की सूची में ValueEventListener अटैच करने पर, पूरा डेटा दिखेगा DataSnapshot के तौर पर डेटा की सूची, जिसे आप लूप में चलाकर देख सकते हैं अलग-अलग बच्चों को ऐक्सेस दें.

भले ही क्वेरी के लिए सिर्फ़ एक मैच हो, फिर भी स्नैपशॉट सूची; इसमें सिर्फ़ एक आइटम होता है. आइटम को ऐक्सेस करने के लिए, आपको लूप करना होगा इस नतीजे पर:

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

Java

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

यह पैटर्न तब काम का हो सकता है, जब किसी सूची में मौजूद सभी चिल्ड्रेन को फ़ेच करना हो अतिरिक्त onChildAdded सुनने के बजाय एक ही कार्रवाई में इवेंट.

लिसनर को अलग करें

आपके नंबर पर removeEventListener() तरीके को कॉल करने पर, कॉलबैक हट जाते हैं Firebase डेटाबेस का रेफ़रंस.

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

पैरंट लिसनर पर, removeEventListener() को कॉल करने से अपने चाइल्ड नोड पर रजिस्टर किए गए लिसनर को अपने-आप हटा दें; चाइल्ड लिसनर के लिए भी removeEventListener() को कॉल किया जाना चाहिए कॉलबैक हटाने के लिए.

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

इसके हिसाब से क्रम में लगाए गए डेटा को वापस पाने के लिए, Realtime Database Query क्लास का इस्तेमाल किया जा सकता है वैल्यू या वैल्यू के हिसाब से तय किया जा सकता है. फ़िल्टर भी किया जा सकता है नतीजों की तय संख्या या कुंजियों की रेंज के लिए क्रम से लगाया गया नतीजा या वैल्यू.

डेटा को क्रम से लगाएं

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

तरीका इस्तेमाल किए जाने से जुड़ी जानकारी
orderByChild() किसी खास चाइल्ड कुंजी या नेस्ट किए गए चाइल्ड पाथ की वैल्यू के हिसाब से नतीजों को क्रम से लगाएं.
orderByKey() चाइल्ड कुंजियों के हिसाब से नतीजों को क्रम से लगाएं.
orderByValue() चाइल्ड वैल्यू के हिसाब से नतीजों को क्रम से लगाएं.

ऑर्डर करने के लिए, एक बार में सिर्फ़ एक तरीका इस्तेमाल किया जा सकता है. आदेश-दर-चरण कॉल करना एक ही क्वेरी में कई बार आने पर गड़बड़ी होती है.

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

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

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

इससे ऐसी क्वेरी के बारे में पता चलता है जो चाइल्ड लिसनर के साथ जुड़ने पर यह क्लाइंट को डेटाबेस में मौजूद पाथ से उपयोगकर्ता की पोस्ट के साथ सिंक करता है हर पोस्ट को मिले स्टार की संख्या के हिसाब से, उनके यूज़र आईडी के हिसाब से क्रम में लगाया जाता है. आईडी का इस्तेमाल इंडेक्स कुंजियों के तौर पर करने की इस तकनीक को डेटा फ़ैन आउट कहा जाता है. ज़्यादा जानकारी के लिए, अपने डेटाबेस का स्ट्रक्चर तैयार करें.

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",
  }
},

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

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

Java

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

अन्य डेटा टाइप को क्रम से लगाने के तरीके के बारे में ज़्यादा जानने के लिए, क्वेरी डेटा को क्रम से लगाने का तरीका लेख पढ़ें.

डेटा फ़िल्टर करना

डेटा फ़िल्टर करने के लिए, सीमा या रेंज में से किसी एक तरीके को क्वेरी तैयार करते समय, एक-एक करके तय किए गए क्रम में.

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

क्रम से लगाने के तरीकों के उलट, कई सीमाएं या रेंज फ़ंक्शन जोड़े जा सकते हैं. उदाहरण के लिए, सीमा तय करने के लिए, startAt() और endAt() तरीकों को मिलाया जा सकता है वैल्यू की तय सीमा तक नतीजे दिखाता है.

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

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

Java

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

नतीजों की संख्या सीमित करना

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

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

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

Kotlin+KTX

// Last 100 posts, these are automatically the 100 most recent
// due to sorting by push() keys.
databaseReference.child("posts").limitToFirst(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);

यह उदाहरण सिर्फ़ उस क्वेरी के बारे में बताता है जो उसकी ज़रूरत के हिसाब से डेटा को सिंक करती है लिसनर को अटैच कर सकते हैं.

कुंजी या वैल्यू के हिसाब से फ़िल्टर करें

startAt(), startAfter(), endAt(), endBefore(), और equalTo() के लिए आर्बिट्रेरी शुरुआती, आखिरी, और समतुल्य पॉइंट चुनने के लिए क्वेरी. यह डेटा को पेजों में बांटने या बच्चों के आइटम ढूंढने में मददगार हो सकता है .

क्वेरी डेटा को क्रम से कैसे लगाया जाता है

इस सेक्शन में बताया गया है कि Query क्लास.

orderByChild

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

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

orderByKey

डेटा को क्रम से लगाने के लिए orderByKey() का इस्तेमाल करने पर, डेटा बढ़ते क्रम में दिखता है बटन से.

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

orderByValue

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

अगले चरण