Cloud Firestore از ماندگاری داده های آفلاین پشتیبانی می کند. این ویژگی یک کپی از دادههای Cloud Firestore را که برنامه شما فعالانه از آن استفاده میکند، در حافظه پنهان ذخیره میکند، بنابراین برنامه شما میتواند زمانی که دستگاه آفلاین است به دادهها دسترسی داشته باشد. میتوانید دادههای ذخیرهشده را بنویسید، بخوانید، گوش دهید، و به آنها پرس و جو کنید. هنگامی که دستگاه دوباره آنلاین می شود، Cloud Firestore هرگونه تغییر محلی ایجاد شده توسط برنامه شما را با بخش پشتیبان Cloud Firestore همگام می کند.
برای استفاده از ماندگاری آفلاین، نیازی به تغییر در کدی که برای دسترسی به دادههای Cloud Firestore استفاده میکنید، ندارید. با فعال بودن تداوم آفلاین، کتابخانه سرویس گیرنده Cloud Firestore به طور خودکار دسترسی به دادههای آنلاین و آفلاین را مدیریت میکند و زمانی که دستگاه دوباره آنلاین میشود، دادههای محلی را همگامسازی میکند.
پیکربندی ماندگاری آفلاین
هنگامی که Cloud Firestore را مقداردهی اولیه می کنید، می توانید پایداری آفلاین را فعال یا غیرفعال کنید:
- برای پلتفرم های اندروید و اپل، ماندگاری آفلاین به طور پیش فرض فعال است. برای غیرفعال کردن تداوم، گزینه
PersistenceEnabled
را رویfalse
قرار دهید. - برای وب، ماندگاری آفلاین به طور پیشفرض غیرفعال است. برای فعال کردن ماندگاری، متد
enablePersistence
را فراخوانی کنید. حافظه پنهان Cloud Firestore به طور خودکار بین جلسات پاک نمی شود. در نتیجه، اگر برنامه وب شما اطلاعات حساسی را مدیریت میکند، قبل از فعال کردن تداوم، حتماً از کاربر بپرسید که آیا در دستگاه قابل اعتمادی است یا خیر.
Web version 9
import { enableIndexedDbPersistence } from "firebase/firestore"; enableIndexedDbPersistence(db) .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
Web version 8
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
سریع
let settings = FirestoreSettings() settings.isPersistenceEnabled = true // Any additional options // ... // Enable offline data persistence let db = Firestore.firestore() db.settings = settings
هدف-C
FIRFirestoreSettings *settings = [[FIRFirestoreSettings alloc] init]; settings.persistenceEnabled = YES; // Any additional options // ... // Enable offline data persistence FIRFirestore *db = [FIRFirestore firestore]; db.settings = settings;
Kotlin+KTX
val settings = firestoreSettings { isPersistenceEnabled = true } db.firestoreSettings = settings
Java
FirebaseFirestoreSettings settings = new FirebaseFirestoreSettings.Builder() .setPersistenceEnabled(true) .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 version 9
import { initializeFirestore, CACHE_SIZE_UNLIMITED } from "firebase/firestore"; const firestoreDb = initializeFirestore(app, { cacheSizeBytes: CACHE_SIZE_UNLIMITED });
Web version 8
firebase.firestore().settings({ cacheSizeBytes: firebase.firestore.CACHE_SIZE_UNLIMITED });
سریع
// 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 settings.cacheSizeBytes = FirestoreCacheSizeUnlimited Firestore.firestore().settings = settings
هدف-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; settings.cacheSizeBytes = kFIRFirestoreCacheSizeUnlimited; [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
در رویداد Snapshot خود استفاده کنید. اگر fromCache
true
، دادهها از حافظه پنهان آمده و ممکن است کهنه یا ناقص باشند. اگر fromCache
false
، دادهها با آخرین بهروزرسانیهای سرور کامل و جاری هستند.
به طور پیش فرض، اگر فقط SnapshotMetadata
تغییر کند، هیچ رویدادی افزایش نمی یابد. اگر به مقادیر fromCache
تکیه می کنید، هنگامی که کنترل کننده گوش خود را وصل می کنید، گزینه includeMetadataChanges
را مشخص کنید.
Web version 9
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 version 8
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); }); });
سریع
// 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)") }
هدف-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 پلتفرم 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
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
Android SDK یک روش setIndexConfiguration
ارائه میکند که همان پیکربندی با ساختار JSON را که برای پیکربندی نمایهها در سرور استفاده میشود، با همان قالب تعریف شاخص میخواند.
// 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 برای Firebase واکشی کنید.
دسترسی به شبکه را غیرفعال و فعال کنید
میتوانید از روش زیر برای غیرفعال کردن دسترسی به شبکه برای کلاینت Cloud Firestore خود استفاده کنید. در حالی که دسترسی به شبکه غیرفعال است، همه شنوندههای عکس فوری و درخواستهای سند نتایج را از حافظه پنهان بازیابی میکنند. عملیات نوشتن در صف قرار می گیرد تا دسترسی به شبکه دوباره فعال شود.
Web version 9
import { disableNetwork } from "firebase/firestore"; await disableNetwork(db); console.log("Network disabled!"); // Do offline actions // ...
Web version 8
firebase.firestore().disableNetwork() .then(() => { // Do offline actions // ... });
سریع
Firestore.firestore().disableNetwork { (error) in // Do offline things // ... }
هدف-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 version 9
import { enableNetwork } from "firebase/firestore"; await enableNetwork(db); // Do online actions // ...
Web version 8
firebase.firestore().enableNetwork() .then(() => { // Do online actions // ... });
سریع
Firestore.firestore().enableNetwork { (error) in // Do online things // ... }
هدف-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 });