الوصول إلى البيانات في وضع عدم الاتصال

يدعم 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 successfully
سويفت
ملاحظة: هذا المنتج غير متوفر في أنظمة 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
ج موضوعية
ملاحظة: هذا المنتج غير متوفر في أنظمة 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 modular API

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

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

Web namespaced API

firebase.firestore().settings({
    cacheSizeBytes: firebase.firestore.CACHE_SIZE_UNLIMITED
});
سويفت
ملاحظة: هذا المنتج غير متوفر في أنظمة 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
ج موضوعية
ملاحظة: هذا المنتج غير متوفر في أنظمة 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,
);

الاستماع إلى البيانات دون اتصال

عندما يكون الجهاز غير متصل بالإنترنت، إذا قمت بتمكين الاستمرارية دون اتصال بالإنترنت، فسيتلقى المستمعون أحداث استماع عندما تتغير البيانات المخزنة مؤقتًا محليًا. يمكنك الاستماع إلى المستندات والمجموعات والاستعلامات.

للتحقق مما إذا كنت تتلقى بيانات من الخادم أو ذاكرة التخزين المؤقت، استخدم خاصية 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);
    });
});

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);
      });
  });
سويفت
ملاحظة: هذا المنتج غير متوفر في أنظمة 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)")
  }
ج موضوعية
ملاحظة: هذا المنتج غير متوفر في أنظمة 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 بإنشاء فهارس استعلام محلي تلقائيًا.

يتم تعطيل الفهرسة التلقائية بشكل افتراضي. يجب أن يقوم تطبيقك بتمكين الفهرسة التلقائية في كل مرة يبدأ فيها. التحكم في تمكين الفهرسة التلقائية كما هو موضح أدناه.

سويفت
if let indexManager = Firestore.firestore().persistentCacheIndexManager {
  // Indexing is disabled by default
  indexManager.enableIndexAutoCreation()
} else {
  print("indexManager is nil")
}
    
ج موضوعية
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 الخاص بك. أثناء تعطيل الوصول إلى الشبكة، تقوم جميع مستمعي اللقطات وطلبات المستندات باسترداد النتائج من ذاكرة التخزين المؤقت. يتم وضع عمليات الكتابة في قائمة الانتظار حتى تتم إعادة تمكين الوصول إلى الشبكة.

Web modular API

import { disableNetwork } from "firebase/firestore"; 

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

Web namespaced API

firebase.firestore().disableNetwork()
    .then(() => {
        // Do offline actions
        // ...
    });
سويفت
ملاحظة: هذا المنتج غير متوفر في أنظمة watchOS وApp Clip.
Firestore.firestore().disableNetwork { (error) in
  // Do offline things
  // ...
}
ج موضوعية
ملاحظة: هذا المنتج غير متوفر في أنظمة 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 modular API

import { enableNetwork } from "firebase/firestore"; 

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

Web namespaced API

firebase.firestore().enableNetwork()
    .then(() => {
        // Do online actions
        // ...
    });
سويفت
ملاحظة: هذا المنتج غير متوفر في أنظمة watchOS وApp Clip.
Firestore.firestore().enableNetwork { (error) in
  // Do online things
  // ...
}
ج موضوعية
ملاحظة: هذا المنتج غير متوفر في أنظمة 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
});