क्लाउड फायरस्टोर एंड्रॉइड कोडलैब

1 अवलोकन

लक्ष्य

इस कोडलैब में आप क्लाउड फायरस्टोर द्वारा समर्थित एंड्रॉइड पर एक रेस्तरां अनुशंसा ऐप का निर्माण करेंगे। आप जान जायेंगे कैसे:

  • किसी Android ऐप से Firestore को डेटा पढ़ें और लिखें
  • रीयलटाइम में Firestore डेटा में बदलाव सुनें
  • Firestore डेटा सुरक्षित करने के लिए Firebase प्रमाणीकरण और सुरक्षा नियमों का उपयोग करें
  • जटिल फायरस्टोर प्रश्न लिखें

आवश्यक शर्तें

इस कोडलैब को शुरू करने से पहले सुनिश्चित करें कि आपके पास:

  • एंड्रॉइड स्टूडियो 4.0 या उच्चतर
  • एपीआई 19 या उच्चतर के साथ एक एंड्रॉइड एमुलेटर
  • Node.js संस्करण 10 या उच्चतर
  • जावा संस्करण 8 या उच्चतर

2. एक फायरबेस प्रोजेक्ट बनाएं

  1. अपने Google खाते से Firebase कंसोल में साइन इन करें।
  2. फायरबेस कंसोल में, प्रोजेक्ट जोड़ें पर क्लिक करें।
  3. जैसा कि नीचे स्क्रीन कैप्चर में दिखाया गया है, अपने फायरबेस प्रोजेक्ट के लिए एक नाम दर्ज करें (उदाहरण के लिए, "फ्रेंडली ईट्स"), और जारी रखें पर क्लिक करें।

9d2f625aebcab6af.png

  1. आपको Google Analytics को सक्षम करने के लिए कहा जा सकता है, इस कोडलैब के प्रयोजनों के लिए आपका चयन कोई मायने नहीं रखता।
  2. एक-एक मिनट के बाद, आपका फायरबेस प्रोजेक्ट तैयार हो जाएगा। जारी रखें पर क्लिक करें।

3. नमूना परियोजना सेट करें

कोड डाउनलोड करें

इस कोडलैब के लिए नमूना कोड को क्लोन करने के लिए निम्न कमांड चलाएँ। यह आपकी मशीन पर friendlyeats-android नामक एक फोल्डर बनाएगा:

$ git clone https://github.com/firebase/friendlyeats-android

यदि आपकी मशीन पर git नहीं है, तो आप सीधे GitHub से भी कोड डाउनलोड कर सकते हैं।

फायरबेस कॉन्फ़िगरेशन जोड़ें

  1. फायरबेस कंसोल में, बाएं नेविगेशन में प्रोजेक्ट अवलोकन का चयन करें। मंच का चयन करने के लिए एंड्रॉइड बटन पर क्लिक करें। जब पैकेज नाम के लिए कहा जाए तो com.google.firebase.example.fireeats का उपयोग करें

73d151ed16016421.png

  1. रजिस्टर ऐप पर क्लिक करें और google-services.json फ़ाइल डाउनलोड करने के लिए निर्देशों का पालन करें, और इसे आपके द्वारा अभी डाउनलोड किए गए कोड के app/ फ़ोल्डर में ले जाएँ। फिर अगला क्लिक करें।

परियोजना आयात करें

एंड्रॉइड स्टूडियो खोलें। फ़ाइल > नया > प्रोजेक्ट आयात करें पर क्लिक करें और फ्रेंडलीईट्स-एंड्रॉइड फ़ोल्डर चुनें।

4. फायरबेस एमुलेटर सेट करें

इस कोडलैब में आप Cloud Firestore और अन्य Firebase सेवाओं का स्थानीय रूप से अनुकरण करने के लिए Firebase Emulator Suite का उपयोग करेंगे। यह आपके ऐप को बनाने के लिए एक सुरक्षित, तेज़ और बिना लागत वाला स्थानीय विकास वातावरण प्रदान करता है।

फायरबेस सीएलआई स्थापित करें

सबसे पहले आपको फायरबेस सीएलआई इंस्टॉल करना होगा। यदि आप macOS या Linux का उपयोग कर रहे हैं, तो आप निम्न cURL कमांड चला सकते हैं:

curl -sL https://firebase.tools | bash

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

एक बार जब आप सीएलआई स्थापित कर लेते हैं, तो firebase --version चलाने से 9.0.0 या उच्चतर संस्करण की रिपोर्ट होनी चाहिए:

