Dostęp do danych w trybie offline

Cloud Firestore obsługuje trwałość danych offline. Ta funkcja buforuje kopię danych Cloud Firestore, z których aktywnie korzysta Twoja aplikacja, dzięki czemu aplikacja może uzyskiwać dostęp do danych, gdy urządzenie jest w trybie offline. Możesz pisać, czytać, słuchać i wysyłać zapytania do danych w pamięci podręcznej. Gdy urządzenie wróci do trybu online, Cloud Firestore synchronizuje wszelkie lokalne zmiany wprowadzone przez Twoją aplikację z backendem Cloud Firestore.

Aby korzystać z trwałości offline, nie musisz wprowadzać żadnych zmian w kodzie, którego używasz do uzyskiwania dostępu do danych Cloud Firestore. Po włączeniu trwałości offline biblioteka klienta Cloud Firestore automatycznie zarządza dostępem do danych online i offline oraz synchronizuje dane lokalne, gdy urządzenie jest ponownie online.

Skonfiguruj trwałość offline

Podczas inicjowania Cloud Firestore możesz włączyć lub wyłączyć trwałość w trybie offline:

  • Na platformach Android i Apple trwałość w trybie offline jest domyślnie włączona. Aby wyłączyć trwałość, ustaw opcję PersistenceEnabled na false .
  • W przypadku sieci Web trwałość w trybie offline jest domyślnie wyłączona. Aby włączyć trwałość, wywołaj metodę enablePersistence . Pamięć podręczna Cloud Firestore nie jest automatycznie czyszczona między sesjami. W związku z tym, jeśli Twoja aplikacja internetowa obsługuje poufne informacje, przed włączeniem trwałości zapytaj użytkownika, czy korzysta z zaufanego urządzenia.

Web version 9

import { enableIndexedDbPersistence } from "firebase/firestore"; 

enableIndexedDbPersistence(db)
  .catch((err) => {
      if (err.code == 'failed-precondition') {
          // Multiple tabs open, persistence can only be enabled
          // in one tab at a a time.
          // ...
      } else if (err.code == 'unimplemented') {
          // The current browser does not support all of the
          // features required to enable persistence
          // ...
      }
  });
// Subsequent queries will use persistence, if it was enabled successfully
initialize_persistence.js

Web version 8

firebase.firestore().enablePersistence()
  .catch((err) => {
      if (err.code == 'failed-precondition') {
          // Multiple tabs open, persistence can only be enabled
          // in one tab at a a time.
          // ...
      } else if (err.code == 'unimplemented') {
          // The current browser does not support all of the
          // features required to enable persistence
          // ...
      }
  });
// Subsequent queries will use persistence, if it was enabled successfully
test.firestore.js
Szybki
Uwaga: ten produkt nie jest dostępny w systemach docelowych watchOS i App Clip.
let settings = FirestoreSettings()
settings.isPersistenceEnabled = true

// Any additional options
// ...

// Enable offline data persistence
let db = Firestore.firestore()
db.settings = settings
ViewController.swift
Cel C
Uwaga: ten produkt nie jest dostępny w systemach docelowych watchOS i App Clip.
FIRFirestoreSettings *settings = [[FIRFirestoreSettings alloc] init];
settings.persistenceEnabled = YES;

// Any additional options
// ...

// Enable offline data persistence
FIRFirestore *db = [FIRFirestore firestore];
db.settings = settings;
ViewController.m

Java

FirebaseFirestoreSettings settings = new FirebaseFirestoreSettings.Builder()
        .setPersistenceEnabled(true)
        .build();
db.setFirestoreSettings(settings);
DocSnippets.java

Kotlin+KTX

val settings = firestoreSettings {
    isPersistenceEnabled = true
}
db.firestoreSettings = settings
DocSnippets.kt

Dart

// Apple and Android
db.settings = const Settings(persistenceEnabled: true);

// Web
await db
    .enablePersistence(const PersistenceSettings(synchronizeTabs: true));
firestore.dart

Skonfiguruj rozmiar pamięci podręcznej

