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

संग्रह की मदद से व्यवस्थित रहें अपनी प्राथमिकताओं के आधार पर, कॉन्टेंट को सेव करें और कैटगरी में बांटें.

1 अवलोकन

लक्ष्य

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

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

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

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

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

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

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

9d2f625aebcab6af.png

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

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

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

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

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

अगर आपके पास अपनी मशीन पर गिट नहीं है, तो आप सीधे गिटहब से कोड डाउनलोड कर सकते हैं।

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

  1. Firebase कंसोल में, बाएं नेवी में प्रोजेक्ट ओवरव्यू चुनें। प्लेटफ़ॉर्म का चयन करने के लिए Android बटन पर क्लिक करें। पैकेज नाम के लिए पूछे जाने पर com.google.firebase.example.fireeats का उपयोग करें

73d151ed16016421.png

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

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

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

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

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

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

सबसे पहले आपको Firebase CLI इंस्टॉल करना होगा। यदि आप 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 स्टूडियो में उपयोग util/FirestoreInitializer.kt और util/AuthInitializer.kt फ़ाइलें खोलें। इन फाइलों में एप्लिकेशन स्टार्टअप पर फायरबेस एसडीके को आपकी मशीन पर चल रहे स्थानीय एमुलेटर से जोड़ने का तर्क है।

FirestoreInitializer वर्ग के create() विधि पर, कोड के इस टुकड़े की जाँच करें:

    // Use emulators only in debug builds
    if (BuildConfig.DEBUG) {
        firestore.useEmulator(FIRESTORE_EMULATOR_HOST, FIRESTORE_EMULATOR_PORT)
    }

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

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

एप चलाएं

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

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

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

फायरबेस ऑथ एमुलेटर

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

de06424023ffb4b9.png

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

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

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

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

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

    private fun onAddItemsClicked() {
        val restaurantsRef = firestore.collection("restaurants")
        for (i in 0..9) {
            // Create random restaurant / ratings
            val randomRestaurant = RestaurantUtil.getRandom(requireContext())

            // Add restaurant
            restaurantsRef.add(randomRestaurant)
        }
    }

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

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

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

95691e9b71ba55e3.png

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

फायरबेस ऑथ एमुलेटर

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

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

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

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

        // Firestore
        firestore = Firebase.firestore

        // Get the 50 highest rated restaurants
        query = firestore.collection("restaurants")
            .orderBy("avgRating", Query.Direction.DESCENDING)
            .limit(LIMIT.toLong())

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

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

abstract class FirestoreAdapter<VH : RecyclerView.ViewHolder>(private var query: Query?) :
        RecyclerView.Adapter<VH>(),
        EventListener<QuerySnapshot> { // Add this implements
    
    // ...

    // Add this method
    override fun onEvent(documentSnapshots: QuerySnapshot?, e: FirebaseFirestoreException?) {
        
        // Handle errors
        if (e != null) {
            Log.w(TAG, "onEvent:error", e)
            return
        }

        // Dispatch the event
        if (documentSnapshots != null) {
            for (change in documentSnapshots.documentChanges) {
                // snapshot of the changed document
                when (change.type) {
                    DocumentChange.Type.ADDED -> {
                        // TODO: handle document added
                    }
                    DocumentChange.Type.MODIFIED -> {
                        // TODO: handle document changed
                    }
                    DocumentChange.Type.REMOVED -> {
                        // TODO: handle document removed
                    }
                }
            }
        }

        onDataChanged()
    }
    
    // ...
}

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

    private fun onDocumentAdded(change: DocumentChange) {
        snapshots.add(change.newIndex, change.document)
        notifyItemInserted(change.newIndex)
    }

    private fun onDocumentModified(change: DocumentChange) {
        if (change.oldIndex == change.newIndex) {
            // Item changed but remained in same position
            snapshots[change.oldIndex] = change.document
            notifyItemChanged(change.oldIndex)
        } else {
            // Item changed and changed position
            snapshots.removeAt(change.oldIndex)
            snapshots.add(change.newIndex, change.document)
            notifyItemMoved(change.oldIndex, change.newIndex)
        }
    }

    private fun onDocumentRemoved(change: DocumentChange) {
        snapshots.removeAt(change.oldIndex)
        notifyItemRemoved(change.oldIndex)
    }

