Эта страница переведена с помощью Cloud Translation API.

Доступ к данным в автономном режиме

Cloud Firestore поддерживает сохранение данных в автономном режиме. Эта функция кэширует копию данных Cloud Firestore, которые активно использует ваше приложение, поэтому ваше приложение может получить доступ к данным, когда устройство находится в автономном режиме. Вы можете писать, читать, слушать и запрашивать кэшированные данные. Когда устройство возвращается в сеть, Cloud Firestore синхронизирует любые локальные изменения, сделанные вашим приложением, с серверной частью Cloud Firestore.

Чтобы использовать сохранение в автономном режиме, вам не нужно вносить какие-либо изменения в код, который вы используете для доступа к данным Cloud Firestore. При включенном сохранении в автономном режиме клиентская библиотека Cloud Firestore автоматически управляет онлайн- и офлайн-доступом к данным и синхронизирует локальные данные, когда устройство снова подключается к сети.

Настроить сохранение в автономном режиме

Когда вы инициализируете Cloud Firestore, вы можете включить или отключить автономное сохранение:

Для платформ Android и Apple автономное сохранение включено по умолчанию. Чтобы отключить сохраняемость, установите для параметра PersistenceEnabled значение false .
Для Интернета автономное сохранение отключено по умолчанию. Чтобы включить сохраняемость, вызовите метод enablePersistence . Кэш Cloud Firestore не очищается автоматически между сеансами. Следовательно, если ваше веб-приложение обрабатывает конфиденциальную информацию, обязательно спросите пользователя, находится ли он на доверенном устройстве, прежде чем включать сохраняемость.

Web modular API

// Memory cache is the default if no config is specified.
initializeFirestore(app);

// This is the default behavior if no persistence is specified.
initializeFirestore(app, {localCache: memoryLocalCache()});

// Defaults to single-tab persistence if no tab manager is specified.
initializeFirestore(app, {localCache: persistentLocalCache(/*settings*/{})});

// Same as `initializeFirestore(app, {localCache: persistentLocalCache(/*settings*/{})})`,
// but more explicit about tab management.
initializeFirestore(app, 
  {localCache: 
    persistentLocalCache(/*settings*/{tabManager: persistentSingleTabManager()})
});

// Use multi-tab IndexedDb persistence.
initializeFirestore(app, 
  {localCache: 
    persistentLocalCache(/*settings*/{tabManager: persistentMultipleTabManager()})
  });

Web namespaced API

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 successfullytest.firestore.js

Быстрый

Примечание. Этот продукт недоступен для целей watchOS и App Clip.

let settings = FirestoreSettings()

// Use memory-only cache
settings.cacheSettings =
    MemoryCacheSettings(garbageCollectorSettings: MemoryLRUGCSettings())

// Use persistent disk cache, with 1 MB cache size
settings.cacheSettings = PersistentCacheSettings(sizeBytes: 1_000_000)

// Any additional options
// ...

// Enable offline data persistence
let db = Firestore.firestore()
db.settings = settingsViewController.swift

Цель-C

Примечание. Этот продукт недоступен для целей watchOS и App Clip.

FIRFirestoreSettings *settings = [[FIRFirestoreSettings alloc] init];

// Use memory-only cache
settings.cacheSettings = [[FIRMemoryCacheSettings alloc]
    initWithGarbageCollectorSettings:[[FIRMemoryLRUGCSettings alloc] init]];

// Use persistent disk cache (default behavior)
// This example uses 1 million bytes, or 1 MB.
settings.cacheSettings = [[FIRPersistentCacheSettings alloc] initWithSizeBytes:@1000000];

// Any additional options
// ...

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

Kotlin+KTX

val settings = firestoreSettings {
    // Use memory cache
    setLocalCacheSettings(memoryCacheSettings {})
    // Use persistent disk cache (default)
    setLocalCacheSettings(persistentCacheSettings {})
}
db.firestoreSettings = settingsDocSnippets.kt

Java

FirebaseFirestoreSettings settings = 
new FirebaseFirestoreSettings.Builder(db.getFirestoreSettings())
    // Use memory-only cache
    .setLocalCacheSettings(MemoryCacheSettings.newBuilder().build())
    // Use persistent disk cache (default)
    .setLocalCacheSettings(PersistentCacheSettings.newBuilder()
                            .build())
    .build();
db.setFirestoreSettings(settings);DocSnippets.java

Dart

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

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

Настроить размер кэша