Gdy trwałość jest włączona, Cloud Firestore przechowuje w pamięci podręcznej każdy dokument odebrany z backendu w celu uzyskania dostępu w trybie offline. Cloud Firestore ustawia domyślny próg rozmiaru pamięci podręcznej. Po przekroczeniu wartości domyślnej Cloud Firestore okresowo próbuje wyczyścić starsze, nieużywane dokumenty. Możesz skonfigurować inny próg rozmiaru pamięci podręcznej lub całkowicie wyłączyć proces czyszczenia:

Web version 9

import { initializeFirestore, CACHE_SIZE_UNLIMITED } from "firebase/firestore";

const firestoreDb = initializeFirestore(app, {
  cacheSizeBytes: CACHE_SIZE_UNLIMITED
});
fs_setup_cache.js

Web version 8

firebase.firestore().settings({
    cacheSizeBytes: firebase.firestore.CACHE_SIZE_UNLIMITED
});
test.firestore.js
Szybki
Uwaga: ten produkt nie jest dostępny w systemach docelowych watchOS i App Clip.
// The default cache size threshold is 100 MB. Configure "cacheSizeBytes"
// for a different threshold (minimum 1 MB) or set to "FirestoreCacheSizeUnlimited"
// to disable clean-up.
let settings = Firestore.firestore().settings
settings.cacheSizeBytes = FirestoreCacheSizeUnlimited
Firestore.firestore().settings = settings
ViewController.swift
Cel C
Uwaga: ten produkt nie jest dostępny w systemach docelowych watchOS i App Clip.
// The default cache size threshold is 100 MB. Configure "cacheSizeBytes"
// for a different threshold (minimum 1 MB) or set to "kFIRFirestoreCacheSizeUnlimited"
// to disable clean-up.
FIRFirestoreSettings *settings = [FIRFirestore firestore].settings;
settings.cacheSizeBytes = kFIRFirestoreCacheSizeUnlimited;
[FIRFirestore firestore].settings = settings;
ViewController.m

Java


// The default cache size threshold is 100 MB. Configure "setCacheSizeBytes"
// for a different threshold (minimum 1 MB) or set to "CACHE_SIZE_UNLIMITED"
// to disable clean-up.
FirebaseFirestoreSettings settings = new FirebaseFirestoreSettings.Builder()
        .setCacheSizeBytes(FirebaseFirestoreSettings.CACHE_SIZE_UNLIMITED)
        .build();
db.setFirestoreSettings(settings);

Kotlin+KTX


// The default cache size threshold is 100 MB. Configure "setCacheSizeBytes"
// for a different threshold (minimum 1 MB) or set to "CACHE_SIZE_UNLIMITED"
// to disable clean-up.
val settings = FirebaseFirestoreSettings.Builder()
        .setCacheSizeBytes(FirebaseFirestoreSettings.CACHE_SIZE_UNLIMITED)
        .build()
db.firestoreSettings = settings

Dart

db.settings = const Settings(
  persistenceEnabled: true,
  cacheSizeBytes: Settings.CACHE_SIZE_UNLIMITED,
);
firestore.dart

Słuchaj danych offline

Gdy urządzenie jest w trybie offline, jeśli włączono trwałość w trybie offline, słuchacze będą otrzymywać zdarzenia nasłuchiwania, gdy zmienią się dane w pamięci podręcznej lokalnie. Możesz słuchać dokumentów, kolekcji i zapytań.

Aby sprawdzić, czy otrzymujesz dane z serwera, czy z pamięci podręcznej, użyj właściwości fromCache w SnapshotMetadata w zdarzeniu migawki. Jeśli fromCache ma wartość true , dane pochodzą z pamięci podręcznej i mogą być nieaktualne lub niekompletne. Jeśli fromCache ma wartość false , dane są kompletne i aktualne z najnowszymi aktualizacjami na serwerze.

Domyślnie żadne zdarzenie nie jest wywoływane, jeśli zmieniono tylko SnapshotMetadata . Jeśli polegasz na wartościach fromCache , określ opcję nasłuchiwania includeMetadataChanges podczas dołączania procedury obsługi nasłuchiwania.

Web version 9

import { collection, onSnapshot, where, query } from "firebase/firestore"; 