$ firebase --version
9.0.0

लॉग इन करें

सीएलआई को अपने Google खाते से जोड़ने के लिए firebase login चलाएँ। यह लॉगिन प्रक्रिया को पूरा करने के लिए एक नई ब्राउज़र विंडो खोलेगा। सुनिश्चित करें कि आपने वही खाता चुना है जिसका उपयोग आपने पहले अपना Firebase प्रोजेक्ट बनाते समय किया था।

अपने स्थानीय प्रोजेक्ट को अपने फ़ायरबेस प्रोजेक्ट से जोड़ने के लिए friendlyeats-android फोल्डर के भीतर से firebase use --add करें। आपके द्वारा पहले बनाए गए प्रोजेक्ट का चयन करने के लिए संकेतों का पालन करें और यदि कोई उपनाम चुनने के लिए कहा जाए तो default दर्ज करें।

5. ऐप चलाएं

अब पहली बार Firebase Emulator Suite और FriendlyEats Android ऐप चलाने का समय आ गया है।

एमुलेटर चलाएं

अपने टर्मिनल में friendlyeats-android डायरेक्टरी के भीतर से फायरबेस एमुलेटर चलाएं firebase emulators:start करें। आपको इस तरह के लॉग देखना चाहिए:

$ firebase emulators:start
i  emulators: Starting emulators: auth, firestore
i  firestore: Firestore Emulator logging to firestore-debug.log
i  ui: Emulator UI logging to ui-debug.log

┌─────────────────────────────────────────────────────────────┐
│ ✔  All emulators ready! It is now safe to connect your app. │
│ i  View Emulator UI at http://localhost:4000                │
└─────────────────────────────────────────────────────────────┘

┌────────────────┬────────────────┬─────────────────────────────────┐
│ Emulator       │ Host:Port      │ View in Emulator UI             │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Authentication │ localhost:9099 │ http://localhost:4000/auth      │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Firestore      │ localhost:8080 │ http://localhost:4000/firestore │
└────────────────┴────────────────┴─────────────────────────────────┘
  Emulator Hub running at localhost:4400
  Other reserved ports: 4500

Issues? Report them at https://github.com/firebase/firebase-tools/issues and attach the *-debug.log files.

अब आपके पास अपनी मशीन पर एक पूर्ण स्थानीय विकास वातावरण चल रहा है! इस कमांड को बाकी कोडलैब के लिए चलाना सुनिश्चित करें, आपके एंड्रॉइड ऐप को एमुलेटर से कनेक्ट करने की आवश्यकता होगी।

ऐप को एमुलेटर से कनेक्ट करें

Android Studio में FirebaseUtil.java फ़ाइल खोलें। इस फ़ाइल में फायरबेस एसडीके को आपकी मशीन पर चल रहे स्थानीय एमुलेटर से जोड़ने का तर्क है।

फ़ाइल के शीर्ष पर, इस पंक्ति की जाँच करें:

    /** Use emulators only in debug builds **/
    private static final boolean sUseEmulators = BuildConfig.DEBUG;

हम यह सुनिश्चित करने के लिए BuildConfig का उपयोग कर रहे हैं कि हम केवल एमुलेटर से कनेक्ट हों जब हमारा ऐप debug मोड में चल रहा हो। जब हम ऐप को release मोड में संकलित करते हैं तो यह स्थिति झूठी होगी।

अब getFirestore() विधि पर एक नज़र डालें:

    public static FirebaseFirestore getFirestore() {
        if (FIRESTORE == null) {
            FIRESTORE = FirebaseFirestore.getInstance();

            // Connect to the Cloud Firestore emulator when appropriate. The host '10.0.2.2' is a
            // special IP address to let the Android emulator connect to 'localhost'.
            if (sUseEmulators) {
                FIRESTORE.useEmulator("10.0.2.2", 8080);
            }
        }

        return FIRESTORE;
    }

हम देख सकते हैं कि यह फायरबेस एसडीके को स्थानीय फायरस्टोर एमुलेटर से जोड़ने के लिए useEmulator(host, port) विधि का उपयोग कर रहा है। पूरे ऐप में हम FirebaseFirestore के इस उदाहरण तक पहुंचने के लिए FirebaseFirestore FirebaseUtil.getFirestore() का उपयोग करेंगे, इसलिए हमें यकीन है कि debug मोड में चलते समय हम हमेशा फायरस्टोर एमुलेटर से कनेक्ट होते हैं।

ऐप चलाएं

