يدعم 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+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
// 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+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
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+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 إلى الشبكة. بينما يتم إيقاف الوصول إلى الشبكة، تقوم جميع برامج الاستماع المتعلقة باللقطات وطلبات المستندات باسترداد النتائج من ذاكرة التخزين المؤقت. تتم إضافة عمليات الكتابة إلى قائمة الانتظار حتى تتم إعادة تفعيل الوصول إلى الشبكة.
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+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
Firestore.firestore().enableNetwork { (error) in // Do online things // ... }
Objective-C
[[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 });