Cloud Firestore รองรับข้อมูลออฟไลน์แบบต่อเนื่อง ฟีเจอร์นี้จะแคชสำเนา ของข้อมูลCloud Firestoreที่แอปของคุณใช้งานอยู่ เพื่อให้แอป เข้าถึงข้อมูลได้เมื่ออุปกรณ์ออฟไลน์ คุณสามารถเขียน อ่าน ฟัง และค้นหาข้อมูลที่แคชไว้ได้
เมื่ออุปกรณ์กลับมาออนไลน์ Cloud Firestore จะซิงค์การเปลี่ยนแปลงในเครื่องที่แอปของคุณทำกับ Cloud Firestore แบ็กเอนด์ หากมีการเปลี่ยนแปลงเอกสารเดียวกันหลายครั้ง ระบบจะใช้การเขียนครั้งสุดท้าย
หากต้องการใช้ความต่อเนื่องแบบออฟไลน์ คุณไม่จำเป็นต้องทำการเปลี่ยนแปลงโค้ดที่ ใช้ในการเข้าถึงข้อมูล Cloud Firestore เมื่อเปิดใช้ความต่อเนื่องแบบออฟไลน์ ไลบรารีของไคลเอ็นต์ Cloud Firestore จะจัดการการเข้าถึงข้อมูลออนไลน์และข้อมูลออฟไลน์ รวมถึงซิงค์ข้อมูลในเครื่องโดยอัตโนมัติเมื่ออุปกรณ์กลับมาออนไลน์
กำหนดค่าความต่อเนื่องแบบออฟไลน์
เมื่อเริ่มต้นใช้งาน Cloud Firestore คุณจะเปิดหรือปิดใช้ ความต่อเนื่องแบบออฟไลน์ได้
- สำหรับแพลตฟอร์ม Android และ Apple ระบบจะเปิดใช้ความต่อเนื่องแบบออฟไลน์ไว้โดยค่าเริ่มต้น หากต้องการปิดใช้ความต่อเนื่อง ให้ตั้งค่าตัวเลือก
PersistenceEnabledเป็นfalse - สำหรับเว็บ ระบบจะปิดใช้ความต่อเนื่องแบบออฟไลน์ไว้โดยค่าเริ่มต้น หากต้องการเปิดใช้ความต่อเนื่อง ให้เรียกใช้เมธอด
enablePersistenceแคชของ Cloud Firestore จะไม่ถูกล้างโดยอัตโนมัติระหว่างเซสชัน ดังนั้น หากเว็บแอปของคุณจัดการข้อมูลที่ละเอียดอ่อน โปรดถามผู้ใช้ว่ากำลังใช้อุปกรณ์ที่เชื่อถือได้หรือไม่ก่อนที่จะเปิดใช้ความต่อเนื่อง
Web
// 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
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
Swift
let settings = FirestoreSettings() // Use memory-only cache settings.cacheSettings = MemoryCacheSettings(garbageCollectorSettings: MemoryLRUGCSettings()) // Use persistent disk cache, with 100 MB cache size settings.cacheSettings = PersistentCacheSettings(sizeBytes: 100 * 1024 * 1024 as NSNumber) // Any additional options // ... // Enable offline data persistence let db = Firestore.firestore() db.settings = settings
Objective-C
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 100 MB. settings.cacheSettings = [[FIRPersistentCacheSettings alloc] initWithSizeBytes:@(100 * 1024 * 1024)]; // Any additional options // ... // Enable offline data persistence FIRFirestore *db = [FIRFirestore firestore]; db.settings = settings;
Kotlin
val settings = firestoreSettings { // Use memory cache setLocalCacheSettings(memoryCacheSettings {}) // Use persistent disk cache (default) setLocalCacheSettings(persistentCacheSettings {}) } db.firestoreSettings = settings
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);
Dart
// Apple and Android db.settings = const Settings(persistenceEnabled: true); // Web await db .enablePersistence(const PersistenceSettings(synchronizeTabs: true));
กำหนดค่าขนาดแคช
เมื่อเปิดใช้ความต่อเนื่อง Cloud Firestore จะแคชเอกสารทุกฉบับ ที่ได้รับจากแบ็กเอนด์เพื่อการเข้าถึงแบบออฟไลน์ Cloud Firestore กำหนด เกณฑ์เริ่มต้นสำหรับขนาดแคช หลังจากเกินค่าเริ่มต้นแล้ว Cloud Firestore จะพยายามล้างเอกสารเก่าที่ไม่ได้ใช้ออกเป็นระยะๆ คุณสามารถกำหนดค่าเกณฑ์ขนาดแคชอื่นหรือปิดใช้กระบวนการล้างข้อมูลโดยสมบูรณ์ได้
Web
import { initializeFirestore, CACHE_SIZE_UNLIMITED } from "firebase/firestore"; const firestoreDb = initializeFirestore(app, { cacheSizeBytes: CACHE_SIZE_UNLIMITED });
Web
firebase.firestore().settings({ cacheSizeBytes: firebase.firestore.CACHE_SIZE_UNLIMITED });
Swift
// 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 100 MB settings.cacheSettings = PersistentCacheSettings(sizeBytes: 100 * 1024 * 1024 as NSNumber) Firestore.firestore().settings = settings
Objective-C
// 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 100 MB settings.cacheSettings = [[FIRPersistentCacheSettings alloc] initWithSizeBytes:@(100 * 1024 * 1024)]; [FIRFirestore firestore].settings = settings;
Kotlin
// 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, );
ฟังข้อมูลออฟไลน์
ขณะที่อุปกรณ์ออฟไลน์ หากคุณเปิดใช้ความต่อเนื่องแบบออฟไลน์ ผู้ฟังจะได้รับเหตุการณ์การฟังเมื่อข้อมูลที่แคชไว้ในเครื่องมีการเปลี่ยนแปลง คุณสามารถฟังเอกสาร คอลเล็กชัน และการค้นหาได้
หากต้องการตรวจสอบว่าคุณได้รับข้อมูลจากเซิร์ฟเวอร์หรือแคช ให้ใช้พร็อพเพอร์ตี้ fromCache ใน SnapshotMetadata ในเหตุการณ์สแนปช็อต หาก fromCache เป็น true แสดงว่าข้อมูลมาจากแคชและอาจไม่อัปเดตหรือมีข้อมูลไม่ครบถ้วน หาก fromCache เป็น false แสดงว่าข้อมูลครบถ้วนและอัปเดตล่าสุดบนเซิร์ฟเวอร์
โดยค่าเริ่มต้น ระบบจะไม่แสดงเหตุการณ์หากมีการเปลี่ยนแปลง เฉพาะ SnapshotMetadata หากคุณใช้ค่า fromCache ให้ระบุตัวเลือกการฟัง includeMetadataChanges เมื่อแนบแฮนเดิลเลอร์การฟัง
Web
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); }); });
Web
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); }); });
Swift
// 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)") }
Objective-C
// 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); }];
Kotlin
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") } }
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); } } });
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}"); } } });
รับข้อมูลออฟไลน์
หากคุณรับเอกสารขณะที่อุปกรณ์ออฟไลน์ Cloud Firestore จะแสดงข้อมูลจากแคช
เมื่อค้นหาคอลเล็กชัน ระบบจะแสดงผลลัพธ์ที่ว่างเปล่าหากไม่มีเอกสารที่แคชไว้ แต่เมื่อดึงข้อมูลเอกสารที่เฉพาะเจาะจง ระบบจะแสดงข้อผิดพลาดแทน
ค้นหาข้อมูลออฟไลน์
การค้นหาจะทำงานร่วมกับความต่อเนื่องแบบออฟไลน์ คุณสามารถดึงข้อมูลผลการค้นหาด้วยการรับข้อมูลโดยตรงหรือโดยการฟังตามที่อธิบายไว้ในส่วนก่อนหน้า นอกจากนี้ คุณยังสร้างการค้นหาใหม่ในข้อมูลที่คงอยู่ภายในเครื่องขณะที่อุปกรณ์ออฟไลน์ได้ แต่การค้นหาจะทำงานกับเอกสารที่แคชไว้เท่านั้นในตอนแรก
กำหนดค่าดัชนีการค้นหาแบบออฟไลน์
โดยค่าเริ่มต้น Firestore SDK จะสแกนเอกสารทั้งหมดในคอลเล็กชันในแคชในเครื่องเมื่อดำเนินการค้นหาแบบออฟไลน์ ลักษณะการทำงานเริ่มต้นนี้อาจทำให้ประสิทธิภาพการค้นหาแบบออฟไลน์ลดลงเมื่อผู้ใช้ออฟไลน์เป็นเวลานาน
เมื่อเปิดใช้แคชแบบต่อเนื่อง คุณจะปรับปรุงประสิทธิภาพการค้นหาแบบออฟไลน์ได้โดยอนุญาตให้ SDK สร้างดัชนีการค้นหาในเครื่องโดยอัตโนมัติ
ระบบจะปิดใช้การจัดทำดัชนีอัตโนมัติไว้โดยค่าเริ่มต้น แอปของคุณต้องเปิดใช้การจัดทำดัชนีอัตโนมัติทุกครั้งที่เริ่มต้น ควบคุมว่าจะเปิดใช้การจัดทำดัชนีอัตโนมัติหรือไม่ตามที่แสดงด้านล่าง
Swift
if let indexManager = Firestore.firestore().persistentCacheIndexManager { // Indexing is disabled by default indexManager.enableIndexAutoCreation() } else { print("indexManager is nil") }
Objective-C
PersistentCacheIndexManager *indexManager = [FIRFirestore firestore].persistentCacheIndexManager; if (indexManager) { // Indexing is disabled by default [indexManager enableIndexAutoCreation]; }
Kotlin
// return type: PersistentCacheManager? Firebase.firestore.persistentCacheIndexManager?.apply { // Indexing is disabled by default enableIndexAutoCreation() } ?: println("indexManager is null")
Java
// return type: @Nullable PersistentCacheIndexManager PersistentCacheIndexManager indexManager = FirebaseFirestore.getInstance().getPersistentCacheIndexManager(); if (indexManager != null) { // Indexing is disabled by default indexManager.enableIndexAutoCreation(); } // If not check indexManager != null, IDE shows warning: Method invocation 'enableIndexAutoCreation' may produce 'NullPointerException' FirebaseFirestore.getInstance().getPersistentCacheIndexManager().enableIndexAutoCreation();
เมื่อเปิดใช้การจัดทำดัชนีอัตโนมัติแล้ว SDK จะประเมินว่าคอลเล็กชันใดมีเอกสารที่แคชไว้จำนวนมาก และเพิ่มประสิทธิภาพการค้นหาในเครื่อง
SDK มีเมธอดสำหรับลบดัชนีการค้นหา
ปิดใช้และเปิดใช้การเข้าถึงเครือข่าย
คุณสามารถใช้เมธอดด้านล่างเพื่อปิดใช้การเข้าถึงเครือข่ายสำหรับ Cloud Firestore ไคลเอ็นต์ ขณะที่ปิดใช้การเข้าถึงเครือข่าย ผู้ฟังสแนปช็อตและคำขอเอกสารทั้งหมดจะดึงข้อมูลผลลัพธ์จากแคช ระบบจะจัดคิวการดำเนินการเขียนไว้จนกว่าจะเปิดใช้การเข้าถึงเครือข่ายอีกครั้ง
Web
import { disableNetwork } from "firebase/firestore"; await disableNetwork(db); console.log("Network disabled!"); // Do offline actions // ...
Web
firebase.firestore().disableNetwork() .then(() => { // Do offline actions // ... });
Swift
Firestore.firestore().disableNetwork { (error) in // Do offline things // ... }
Objective-C
[[FIRFirestore firestore] disableNetworkWithCompletion:^(NSError *_Nullable error) { // Do offline actions // ... }];
Kotlin
db.disableNetwork().addOnCompleteListener { // Do offline things // ... }
Java
db.disableNetwork() .addOnCompleteListener(new OnCompleteListener<Void>() { @Override public void onComplete(@NonNull Task<Void> task) { // Do offline things // ... } });
Dart
db.disableNetwork().then((_) { // Do offline things });
ใช้เมธอดต่อไปนี้เพื่อเปิดใช้การเข้าถึงเครือข่ายอีกครั้ง
Web
import { enableNetwork } from "firebase/firestore"; await enableNetwork(db); // Do online actions // ...
Web
firebase.firestore().enableNetwork() .then(() => { // Do online actions // ... });
Swift
Firestore.firestore().enableNetwork { (error) in // Do online things // ... }
Objective-C
[[FIRFirestore firestore] enableNetworkWithCompletion:^(NSError *_Nullable error) { // Do online actions // ... }];
Kotlin
db.enableNetwork().addOnCompleteListener { // Do online things // ... }
Java
db.enableNetwork() .addOnCompleteListener(new OnCompleteListener<Void>() { @Override public void onComplete(@NonNull Task<Void> task) { // Do online things // ... } });
Dart
db.enableNetwork().then((_) { // Back online });