यदि आपने google-services.json फ़ाइल को ठीक से जोड़ा है, तो प्रोजेक्ट अब संकलित होना चाहिए। एंड्रॉइड स्टूडियो में बिल्ड > रीबिल्ड प्रोजेक्ट पर क्लिक करें और सुनिश्चित करें कि कोई शेष त्रुटियां नहीं हैं।

एंड्रॉइड स्टूडियो में अपने एंड्रॉइड एमुलेटर पर ऐप चलाएं । सबसे पहले आपको "साइन इन" स्क्रीन के साथ प्रस्तुत किया जाएगा। ऐप में साइन इन करने के लिए आप किसी भी ईमेल और पासवर्ड का उपयोग कर सकते हैं। यह साइन इन प्रक्रिया फायरबेस प्रमाणीकरण एमुलेटर से जुड़ रही है, इसलिए कोई वास्तविक प्रमाण-पत्र प्रसारित नहीं किया जा रहा है।

अब अपने वेब ब्राउजर में http://localhost:4000 पर नेविगेट करके एमुलेटर यूआई खोलें। फिर प्रमाणीकरण टैब पर क्लिक करें और आपको वह खाता देखना चाहिए जो आपने अभी बनाया है:

फायरबेस प्रामाणिक एमुलेटर

एक बार जब आप साइन इन प्रक्रिया पूरी कर लेते हैं तो आपको ऐप की होम स्क्रीन देखनी चाहिए:

de06424023ffb4b9.png

जल्द ही हम होम स्क्रीन को पॉप्युलेट करने के लिए कुछ डेटा जोड़ेंगे।

6. फायरस्टोर को डेटा लिखें

इस खंड में हम फायरस्टोर को कुछ डेटा लिखेंगे ताकि हम वर्तमान में खाली होम स्क्रीन को पॉप्युलेट कर सकें।

हमारे ऐप में मुख्य मॉडल ऑब्जेक्ट एक रेस्तरां है ( model/Restaurant.java देखें)। फायरस्टोर डेटा को दस्तावेज़ों, संग्रहों और उप-संग्रहों में विभाजित किया गया है। हम प्रत्येक रेस्तरां को "restaurants" नामक शीर्ष-स्तरीय संग्रह में एक दस्तावेज़ के रूप में संग्रहीत करेंगे। फायरस्टोर डेटा मॉडल के बारे में अधिक जानने के लिए, दस्तावेज़ीकरण में दस्तावेज़ों और संग्रहों के बारे में पढ़ें।

प्रदर्शन उद्देश्यों के लिए, जब हम अतिप्रवाह मेनू में "यादृच्छिक आइटम जोड़ें" बटन पर क्लिक करते हैं, तो हम दस यादृच्छिक रेस्तरां बनाने के लिए ऐप में कार्यक्षमता जोड़ देंगे। MainActivity.java फ़ाइल खोलें और सामग्री को onAddItemsClicked() विधि से बदलें:

    private void onAddItemsClicked() {
        // Get a reference to the restaurants collection
        CollectionReference restaurants = mFirestore.collection("restaurants");

        for (int i = 0; i < 10; i++) {
            // Get a random Restaurant POJO
            Restaurant restaurant = RestaurantUtil.getRandom(this);

            // Add a new document to the restaurants collection
            restaurants.add(restaurant);
        }
    }

उपरोक्त कोड के बारे में ध्यान देने योग्य कुछ महत्वपूर्ण बातें हैं:

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

अब ऐप को फिर से चलाएं और ओवरफ्लो मेनू में "रैंडम आइटम जोड़ें" बटन पर क्लिक करें (ऊपरी दाएं कोने पर) आपके द्वारा लिखे गए कोड को लागू करने के लिए:

95691e9b71ba55e3.png

अब अपने वेब ब्राउजर में http://localhost:4000 पर नेविगेट करके एमुलेटर यूआई खोलें। फिर फायरस्टोर टैब पर क्लिक करें और आपको वह डेटा देखना चाहिए जो आपने अभी जोड़ा है:

फायरबेस प्रामाणिक एमुलेटर

यह डेटा आपकी मशीन के लिए 100% स्थानीय है। वास्तव में, आपके वास्तविक प्रोजेक्ट में अभी तक एक फायरस्टोर डेटाबेस भी नहीं है! इसका मतलब यह है कि बिना किसी परिणाम के इस डेटा को संशोधित करने और हटाने के साथ प्रयोग करना सुरक्षित है।