const q = query(collection(db, "cities"), where("state", "==", "CA"));
onSnapshot(q, { includeMetadataChanges: true }, (snapshot) => {
    snapshot.docChanges().forEach((change) => {
        if (change.type === "added") {
            console.log("New city: ", change.doc.data());
        }

        const source = snapshot.metadata.fromCache ? "local cache" : "server";
        console.log("Data came from " + source);
    });
});
use_from_cache.js

Web version 8

db.collection("cities").where("state", "==", "CA")
  .onSnapshot({ includeMetadataChanges: true }, (snapshot) => {
      snapshot.docChanges().forEach((change) => {
          if (change.type === "added") {
              console.log("New city: ", change.doc.data());
          }

          var source = snapshot.metadata.fromCache ? "local cache" : "server";
          console.log("Data came from " + source);
      });
  });
test.firestore.js
Szybki
Uwaga: ten produkt nie jest dostępny w systemach docelowych watchOS i App Clip.
// Listen to metadata updates to receive a server snapshot even if
// the data is the same as the cached data.
db.collection("cities").whereField("state", isEqualTo: "CA")
    .addSnapshotListener(includeMetadataChanges: true) { querySnapshot, error in
        guard let snapshot = querySnapshot else {
            print("Error retreiving snapshot: \(error!)")
            return
        }

        for diff in snapshot.documentChanges {
            if diff.type == .added {
                print("New city: \(diff.document.data())")
            }
        }

        let source = snapshot.metadata.isFromCache ? "local cache" : "server"
        print("Metadata: Data fetched from \(source)")
}
ViewController.swift
Cel C
Uwaga: ten produkt nie jest dostępny w systemach docelowych watchOS i App Clip.
// Listen to metadata updates to receive a server snapshot even if
// the data is the same as the cached data.
[[[db collectionWithPath:@"cities"] queryWhereField:@"state" isEqualTo:@"CA"]
    addSnapshotListenerWithIncludeMetadataChanges:YES
    listener:^(FIRQuerySnapshot *snapshot, NSError *error) {
      if (snapshot == nil) {
        NSLog(@"Error retreiving snapshot: %@", error);
        return;
      }
      for (FIRDocumentChange *diff in snapshot.documentChanges) {
        if (diff.type == FIRDocumentChangeTypeAdded) {
          NSLog(@"New city: %@", diff.document.data);
        }
      }

      NSString *source = snapshot.metadata.isFromCache ? @"local cache" : @"server";
      NSLog(@"Metadata: Data fetched from %@", source);
    }];
ViewController.m

Java

db.collection("cities").whereEqualTo("state", "CA")
        .addSnapshotListener(MetadataChanges.INCLUDE, new EventListener<QuerySnapshot>() {
            @Override
            public void onEvent(@Nullable QuerySnapshot querySnapshot,
                                @Nullable FirebaseFirestoreException e) {
                if (e != null) {
                    Log.w(TAG, "Listen error", e);
                    return;
                }

                for (DocumentChange change : querySnapshot.getDocumentChanges()) {
                    if (change.getType() == Type.ADDED) {
                        Log.d(TAG, "New city:" + change.getDocument().getData());
                    }

                    String source = querySnapshot.getMetadata().isFromCache() ?
                            "local cache" : "server";
                    Log.d(TAG, "Data fetched from " + source);
                }

            }
        });
DocSnippets.java

Kotlin+KTX

db.collection("cities").whereEqualTo("state", "CA")
        .addSnapshotListener(MetadataChanges.INCLUDE) { querySnapshot, e ->
            if (e != null) {
                Log.w(TAG, "Listen error", e)
                return@addSnapshotListener
            }

            for (change in querySnapshot!!.documentChanges) {
                if (change.type == DocumentChange.Type.ADDED) {
                    Log.d(TAG, "New city: ${change.document.data}")
                }

                val source = if (querySnapshot.metadata.isFromCache)
                    "local cache"
                else
                    "server"
                Log.d(TAG, "Data fetched from $source")
            }
        }
DocSnippets.kt

Dart