Когда сохранение включено, Cloud Firestore кэширует каждый документ, полученный от серверной части, для доступа в автономном режиме. Cloud Firestore устанавливает пороговое значение по умолчанию для размера кеша. После превышения значения по умолчанию Cloud Firestore периодически пытается очистить старые неиспользуемые документы. Вы можете настроить другой порог размера кеша или полностью отключить процесс очистки:

Web modular API

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

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

Web namespaced API

firebase.firestore().settings({
    cacheSizeBytes: firebase.firestore.CACHE_SIZE_UNLIMITED
});test.firestore.js

Быстрый

Примечание. Этот продукт недоступен для целей watchOS и 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
// Set cache size to 1 MB
settings.cacheSettings = PersistentCacheSettings(sizeBytes: 1_000_000)
Firestore.firestore().settings = settingsViewController.swift

Цель-C

Примечание. Этот продукт недоступен для целей watchOS и 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;
// Set cache size to 1 MB
settings.cacheSettings =
    [[FIRPersistentCacheSettings alloc] initWithSizeBytes:@1000000];
[FIRFirestore firestore].settings = settings;ViewController.m

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

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);

Dart

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

Слушайте автономные данные

Пока устройство находится в автономном режиме, если вы включили сохранение в автономном режиме, ваши прослушиватели будут получать события прослушивания при изменении локально кэшированных данных. Вы можете слушать документы, коллекции и запросы.

Чтобы проверить, получаете ли вы данные с сервера или из кэша, используйте свойство fromCache в SnapshotMetadata в событии моментального снимка. Если fromCache имеет true , данные получены из кеша и могут быть устаревшими или неполными. Если fromCache имеет значение false , данные полны и актуальны с последними обновлениями на сервере.

По умолчанию никакое событие не возникает, если изменились только SnapshotMetadata . Если вы полагаетесь на значения fromCache , укажите параметр прослушивания includeMetadataChanges при присоединении обработчика прослушивания.

Web modular API

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 namespaced API

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

Быстрый

Примечание. Этот продукт недоступен для целей watchOS и 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

Цель-C

Примечание. Этот продукт недоступен для целей watchOS и 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

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

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

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

Получить офлайн-данные

Если вы получаете документ, когда устройство находится в автономном режиме, Cloud Firestore возвращает данные из кеша.

При запросе коллекции возвращается пустой результат, если нет кэшированных документов. Вместо этого при получении определенного документа возвращается ошибка.

Запрос офлайн-данных

Запросы работают с сохранением в автономном режиме. Вы можете получить результаты запросов либо с помощью прямого получения, либо путем прослушивания, как описано в предыдущих разделах. Вы также можете создавать новые запросы к локально сохраненным данным, когда устройство находится в автономном режиме, но изначально запросы будут выполняться только для кэшированных документов.

Настройка автономных индексов запросов

По умолчанию Firestore SDK сканирует все документы в коллекции в своем локальном кеше при выполнении автономных запросов. При таком поведении по умолчанию производительность автономных запросов может снижаться, когда пользователи находятся в автономном режиме в течение длительного периода времени.

Вы можете повысить производительность автономных запросов, настроив локальные индексы запросов:

Быстрый

SDK платформы Apple предоставляет метод setIndexConfiguration , который считывает ту же конфигурацию в формате JSON, которая используется для настройки индексов на сервере, в соответствии с тем же форматом определения индекса .

// You will normally read this from a file asset or cloud storage.
let indexConfigJson = """
  {
    indexes: [
        ...
    ],
    fieldOverrides: [
        ...
    ]
  }
"""

// Apply the configuration.
Firestore.firestore().setIndexConfiguration(indexConfigJson)

Цель-C

Платформа Apple SDK предоставляет setIndexConfiguration — методы, которые считывают ту же конфигурацию в формате JSON, которая используется для настройки индексов на сервере, в соответствии с тем же форматом определения индекса .

// You will normally read this from a file asset or cloud storage.
NSString *indexConfigJson = @" {                   "
                             "   indexes: [        "
                             "     ...             "
                             "   ],                "
                             "   fieldOverrides: [ "
                             "     ...             "
                             "   ]                 "
                             " }                   ";

// Apply the configuration.
[[FIRFirestore firestore] setIndexConfigurationFromJSON:indexConfigJson
                                             completion:^(NSError * _Nullable error) {
    // ...
}];

Java

Android SDK предоставляет метод setIndexConfiguration , который считывает ту же конфигурацию в формате JSON, которая используется для настройки индексов на сервере, в соответствии с тем же форматом определения индекса .