बधाई हो, आपने अभी-अभी Firestore को डेटा लिखा है! अगले चरण में हम सीखेंगे कि इस डेटा को ऐप में कैसे प्रदर्शित किया जाए।

7. फायरस्टोर से डेटा प्रदर्शित करें

इस चरण में हम सीखेंगे कि फायरस्टोर से डेटा कैसे प्राप्त करें और इसे अपने ऐप में प्रदर्शित करें। फायरस्टोर से डेटा पढ़ने के लिए पहला कदम एक Query बनाना है। MainActivity.java फ़ाइल खोलें और onCreate onCreate() विधि की शुरुआत में निम्न कोड जोड़ें:

        mFirestore = FirebaseUtil.getFirestore();

        // Get the 50 highest rated restaurants
        mQuery = mFirestore.collection("restaurants")
                .orderBy("avgRating", Query.Direction.DESCENDING)
                .limit(LIMIT);

अब हम क्वेरी को सुनना चाहते हैं, ताकि हमें सभी मेल खाने वाले दस्तावेज़ मिलें और हमें वास्तविक समय में भविष्य के अपडेट के बारे में सूचित किया जाए। क्योंकि हमारा अंतिम लक्ष्य इस डेटा को एक RecyclerView से बाँधना है, हमें डेटा को सुनने के लिए एक RecyclerView.Adapter क्लास बनाने की आवश्यकता है।

FirestoreAdapter वर्ग खोलें, जिसे आंशिक रूप से पहले ही लागू किया जा चुका है। सबसे पहले, एडॉप्टर को EventListener लागू करते हैं और onEvent फ़ंक्शन को परिभाषित करते हैं ताकि यह एक फायरस्टोर क्वेरी के अपडेट प्राप्त कर सके:

public abstract class FirestoreAdapter<VH extends RecyclerView.ViewHolder>
        extends RecyclerView.Adapter<VH>
        implements EventListener<QuerySnapshot> { // Add this "implements"

    // ...

    // Add this method
    @Override
    public void onEvent(QuerySnapshot documentSnapshots,
                        FirebaseFirestoreException e) {

        // Handle errors
        if (e != null) {
            Log.w(TAG, "onEvent:error", e);
            return;
        }

        // Dispatch the event
        for (DocumentChange change : documentSnapshots.getDocumentChanges()) {
            // Snapshot of the changed document
            DocumentSnapshot snapshot = change.getDocument();

            switch (change.getType()) {
                case ADDED:
                    // TODO: handle document added
                    break;
                case MODIFIED:
                    // TODO: handle document modified
                    break;
                case REMOVED:
                    // TODO: handle document removed
                    break;
            }
        }

        onDataChanged();
    }

  // ...
}

आरंभिक लोड पर श्रोता को प्रत्येक नए दस्तावेज़ के लिए एक ADDED गया ईवेंट प्राप्त होगा। जैसे-जैसे क्वेरी का परिणाम सेट समय के साथ बदलता है, श्रोता को परिवर्तनों वाले अधिक ईवेंट प्राप्त होंगे। अब श्रोता को लागू करना समाप्त करते हैं। पहले तीन नई विधियाँ जोड़ें: onDocumentAdded , onDocumentModified , और onDocumentRemoved :

    protected void onDocumentAdded(DocumentChange change) {
        mSnapshots.add(change.getNewIndex(), change.getDocument());
        notifyItemInserted(change.getNewIndex());
    }

    protected void onDocumentModified(DocumentChange change) {
        if (change.getOldIndex() == change.getNewIndex()) {
            // Item changed but remained in same position
            mSnapshots.set(change.getOldIndex(), change.getDocument());
            notifyItemChanged(change.getOldIndex());
        } else {
            // Item changed and changed position
            mSnapshots.remove(change.getOldIndex());
            mSnapshots.add(change.getNewIndex(), change.getDocument());
            notifyItemMoved(change.getOldIndex(), change.getNewIndex());
        }
    }

    protected void onDocumentRemoved(DocumentChange change) {
        mSnapshots.remove(change.getOldIndex());
        notifyItemRemoved(change.getOldIndex());
    }

फिर इन नए तरीकों को onEvent से कॉल करें:

    @Override
    public void onEvent(QuerySnapshot documentSnapshots,
                        FirebaseFirestoreException e) {

        // ...

        // Dispatch the event
        for (DocumentChange change : documentSnapshots.getDocumentChanges()) {
            // Snapshot of the changed document
            DocumentSnapshot snapshot = change.getDocument();

            switch (change.getType()) {
                case ADDED:
                    onDocumentAdded(change); // Add this line
                    break;
                case MODIFIED:
                    onDocumentModified(change); // Add this line
                    break;
                case REMOVED:
                    onDocumentRemoved(change); // Add this line
                    break;
            }
        }

        onDataChanged();
    }