db
    .collection("cities")
    .where("state", isEqualTo: "CA")
    .snapshots(includeMetadataChanges: true)
    .listen((querySnapshot) {
  for (var change in querySnapshot.docChanges) {
    if (change.type == DocumentChangeType.added) {
      final source =
          (querySnapshot.metadata.isFromCache) ? "local cache" : "server";

      print("Data fetched from $source}");
    }
  }
});
firestore.dart

Uzyskaj dane offline

Jeśli otrzymasz dokument, gdy urządzenie jest w trybie offline, Cloud Firestore zwróci dane z pamięci podręcznej.

Podczas wykonywania zapytania dotyczącego kolekcji zwracany jest pusty wynik, jeśli nie ma dokumentów w pamięci podręcznej. Podczas pobierania określonego dokumentu zamiast tego zwracany jest błąd.

Zapytanie o dane offline

Zapytania działają z trwałością w trybie offline. Wyniki zapytań można pobrać za pomocą bezpośredniego pobierania lub nasłuchiwania, zgodnie z opisem w poprzednich sekcjach. Możesz również tworzyć nowe zapytania dotyczące danych utrwalonych lokalnie, gdy urządzenie jest w trybie offline, ale zapytania będą początkowo uruchamiane tylko w odniesieniu do dokumentów z pamięci podręcznej.

Wyłącz i włącz dostęp do sieci

Możesz użyć poniższej metody, aby wyłączyć dostęp do sieci dla swojego klienta Cloud Firestore. Gdy dostęp do sieci jest wyłączony, wszystkie detektory migawek i żądania dokumentów pobierają wyniki z pamięci podręcznej. Operacje zapisu są umieszczane w kolejce do momentu ponownego włączenia dostępu do sieci.

Web version 9

import { disableNetwork } from "firebase/firestore"; 

await disableNetwork(db);
console.log("Network disabled!");
// Do offline actions
// ...
disable_network.js

Web version 8

firebase.firestore().disableNetwork()
    .then(() => {
        // Do offline actions
        // ...
    });
test.firestore.js
Szybki
Uwaga: ten produkt nie jest dostępny w systemach docelowych watchOS i App Clip.
Firestore.firestore().disableNetwork { (error) in
    // Do offline things
    // ...
}
ViewController.swift
Cel C
Uwaga: ten produkt nie jest dostępny w systemach docelowych watchOS i App Clip.
[[FIRFirestore firestore] disableNetworkWithCompletion:^(NSError *_Nullable error) {
  // Do offline actions
  // ...
}];
ViewController.m

Java

db.disableNetwork()
        .addOnCompleteListener(new OnCompleteListener<Void>() {
            @Override
            public void onComplete(@NonNull Task<Void> task) {
                // Do offline things
                // ...
            }
        });
DocSnippets.java

Kotlin+KTX

db.disableNetwork().addOnCompleteListener {
    // Do offline things
    // ...
}
DocSnippets.kt

Dart

db.disableNetwork().then((_) {
  // Do offline things
});
firestore.dart

Użyj następującej metody, aby ponownie włączyć dostęp do sieci:

Web version 9

import { enableNetwork } from "firebase/firestore"; 

await enableNetwork(db);
// Do online actions
// ...
enable_network.js

Web version 8

firebase.firestore().enableNetwork()
    .then(() => {
        // Do online actions
        // ...
    });
test.firestore.js
Szybki
Uwaga: ten produkt nie jest dostępny w systemach docelowych watchOS i App Clip.
Firestore.firestore().enableNetwork { (error) in
    // Do online things
    // ...
}
ViewController.swift
Cel C
Uwaga: ten produkt nie jest dostępny w systemach docelowych watchOS i App Clip.
[[FIRFirestore firestore] enableNetworkWithCompletion:^(NSError *_Nullable error) {
  // Do online actions
  // ...
}];
ViewController.m

Java

db.enableNetwork()
        .addOnCompleteListener(new OnCompleteListener<Void>() {
            @Override
            public void onComplete(@NonNull Task<Void> task) {
                // Do online things
                // ...
            }
        });
DocSnippets.java

Kotlin+KTX

db.enableNetwork().addOnCompleteListener {
    // Do online things
    // ...
}
DocSnippets.kt

Dart

db.enableNetwork().then((_) {
  // Back online
});
firestore.dart