Cette page a été traduite par l'API Cloud Translation.
Switch to English

Requêtes de données géographiques

De nombreuses applications possèdent des documents indexés par des emplacements physiques. Par exemple, votre application peut permettre aux utilisateurs de parcourir des magasins à proximité de leur emplacement actuel.

Cloud Firestore n'autorise qu'une clause de plage unique par requête composée, ce qui signifie que nous ne pouvons pas effectuer de requêtes de données géographiques en stockant simplement la latitude et la longitude sous la forme de champs séparés, puis en interrogeant un cadre de délimitation.

Solution : Geohashes

Geohash est un système permettant d'encoder une paire (latitude, longitude) en une seule chaîne Base32. Dans le système Geohash, le monde est divisé en une grille rectangulaire. Chaque caractère d'une chaîne Geohash spécifie l'une des 32 subdivisions du hachage de préfixe. Par exemple, le Geohash abcd correspond à l'un des 32 hachages de quatre caractères entièrement contenus dans le Geohash abc plus grand.

Plus le préfixe partagé entre deux hachages est le plus proche, plus ils sont proches l'un de l'autre. Par exemple, abcdef est plus proche de abcdeg que abcdff. Mais l'inverse n'est pas vrai ! Deux zones très proches peuvent être proches l'une de l'autre tout en ayant des Geohashes très différents :

Geohashes éloignés les uns des autres

Vous pouvez utiliser des Geohashes pour stocker et interroger des documents par position dans Firestore avec une efficacité raisonnable, lorsque vous n'avez besoin que d'un champ indexé.

Installer la bibliothèque d'aide

La création et l'analyse de Geohashes impliquent des calculs complexes. Nous avons donc créé des bibliothèques d'aide pour extraire les parties les plus complexes sur Android, iOS et Web :

Web

// 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

Swift

// Add this to your Podfile
pod 'GeoFire/Utils'

Java
Android

// Add this to your app/build.gradle
implementation 'com.firebase:geofire-android-common:3.1.0'

Geohashes de magasins

Pour chaque document que vous souhaitez indexer par emplacement, vous devez stocker un champ Geohash :

Web

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

Swift

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

Java
Android

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

Geohashes de requêtes

Les Geohashes nous permettent d'estimer les requêtes de région en joignant un ensemble de requêtes dans le champ Geohash, puis en filtrant certains faux positifs :

Web

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

Swift

// Find cities within 50km of London
let center = CLLocationCoordinate2D(latitude: 51.5074, longitude: 0.1278)
let radiusInKilometers: Double = 50

// 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: radiusInKilometers)
let queries = queryBounds.compactMap { (any) -> Query? in
    guard let bound = any as? GFGeoQueryBounds else { return nil }
    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 <= radiusInKilometers {
            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)
}

Java
Android

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

Limites

L'utilisation de Geohashes pour les requêtes d'emplacements offre de nouvelles fonctionnalités, mais présente ses propres limites :

  • Faux positifs : l'interrogation par Geohash n'est pas exacte et vous devez filtrer les résultats faux positifs côté client. Ces lectures supplémentaires augmentent les coûts et la latence de votre application.
  • Cas d'utilisation : cette méthode de requête repose sur l'estimation de la distance entre les lignes de longitude/latitude. La précision de cette estimation diminue à mesure que les points se rapprochent du pôle Nord ou du pôle Sud, ce qui signifie que les requêtes Geohash ont davantage de faux positifs à des latitudes extrêmes.