श्रोता को जोड़ने के लिए अंत में startListening() विधि लागू करें:

    public void startListening() {
        if (mQuery != null && mRegistration == null) {
            mRegistration = mQuery.addSnapshotListener(this);
        }
    }

अब ऐप फायरस्टोर से डेटा पढ़ने के लिए पूरी तरह से कॉन्फ़िगर किया गया है। ऐप को फिर से चलाएं और आपको पिछले चरण में आपके द्वारा जोड़े गए रेस्तरां को देखना चाहिए:

9e45f40faefce5d0.png

अब अपने ब्राउज़र में एम्यूलेटर यूआई पर वापस जाएं और रेस्तरां के नामों में से किसी एक को संपादित करें। आपको इसे ऐप में लगभग तुरंत बदलते देखना चाहिए!

8. डेटा को सॉर्ट और फ़िल्टर करें

ऐप वर्तमान में पूरे संग्रह में टॉप-रेटेड रेस्तरां प्रदर्शित करता है, लेकिन एक वास्तविक रेस्तरां ऐप में उपयोगकर्ता डेटा को सॉर्ट और फ़िल्टर करना चाहता है। उदाहरण के लिए ऐप "फिलाडेल्फिया में शीर्ष समुद्री भोजन रेस्तरां" या "कम से कम महंगा पिज्जा" दिखाने में सक्षम होना चाहिए।

ऐप के शीर्ष पर सफेद पट्टी पर क्लिक करने से एक फिल्टर संवाद सामने आता है। इस खंड में हम इस संवाद को काम करने के लिए फायरस्टोर प्रश्नों का उपयोग करेंगे:

67898572ए35672ए5.पीएनजी

आइए MainActivity.java की MainActivity.java onFilter() विधि को संपादित करें। यह विधि एक Filters ऑब्जेक्ट को स्वीकार करती है जो एक सहायक ऑब्जेक्ट है जिसे हमने फ़िल्टर डायलॉग के आउटपुट को कैप्चर करने के लिए बनाया है। फ़िल्टर से क्वेरी बनाने के लिए हम इस विधि को बदल देंगे:

    @Override
    public void onFilter(Filters filters) {
        // Construct basic query
        Query query = mFirestore.collection("restaurants");

        // Category (equality filter)
        if (filters.hasCategory()) {
            query = query.whereEqualTo("category", filters.getCategory());
        }

        // City (equality filter)
        if (filters.hasCity()) {
            query = query.whereEqualTo("city", filters.getCity());
        }

        // Price (equality filter)
        if (filters.hasPrice()) {
            query = query.whereEqualTo("price", filters.getPrice());
        }

        // Sort by (orderBy with direction)
        if (filters.hasSortBy()) {
            query = query.orderBy(filters.getSortBy(), filters.getSortDirection());
        }

        // Limit items
        query = query.limit(LIMIT);

        // Update the query
        mQuery = query;
        mAdapter.setQuery(query);

        // Set header
        mCurrentSearchView.setText(Html.fromHtml(filters.getSearchDescription(this)));
        mCurrentSortByView.setText(filters.getOrderDescription(this));

        // Save filters
        mViewModel.setFilters(filters);
    }

ऊपर दिए गए स्निपेट में हम दिए गए फ़िल्टर से मेल खाने के लिए where और orderBy द्वारा क्लॉज जोड़कर एक Query ऑब्जेक्ट बनाते हैं।

ऐप को फिर से चलाएं और सबसे लोकप्रिय कम कीमत वाले रेस्तरां दिखाने के लिए निम्न फ़िल्टर का चयन करें:

7a67a8a400c80c50.png

अब आपको केवल कम कीमत वाले विकल्पों वाले रेस्तरां की फ़िल्टर्ड सूची देखनी चाहिए:

a670188398c3c59.png

यदि आपने इसे अब तक बना लिया है, तो आपने अब फायरस्टोर पर पूरी तरह से काम कर रहे रेस्तरां की सिफारिश देखने वाला ऐप बना लिया है! अब आप वास्तविक समय में रेस्तरां को सॉर्ट और फ़िल्टर कर सकते हैं। अगले कुछ अनुभागों में हम रेस्तरां में समीक्षाएँ जोड़ेंगे और ऐप में सुरक्षा नियम जोड़ेंगे।