फिर इन नई विधियों को onEvent से कॉल करें:

    override fun onEvent(documentSnapshots: QuerySnapshot?, e: FirebaseFirestoreException?) {

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

        // Dispatch the event
        if (documentSnapshots != null) {
            for (change in documentSnapshots.documentChanges) {
                // snapshot of the changed document
                when (change.type) {
                    DocumentChange.Type.ADDED -> {
                        onDocumentAdded(change) // Add this line
                    }
                    DocumentChange.Type.MODIFIED -> {
                        onDocumentModified(change) // Add this line
                    }
                    DocumentChange.Type.REMOVED -> {
                        onDocumentRemoved(change) // Add this line
                    }
                }
            }
        }

        onDataChanged()
    }

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

    fun startListening() {
        if (registration == null) {
            registration = query.addSnapshotListener(this)
        }
    }

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

9e45f40faefce5d0.png

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

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

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

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

67898572a35672a5.png

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

    override fun onFilter(filters: Filters) {
        // Construct query basic query
        var query: Query = firestore.collection("restaurants")

        // Category (equality filter)
        if (filters.hasCategory()) {
            query = query.whereEqualTo(Restaurant.FIELD_CATEGORY, filters.category)
        }

        // City (equality filter)
        if (filters.hasCity()) {
            query = query.whereEqualTo(Restaurant.FIELD_CITY, filters.city)
        }

        // Price (equality filter)
        if (filters.hasPrice()) {
            query = query.whereEqualTo(Restaurant.FIELD_PRICE, filters.price)
        }

        // Sort by (orderBy with direction)
        if (filters.hasSortBy()) {
            query = query.orderBy(filters.sortBy.toString(), filters.sortDirection)
        }

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

        // Update the query
        adapter.setQuery(query)

        // Set header
        binding.textCurrentSearch.text = HtmlCompat.fromHtml(
            filters.getSearchDescription(requireContext()),
            HtmlCompat.FROM_HTML_MODE_LEGACY
        )
        binding.textCurrentSortBy.text = filters.getOrderDescription(requireContext())

        // Save filters
        viewModel.filters = filters
    }

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

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

7a67a8a400c80c50.png

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

a670188398c3c59.png

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

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

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

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

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

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

val subRef = firestore.collection("restaurants")
        .document("abc123")
        .collection("ratings")

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

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

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

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

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

RestaurantDetailFragment.kt खोलें और addRating फ़ंक्शन लागू करें:

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

        // In a transaction, add the new rating and update the aggregate totals
        return firestore.runTransaction { transaction ->
            val restaurant = transaction.get(restaurantRef).toObject<Restaurant>()
                ?: throw Exception("Restaurant not found at ${restaurantRef.path}")

            // Compute new number of ratings
            val newNumRatings = restaurant.numRatings + 1

            // Compute new average rating
            val oldRatingTotal = restaurant.avgRating * restaurant.numRatings
            val newAvgRating = (oldRatingTotal + rating.rating) / newNumRatings

            // Set new restaurant info
            restaurant.numRatings = newNumRatings
            restaurant.avgRating = newAvgRating

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

            null
        }
    }

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

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

78fa16cdf8ef435a.png

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

f9e670f40bd615b0.png

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

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. निष्कर्ष

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

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

और अधिक जानें

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

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

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

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

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

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

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

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

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

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

इस firestore

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

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

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

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

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

$ firebase deploy --only firestore:rules

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

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

फ्रेंडलीईट्स ऐप में जटिल सॉर्टिंग और फ़िल्टरिंग है जिसके लिए कई कस्टम कंपाउंड इंडेक्स की आवश्यकता होती है। इन्हें 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

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

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

उपयोग util/FirestoreInitializer.kt और util/AuthInitializer.kt फ़ाइलों में हमने डिबग मोड में एमुलेटर से कनेक्ट करने के लिए Firebase SDK को कॉन्फ़िगर किया:

    override fun create(context: Context): FirebaseFirestore {
        val firestore = Firebase.firestore
        // Use emulators only in debug builds
        if (BuildConfig.DEBUG) {
            firestore.useEmulator(FIRESTORE_EMULATOR_HOST, FIRESTORE_EMULATOR_PORT)
        }
        return firestore
    }

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

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

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