เข้าถึงข้อมูลแบบออฟไลน์

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
หมายเหตุ: ผลิตภัณฑ์นี้ใช้ไม่ได้กับเป้าหมาย WatchOS และ App Clip
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
หมายเหตุ: ผลิตภัณฑ์นี้ใช้ไม่ได้กับเป้าหมาย 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 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+KTX

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
หมายเหตุ: ผลิตภัณฑ์นี้ใช้ไม่ได้กับเป้าหมาย 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 100 MB
settings.cacheSettings = PersistentCacheSettings(sizeBytes: 100 * 1024 * 1024 as NSNumber)
Firestore.firestore().settings = settings
Objective-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 100 MB
settings.cacheSettings =
    [[FIRPersistentCacheSettings alloc] initWithSizeBytes:@(100 * 1024 * 1024)];
[FIRFirestore firestore].settings = 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

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

ฟังข้อมูลออฟไลน์

ขณะที่อุปกรณ์ออฟไลน์ ถ้าคุณได้เปิดใช้การถาวรแบบออฟไลน์ไว้ Listener จะได้รับเหตุการณ์ Listener เมื่อข้อมูลที่แคชไว้ในเครื่องมีการเปลี่ยนแปลง คุณ สามารถฟังเอกสาร คอลเล็กชัน และข้อความค้นหา

หากต้องการตรวจสอบว่าคุณรับข้อมูลจากเซิร์ฟเวอร์หรือแคช ให้ใช้ พร็อพเพอร์ตี้ fromCache ใน SnapshotMetadata ในเหตุการณ์สแนปชอต ถ้า fromCache มีสถานะtrue ข้อมูลมาจากแคชและอาจไม่มีการอัปเดต หรือ ไม่สมบูรณ์ หาก fromCache เท่ากับ false ข้อมูลนั้นจะครบถ้วนและเป็นปัจจุบันพร้อมด้วย อัปเดตล่าสุดในเซิร์ฟเวอร์

โดยค่าเริ่มต้น ระบบจะไม่เพิ่มเหตุการณ์หากมีการเปลี่ยนแปลงเฉพาะ SnapshotMetadata หากคุณ ขึ้นอยู่กับค่า fromCache ระบุการฟัง includeMetadataChanges เมื่อคุณต่อเครื่องจัดการ Listener ของคุณ

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
หมายเหตุ: ผลิตภัณฑ์นี้ใช้ไม่ได้กับเป้าหมาย 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)")
  }
Objective-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);
    }];

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")
        }
    }

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+KTX

// 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 รายการ ขณะที่การเข้าถึงเครือข่ายถูกปิดใช้งาน สแนปชอตทั้งหมด Listener และคำขอเอกสารจะเรียกผลลัพธ์จากแคช เขียนหนังสือ การดำเนินการต่างๆ จะอยู่ในคิวจนกว่าจะเปิดใช้การเข้าถึงเครือข่ายอีกครั้ง

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
หมายเหตุ: ผลิตภัณฑ์นี้ใช้ไม่ได้กับเป้าหมาย WatchOS และ App Clip
Firestore.firestore().disableNetwork { (error) in
  // Do offline things
  // ...
}
Objective-C
หมายเหตุ: ผลิตภัณฑ์นี้ใช้ไม่ได้กับเป้าหมาย WatchOS และ App Clip
[[FIRFirestore firestore] disableNetworkWithCompletion:^(NSError *_Nullable error) {
  // Do offline actions
  // ...
}];

Kotlin+KTX

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
หมายเหตุ: ผลิตภัณฑ์นี้ใช้ไม่ได้กับเป้าหมาย WatchOS และ App Clip
Firestore.firestore().enableNetwork { (error) in
  // Do online things
  // ...
}
Objective-C
หมายเหตุ: ผลิตภัณฑ์นี้ใช้ไม่ได้กับเป้าหมาย WatchOS และ App Clip
[[FIRFirestore firestore] enableNetworkWithCompletion:^(NSError *_Nullable error) {
  // Do online actions
  // ...
}];

Kotlin+KTX

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