9. उपसंग्रह में डेटा व्यवस्थित करें

इस खंड में हम ऐप में रेटिंग जोड़ेंगे ताकि उपयोगकर्ता अपने पसंदीदा (या कम से कम पसंदीदा) रेस्तरां की समीक्षा कर सकें।

संग्रह और उपसंग्रह

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

उप-संग्रह तक पहुँचने के लिए, मूल दस्तावेज़ पर .collection() पर कॉल करें:

CollectionReference subRef = mFirestore.collection("restaurants")
        .document("abc123")
        .collection("ratings");

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

लेन-देन में डेटा लिखना

उचित उपसंग्रह में Rating जोड़ने के लिए केवल .add() को कॉल करने की आवश्यकता होती है, लेकिन हमें नए डेटा को दर्शाने के लिए Restaurant ऑब्जेक्ट की औसत रेटिंग और रेटिंग की संख्या को भी अपडेट करना होगा। यदि हम इन दो परिवर्तनों को करने के लिए अलग-अलग कार्रवाइयों का उपयोग करते हैं तो ऐसी कई दौड़ स्थितियां हैं जिनके परिणामस्वरूप पुराना या गलत डेटा हो सकता है।

यह सुनिश्चित करने के लिए कि रेटिंग ठीक से जोड़ी गई हैं, हम किसी रेस्तरां में रेटिंग जोड़ने के लिए लेनदेन का उपयोग करेंगे। यह लेन-देन कुछ कार्य करेगा:

  • रेस्तरां की वर्तमान रेटिंग पढ़ें और नए की गणना करें
  • उपसंग्रह में रेटिंग जोड़ें
  • रेस्टोरेंट की औसत रेटिंग और रेटिंग की संख्या अपडेट करें

RestaurantDetailActivity.java खोलें और addRating फंक्शन लागू करें:

    private Task<Void> addRating(final DocumentReference restaurantRef,
                                 final Rating rating) {
        // Create reference for new rating, for use inside the transaction
        final DocumentReference ratingRef = restaurantRef.collection("ratings")
                .document();

        // In a transaction, add the new rating and update the aggregate totals
        return mFirestore.runTransaction(new Transaction.Function<Void>() {
            @Override
            public Void apply(Transaction transaction)
                    throws FirebaseFirestoreException {

                Restaurant restaurant = transaction.get(restaurantRef)
                        .toObject(Restaurant.class);

                // Compute new number of ratings
                int newNumRatings = restaurant.getNumRatings() + 1;

                // Compute new average rating
                double oldRatingTotal = restaurant.getAvgRating() *
                        restaurant.getNumRatings();
                double newAvgRating = (oldRatingTotal + rating.getRating()) /
                        newNumRatings;

                // Set new restaurant info
                restaurant.setNumRatings(newNumRatings);
                restaurant.setAvgRating(newAvgRating);

                // Commit to Firestore
                transaction.set(restaurantRef, restaurant);
                transaction.set(ratingRef, rating);

                return null;
            }
        });
    }

addRating() फ़ंक्शन पूरे लेनदेन का प्रतिनिधित्व करने वाला एक Task देता है। लेन-देन के परिणाम का जवाब देने के लिए onRating() फ़ंक्शन श्रोताओं को कार्य में जोड़ा जाता है।

अब ऐप को फिर से चलाएं और किसी एक रेस्तरां पर क्लिक करें, जो रेस्टोरेंट की डिटेल स्क्रीन को सामने लाएगा। समीक्षा जोड़ना शुरू करने के लिए + बटन पर क्लिक करें। कई सितारों को चुनकर और कुछ टेक्स्ट दर्ज करके एक समीक्षा जोड़ें।

78fa16cdf8ef435a.png

सबमिट करने से लेनदेन शुरू हो जाएगा। जब लेन-देन पूरा हो जाता है, तो आप अपनी समीक्षा नीचे प्रदर्शित और रेस्तरां की समीक्षा गणना के लिए एक अपडेट देखेंगे:

f9e670f40bd615b0.png

बधाई! अब आपके पास Cloud Firestore पर निर्मित एक सामाजिक, स्थानीय, मोबाइल रेस्तरां समीक्षा ऐप है। मैंने सुना है कि वे इन दिनों बहुत लोकप्रिय हैं।

10. अपना डेटा सुरक्षित करें

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