// You will normally read this from a file asset or cloud storage.
String indexConfigJson = " {                   "
                       + "   indexes: [        "
                       + "     ...             "
                       + "   ],                "
                       + "   fieldOverrides: [ "
                       + "     ...             "
                       + "   ]                 "
                       + " }                   ";
// Apply the configuration.
FirebaseFirestore.getInstance().setIndexConfiguration(indexConfigJson);

Kotlin+KTX

// You will normally read this from a file asset or cloud storage.
val indexConfigJson = """
{
  indexes: [
      ...
  ],
  fieldOverrides: [
      ...
  ]
}
"""

// Apply the configuration.
FirebaseFirestore.getInstance().setIndexConfiguration(indexConfigJson)

Dart

Flutter SDK предоставляет метод setIndexConfigurationFromJSON , который считывает ту же конфигурацию в формате JSON, которая используется для настройки индексов на сервере, в соответствии с тем же форматом определения индекса .

// You will normally read this from a file asset or cloud storage.
var indexConfigJson = """
{
  indexes: [
      ...
  ],
  fieldOverrides: [
      ...
  ]
}
""";

// Apply the configuration.
await FirebaseFirestore.instance.setIndexConfigurationFromJSON(json: indexConfigJson);

Кроме того, вы можете использовать метод setIndexConfiguration для настройки индексов с помощью API на основе классов.

var indexes = [
  Index(
    collectionGroup: "posts",
    queryScope: QueryScope.collection,
    fields: [
      IndexField(fieldPath: "author", arrayConfig: ArrayConfig.contains),
      IndexField(fieldPath: "timestamp", order: Order.descending)
    ],
  ),
];
await FirebaseFirestore.instance.setIndexConfiguration(indexes: indexes);

Используемая автономная конфигурация индекса зависит от того, к каким коллекциям и документам ваше приложение активно обращается в автономном режиме, и от желаемой производительности в автономном режиме. Хотя вы можете экспортировать конфигурацию серверного индекса для использования на клиенте, шаблоны автономного доступа вашего приложения, вероятно, значительно отличаются от шаблонов онлайн-доступа, поэтому ваша конфигурация онлайн-индекса может не подходить для использования в автономном режиме. К каким коллекциям и документам вы хотите, чтобы ваше приложение имело доступ в автономном режиме с высокой производительностью? Проанализировав поведение своего приложения, следуйте принципам определения индекса из руководства по индексированию .

Чтобы сделать автономные конфигурации индекса доступными для загрузки в клиентском приложении:

компилировать и распространять их вместе с вашим приложением
скачать их с CDN
получить их из системы хранения, такой как Cloud Storage for Firebase .

Отключить и включить доступ к сети

Вы можете использовать метод ниже, чтобы отключить доступ к сети для вашего клиента Cloud Firestore. Пока доступ к сети отключен, все прослушиватели моментальных снимков и запросы документов извлекают результаты из кэша. Операции записи ставятся в очередь до тех пор, пока доступ к сети не будет снова включен.

Web modular API

import { disableNetwork } from "firebase/firestore"; 

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

Web namespaced API

firebase.firestore().disableNetwork()
    .then(() => {
        // Do offline actions
        // ...
    });test.firestore.js

Быстрый

Примечание. Этот продукт недоступен для целей watchOS и App Clip.

Firestore.firestore().disableNetwork { (error) in
    // Do offline things
    // ...
}ViewController.swift

Цель-C

Примечание. Этот продукт недоступен для целей watchOS и App Clip.

[[FIRFirestore firestore] disableNetworkWithCompletion:^(NSError *_Nullable error) {
  // Do offline actions
  // ...
}];ViewController.m

Kotlin+KTX

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

Java

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

Dart

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

Используйте следующий метод для повторного включения доступа к сети:

Web modular API

import { enableNetwork } from "firebase/firestore"; 

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

Web namespaced API

firebase.firestore().enableNetwork()
    .then(() => {
        // Do online actions
        // ...
    });test.firestore.js

Быстрый

Примечание. Этот продукт недоступен для целей watchOS и App Clip.

Firestore.firestore().enableNetwork { (error) in
    // Do online things
    // ...
}ViewController.swift

Цель-C

Примечание. Этот продукт недоступен для целей watchOS и App Clip.

[[FIRFirestore firestore] enableNetworkWithCompletion:^(NSError *_Nullable error) {
  // Do online actions
  // ...
}];ViewController.m

Kotlin+KTX

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

Java

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

Dart

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