कई ऐप्स में ऐसे दस्तावेज़ होते हैं जो भौतिक स्थानों द्वारा अनुक्रमित होते हैं। उदाहरण के लिए, आपका ऐप उपयोगकर्ताओं को उनके वर्तमान स्थान के निकट स्टोर ब्राउज़ करने की अनुमति दे सकता है।
क्लाउड फायरस्टोर प्रति कंपाउंड क्वेरी केवल एक रेंज क्लॉज की अनुमति देता है, जिसका अर्थ है कि हम केवल अक्षांश और देशांतर को अलग-अलग फ़ील्ड के रूप में संग्रहीत करके और एक बाउंडिंग बॉक्स पर क्वेरी करके जियो क्वेरी नहीं कर सकते हैं।
समाधान: जियोहैश
जियोहैश एक एकल बेस32 स्ट्रिंग में (latitude, longitude)
जोड़ी को एन्कोड करने की एक प्रणाली है। जियोहैश प्रणाली में विश्व को एक आयताकार ग्रिड में विभाजित किया गया है। जियोहैश स्ट्रिंग का प्रत्येक वर्ण उपसर्ग हैश के 32 उपविभागों में से एक को निर्दिष्ट करता है। उदाहरण के लिए जियोहैश abcd
32 चार-वर्ण वाले हैशों में से एक है जो पूरी तरह से बड़े जियोहैश abc
में समाहित है।
दो हैश के बीच साझा उपसर्ग जितना लंबा होगा, वे एक-दूसरे के उतने ही करीब होंगे। उदाहरण के लिए abcdef
abcdff
की तुलना में abcdeg
के अधिक निकट है। हालाँकि इसका विपरीत सत्य नहीं है! बहुत भिन्न जियोहैश होने पर भी दो क्षेत्र एक-दूसरे के बहुत करीब हो सकते हैं:
हम उचित दक्षता के साथ क्लाउड फायरस्टोर में स्थिति के अनुसार दस्तावेजों को संग्रहीत और क्वेरी करने के लिए जियोहैश का उपयोग कर सकते हैं, जबकि केवल एक अनुक्रमित फ़ील्ड की आवश्यकता होती है।
सहायक लाइब्रेरी स्थापित करें
जियोहैश बनाने और पार्स करने में कुछ पेचीदा गणित शामिल है, इसलिए हमने एंड्रॉइड, ऐप्पल और वेब पर सबसे कठिन हिस्सों को सारगर्भित करने के लिए सहायक लाइब्रेरी बनाई हैं:
वेब मॉड्यूलर एपीआई
// Install from NPM. If you prefer to use a static .js file visit
// https://github.com/firebase/geofire-js/releases and download
// geofire-common.min.js from the latest version
npm install --save geofire-common
वेब नेमस्पेस्ड एपीआई
// Install from NPM. If you prefer to use a static .js file visit
// https://github.com/firebase/geofire-js/releases and download
// geofire-common.min.js from the latest version
npm install --save geofire-common
तीव्र
Kotlin+KTX
// Add this to your app/build.gradle
implementation 'com.firebase:geofire-android-common:3.2.0'
Java
// Add this to your app/build.gradle
implementation 'com.firebase:geofire-android-common:3.1.0'
जियोहैश स्टोर करें
प्रत्येक दस्तावेज़ के लिए जिसे आप स्थान के आधार पर अनुक्रमित करना चाहते हैं, आपको एक जियोहैश फ़ील्ड संग्रहीत करने की आवश्यकता होगी:
वेब मॉड्यूलर एपीआई
import { doc, updateDoc } from 'firebase/firestore'; // Compute the GeoHash for a lat/lng point const lat = 51.5074; const lng = 0.1278; const hash = geofire.geohashForLocation([lat, lng]); // Add the hash and the lat/lng to the document. We will use the hash // for queries and the lat/lng for distance comparisons. const londonRef = doc(db, 'cities', 'LON'); await updateDoc(londonRef, { geohash: hash, lat: lat, lng: lng });
वेब नेमस्पेस्ड एपीआई
// Compute the GeoHash for a lat/lng point const lat = 51.5074; const lng = 0.1278; const hash = geofire.geohashForLocation([lat, lng]); // Add the hash and the lat/lng to the document. We will use the hash // for queries and the lat/lng for distance comparisons. const londonRef = db.collection('cities').doc('LON'); londonRef.update({ geohash: hash, lat: lat, lng: lng }).then(() => { // ... });
तीव्र
// Compute the GeoHash for a lat/lng point let latitude = 51.5074 let longitude = 0.12780 let location = CLLocationCoordinate2D(latitude: latitude, longitude: longitude) let hash = GFUtils.geoHash(forLocation: location) // Add the hash and the lat/lng to the document. We will use the hash // for queries and the lat/lng for distance comparisons. let documentData: [String: Any] = [ "geohash": hash, "lat": latitude, "lng": longitude ] let londonRef = db.collection("cities").document("LON") londonRef.updateData(documentData) { error in // ... }
Kotlin+KTX
// Compute the GeoHash for a lat/lng point val lat = 51.5074 val lng = 0.1278 val hash = GeoFireUtils.getGeoHashForLocation(GeoLocation(lat, lng)) // Add the hash and the lat/lng to the document. We will use the hash // for queries and the lat/lng for distance comparisons. val updates: MutableMap<String, Any> = mutableMapOf( "geohash" to hash, "lat" to lat, "lng" to lng, ) val londonRef = db.collection("cities").document("LON") londonRef.update(updates) .addOnCompleteListener { // ... }
Java
// Compute the GeoHash for a lat/lng point double lat = 51.5074; double lng = 0.1278; String hash = GeoFireUtils.getGeoHashForLocation(new GeoLocation(lat, lng)); // Add the hash and the lat/lng to the document. We will use the hash // for queries and the lat/lng for distance comparisons. Map<String, Object> updates = new HashMap<>(); updates.put("geohash", hash); updates.put("lat", lat); updates.put("lng", lng); DocumentReference londonRef = db.collection("cities").document("LON"); londonRef.update(updates) .addOnCompleteListener(new OnCompleteListener<Void>() { @Override public void onComplete(@NonNull Task<Void> task) { // ... } });
जियोहैश क्वेरी करें
जियोहैश हमें जियोहैश क्षेत्र पर प्रश्नों के एक सेट को जोड़कर और फिर कुछ गलत सकारात्मकताओं को फ़िल्टर करके क्षेत्र के प्रश्नों का अनुमान लगाने की अनुमति देता है:
वेब मॉड्यूलर एपीआई
import { collection, query, orderBy, startAt, endAt, getDocs } from 'firebase/firestore'; // Find cities within 50km of London const center = [51.5074, 0.1278]; const radiusInM = 50 * 1000; // Each item in 'bounds' represents a startAt/endAt pair. We have to issue // a separate query for each pair. There can be up to 9 pairs of bounds // depending on overlap, but in most cases there are 4. const bounds = geofire.geohashQueryBounds(center, radiusInM); const promises = []; for (const b of bounds) { const q = query( collection(db, 'cities'), orderBy('geohash'), startAt(b[0]), endAt(b[1])); promises.push(getDocs(q)); } // Collect all the query results together into a single list const snapshots = await Promise.all(promises); const matchingDocs = []; for (const snap of snapshots) { for (const doc of snap.docs) { const lat = doc.get('lat'); const lng = doc.get('lng'); // We have to filter out a few false positives due to GeoHash // accuracy, but most will match const distanceInKm = geofire.distanceBetween([lat, lng], center); const distanceInM = distanceInKm * 1000; if (distanceInM <= radiusInM) { matchingDocs.push(doc); } } }
वेब नेमस्पेस्ड एपीआई
// Find cities within 50km of London const center = [51.5074, 0.1278]; const radiusInM = 50 * 1000; // Each item in 'bounds' represents a startAt/endAt pair. We have to issue // a separate query for each pair. There can be up to 9 pairs of bounds // depending on overlap, but in most cases there are 4. const bounds = geofire.geohashQueryBounds(center, radiusInM); const promises = []; for (const b of bounds) { const q = db.collection('cities') .orderBy('geohash') .startAt(b[0]) .endAt(b[1]); promises.push(q.get()); } // Collect all the query results together into a single list Promise.all(promises).then((snapshots) => { const matchingDocs = []; for (const snap of snapshots) { for (const doc of snap.docs) { const lat = doc.get('lat'); const lng = doc.get('lng'); // We have to filter out a few false positives due to GeoHash // accuracy, but most will match const distanceInKm = geofire.distanceBetween([lat, lng], center); const distanceInM = distanceInKm * 1000; if (distanceInM <= radiusInM) { matchingDocs.push(doc); } } } return matchingDocs; }).then((matchingDocs) => { // Process the matching documents // ... });
तीव्र
// Find cities within 50km of London let center = CLLocationCoordinate2D(latitude: 51.5074, longitude: 0.1278) let radiusInM: Double = 50 * 1000 // Each item in 'bounds' represents a startAt/endAt pair. We have to issue // a separate query for each pair. There can be up to 9 pairs of bounds // depending on overlap, but in most cases there are 4. let queryBounds = GFUtils.queryBounds(forLocation: center, withRadius: radiusInM) let queries = queryBounds.map { bound -> Query in return db.collection("cities") .order(by: "geohash") .start(at: [bound.startValue]) .end(at: [bound.endValue]) } var matchingDocs = [QueryDocumentSnapshot]() // Collect all the query results together into a single list func getDocumentsCompletion(snapshot: QuerySnapshot?, error: Error?) -> () { guard let documents = snapshot?.documents else { print("Unable to fetch snapshot data. \(String(describing: error))") return } for document in documents { let lat = document.data()["lat"] as? Double ?? 0 let lng = document.data()["lng"] as? Double ?? 0 let coordinates = CLLocation(latitude: lat, longitude: lng) let centerPoint = CLLocation(latitude: center.latitude, longitude: center.longitude) // We have to filter out a few false positives due to GeoHash accuracy, but // most will match let distance = GFUtils.distance(from: centerPoint, to: coordinates) if distance <= radiusInM { matchingDocs.append(document) } } } // After all callbacks have executed, matchingDocs contains the result. Note that this // sample does not demonstrate how to wait on all callbacks to complete. for query in queries { query.getDocuments(completion: getDocumentsCompletion) }
Kotlin+KTX
// Find cities within 50km of London val center = GeoLocation(51.5074, 0.1278) val radiusInM = 50.0 * 1000.0 // Each item in 'bounds' represents a startAt/endAt pair. We have to issue // a separate query for each pair. There can be up to 9 pairs of bounds // depending on overlap, but in most cases there are 4. val bounds = GeoFireUtils.getGeoHashQueryBounds(center, radiusInM) val tasks: MutableList<Task<QuerySnapshot>> = ArrayList() for (b in bounds) { val q = db.collection("cities") .orderBy("geohash") .startAt(b.startHash) .endAt(b.endHash) tasks.add(q.get()) } // Collect all the query results together into a single list Tasks.whenAllComplete(tasks) .addOnCompleteListener { val matchingDocs: MutableList<DocumentSnapshot> = ArrayList() for (task in tasks) { val snap = task.result for (doc in snap!!.documents) { val lat = doc.getDouble("lat")!! val lng = doc.getDouble("lng")!! // We have to filter out a few false positives due to GeoHash // accuracy, but most will match val docLocation = GeoLocation(lat, lng) val distanceInM = GeoFireUtils.getDistanceBetween(docLocation, center) if (distanceInM <= radiusInM) { matchingDocs.add(doc) } } } // matchingDocs contains the results // ... }
Java
// Find cities within 50km of London final GeoLocation center = new GeoLocation(51.5074, 0.1278); final double radiusInM = 50 * 1000; // Each item in 'bounds' represents a startAt/endAt pair. We have to issue // a separate query for each pair. There can be up to 9 pairs of bounds // depending on overlap, but in most cases there are 4. List<GeoQueryBounds> bounds = GeoFireUtils.getGeoHashQueryBounds(center, radiusInM); final List<Task<QuerySnapshot>> tasks = new ArrayList<>(); for (GeoQueryBounds b : bounds) { Query q = db.collection("cities") .orderBy("geohash") .startAt(b.startHash) .endAt(b.endHash); tasks.add(q.get()); } // Collect all the query results together into a single list Tasks.whenAllComplete(tasks) .addOnCompleteListener(new OnCompleteListener<List<Task<?>>>() { @Override public void onComplete(@NonNull Task<List<Task<?>>> t) { List<DocumentSnapshot> matchingDocs = new ArrayList<>(); for (Task<QuerySnapshot> task : tasks) { QuerySnapshot snap = task.getResult(); for (DocumentSnapshot doc : snap.getDocuments()) { double lat = doc.getDouble("lat"); double lng = doc.getDouble("lng"); // We have to filter out a few false positives due to GeoHash // accuracy, but most will match GeoLocation docLocation = new GeoLocation(lat, lng); double distanceInM = GeoFireUtils.getDistanceBetween(docLocation, center); if (distanceInM <= radiusInM) { matchingDocs.add(doc); } } } // matchingDocs contains the results // ... } });
सीमाएँ
स्थानों की पूछताछ के लिए जियोहैश का उपयोग करने से हमें नई क्षमताएं मिलती हैं, लेकिन इसकी अपनी सीमाएं होती हैं:
- झूठी सकारात्मकताएँ - जियोहैश द्वारा पूछताछ सटीक नहीं है, और आपको क्लाइंट पक्ष पर गलत-सकारात्मक परिणामों को फ़िल्टर करना होगा। ये अतिरिक्त रीडिंग आपके ऐप में लागत और विलंबता जोड़ती हैं।
- किनारे के मामले - यह क्वेरी विधि देशांतर/अक्षांश की रेखाओं के बीच की दूरी का अनुमान लगाने पर निर्भर करती है। जैसे-जैसे बिंदु उत्तरी या दक्षिणी ध्रुव के करीब आते जाते हैं, इस अनुमान की सटीकता कम होती जाती है, जिसका अर्थ है कि चरम अक्षांशों पर जियोहैश प्रश्नों में अधिक गलत सकारात्मकताएं होती हैं।