firestore.rules फ़ाइल खोलें, आपको निम्नलिखित देखना चाहिए:

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    match /{document=**} {
      //
      // WARNING: These rules are insecure! We will replace them with
      // more secure rules later in the codelab
      //
      allow read, write: if request.auth != null;
    }
  }
}

आइए अवांछित डेटा एक्सेस या परिवर्तनों को रोकने के लिए इन नियमों को बदलें, firestore.rules फ़ाइल खोलें और सामग्री को निम्नलिखित से बदलें:

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    // Determine if the value of the field "key" is the same
    // before and after the request.
    function isUnchanged(key) {
      return (key in resource.data)
        && (key in request.resource.data)
        && (resource.data[key] == request.resource.data[key]);
    }

    // Restaurants
    match /restaurants/{restaurantId} {
      // Any signed-in user can read
      allow read: if request.auth != null;

      // Any signed-in user can create
      // WARNING: this rule is for demo purposes only!
      allow create: if request.auth != null;

      // Updates are allowed if no fields are added and name is unchanged
      allow update: if request.auth != null
                    && (request.resource.data.keys() == resource.data.keys())
                    && isUnchanged("name");

      // Deletes are not allowed.
      // Note: this is the default, there is no need to explicitly state this.
      allow delete: if false;

      // Ratings
      match /ratings/{ratingId} {
        // Any signed-in user can read
        allow read: if request.auth != null;

        // Any signed-in user can create if their uid matches the document
        allow create: if request.auth != null
                      && request.resource.data.userId == request.auth.uid;

        // Deletes and updates are not allowed (default)
        allow update, delete: if false;
      }
    }
  }
}

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

सुरक्षा नियमों के बारे में अधिक पढ़ने के लिए, दस्तावेज़ीकरण पर जाएँ।

11. निष्कर्ष

आपने अब Firestore के शीर्ष पर एक पूर्ण-विशेषताओं वाला ऐप बना लिया है। आपने सबसे महत्वपूर्ण Firestore सुविधाओं के बारे में सीखा, जिनमें शामिल हैं:

  • दस्तावेज़ और संग्रह
  • डेटा पढ़ना और लिखना
  • प्रश्नों के साथ छँटाई और छानना
  • उपसंग्रह
  • लेनदेन

और अधिक जानें

Firestore के बारे में सीखते रहने के लिए, आरंभ करने के लिए यहां कुछ अच्छी जगहें दी गई हैं:

इस कोडलैब में रेस्तरां ऐप "फ्रेंडली ईट्स" उदाहरण एप्लिकेशन पर आधारित था। आप यहां उस ऐप के लिए सोर्स कोड ब्राउज़ कर सकते हैं।

वैकल्पिक: उत्पादन के लिए तैनात करें

अभी तक इस ऐप ने केवल Firebase Emulator Suite का ही इस्तेमाल किया है। यदि आप सीखना चाहते हैं कि इस ऐप को वास्तविक फायरबेस प्रोजेक्ट में कैसे परिनियोजित किया जाए, तो अगले चरण पर जारी रखें।

12. (वैकल्पिक) अपना ऐप तैनात करें

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

फायरबेस प्रमाणीकरण

फायरबेस कंसोल में ऑथेंटिकेशन सेक्शन में जाएं और गेट स्टार्ट पर क्लिक करें। साइन-इन विधि टैब पर नेविगेट करें और मूल प्रदाताओं से ईमेल/पासवर्ड विकल्प चुनें।

ईमेल/पासवर्ड साइन-इन विधि सक्षम करें और सहेजें पर क्लिक करें।

साइन-इन-प्रदाताओं.png

इस firestore

डेटाबेस बनाएं

कंसोल के फायरस्टोर डेटाबेस सेक्शन में नेविगेट करें और क्रिएट डेटाबेस पर क्लिक करें:

  1. सुरक्षा नियमों के बारे में पूछे जाने पर प्रोडक्शन मोड में शुरू करना चुनें, हम जल्द ही उन नियमों को अपडेट करेंगे।
  2. डेटाबेस स्थान चुनें जिसे आप अपने ऐप के लिए उपयोग करना चाहते हैं। ध्यान दें कि डेटाबेस स्थान का चयन एक स्थायी निर्णय है और इसे बदलने के लिए आपको एक नया प्रोजेक्ट बनाना होगा। प्रोजेक्ट स्थान चुनने के बारे में अधिक जानकारी के लिए, दस्तावेज़ीकरण देखें।

नियम तैनात करें

आपके द्वारा पहले लिखे गए सुरक्षा नियमों को लागू करने के लिए, कोडलैब निर्देशिका में निम्न आदेश चलाएँ:

$ firebase deploy --only firestore:rules

यह आपके प्रोजेक्ट में firestore.rules की सामग्री को परिनियोजित करेगा, जिसकी पुष्टि आप कंसोल में नियम टैब पर नेविगेट करके कर सकते हैं।

अनुक्रमणिका तैनात करें

FriendlyEats ऐप में जटिल सॉर्टिंग और फ़िल्टरिंग है जिसके लिए कई कस्टम कंपाउंड इंडेक्स की आवश्यकता होती है। इन्हें Firebase कंसोल में हाथ से बनाया जा सकता है लेकिन उनकी परिभाषा को firestore.indexes.json फ़ाइल में लिखना और Firebase CLI का उपयोग करके उन्हें परिनियोजित करना आसान है।

यदि आप firestore.indexes.json फ़ाइल खोलते हैं तो आप देखेंगे कि आवश्यक अनुक्रमणिका पहले ही प्रदान की जा चुकी हैं:

{
  "indexes": [
    {
      "collectionId": "restaurants",
      "queryScope": "COLLECTION",
      "fields": [
        { "fieldPath": "city", "mode": "ASCENDING" },
        { "fieldPath": "avgRating", "mode": "DESCENDING" }
      ]
    },
    {
      "collectionId": "restaurants",
      "queryScope": "COLLECTION",
      "fields": [
        { "fieldPath": "category", "mode": "ASCENDING" },
        { "fieldPath": "avgRating", "mode": "DESCENDING" }
      ]
    },
    {
      "collectionId": "restaurants",
      "queryScope": "COLLECTION",
      "fields": [
        { "fieldPath": "price", "mode": "ASCENDING" },
        { "fieldPath": "avgRating", "mode": "DESCENDING" }
      ]
    },
    {
      "collectionId": "restaurants",
      "queryScope": "COLLECTION",
      "fields": [
        { "fieldPath": "city", "mode": "ASCENDING" },
        { "fieldPath": "numRatings", "mode": "DESCENDING" }
      ]
    },
    {
      "collectionId": "restaurants",
      "queryScope": "COLLECTION",
      "fields": [
        { "fieldPath": "category", "mode": "ASCENDING" },
        { "fieldPath": "numRatings", "mode": "DESCENDING" }
      ]
    },
    {
      "collectionId": "restaurants",
      "queryScope": "COLLECTION",
      "fields": [
        { "fieldPath": "price", "mode": "ASCENDING" },
        { "fieldPath": "numRatings", "mode": "DESCENDING" }
      ]
    },
    {
      "collectionId": "restaurants",
      "queryScope": "COLLECTION",
      "fields": [
        { "fieldPath": "city", "mode": "ASCENDING" },
        { "fieldPath": "price", "mode": "ASCENDING" }
      ]
    },
    {
      "collectionId": "restaurants",
      "fields": [
        { "fieldPath": "category", "mode": "ASCENDING" },
        { "fieldPath": "price", "mode": "ASCENDING" }
      ]
    }
  ],
  "fieldOverrides": []
}

इन अनुक्रमणिकाओं को परिनियोजित करने के लिए निम्न आदेश चलाएँ:

$ firebase deploy --only firestore:indexes

ध्यान दें कि अनुक्रमणिका निर्माण तात्कालिक नहीं है, आप फ़ायरबेस कंसोल में प्रगति की निगरानी कर सकते हैं।

ऐप को कॉन्फ़िगर करें

FirebaseUtil क्लास में हमने डिबग मोड में एमुलेटर से कनेक्ट करने के लिए फायरबेस एसडीके को कॉन्फ़िगर किया है:

public class FirebaseUtil {

    /** Use emulators only in debug builds **/
    private static final boolean sUseEmulators = BuildConfig.DEBUG;

    // ...
}

यदि आप अपने वास्तविक फायरबेस प्रोजेक्ट के साथ अपने ऐप का परीक्षण करना चाहते हैं तो आप या तो कर सकते हैं:

  1. ऐप को रिलीज़ मोड में बनाएं और इसे डिवाइस पर चलाएं।
  2. अस्थायी रूप से sUseEmulators को false में बदलें और ऐप को फिर से चलाएं।

ध्यान दें कि प्रोडक्शन से ठीक से जुड़ने के लिए आपको ऐप से साइन आउट और फिर से साइन इन करने की आवश्यकता हो सकती है।