دسترسی آفلاین به داده ها

Cloud Firestore از ماندگاری داده‌های آفلاین پشتیبانی می‌کند. این ویژگی یک کپی از داده‌های Cloud Firestore را که برنامه شما به طور فعال از آن استفاده می‌کند، ذخیره می‌کند، بنابراین برنامه شما می‌تواند وقتی دستگاه آفلاین است به داده‌ها دسترسی داشته باشد. می‌توانید داده‌های ذخیره شده را بنویسید، بخوانید، گوش دهید و پرس و جو کنید.

وقتی دستگاه دوباره آنلاین می‌شود، Cloud Firestore هرگونه تغییر محلی ایجاد شده توسط برنامه شما را با backend Cloud Firestore همگام‌سازی می‌کند. برای چندین تغییر در یک سند، آخرین تغییری که نوشته شده باشد، برنده است.

برای استفاده از قابلیت ماندگاری آفلاین، نیازی به ایجاد هیچ تغییری در کدی که برای دسترسی به داده‌های Cloud Firestore استفاده می‌کنید، ندارید. با فعال بودن قابلیت ماندگاری آفلاین، کتابخانه کلاینت Cloud Firestore به طور خودکار دسترسی به داده‌های آنلاین و آفلاین را مدیریت کرده و داده‌های محلی را هنگامی که دستگاه دوباره آنلاین می‌شود، همگام‌سازی می‌کند.

پیکربندی پایداری آفلاین

وقتی Cloud Firestore را مقداردهی اولیه می‌کنید، می‌توانید پایداری آفلاین را فعال یا غیرفعال کنید:

  • برای پلتفرم‌های اندروید و اپل، پایداری آفلاین به طور پیش‌فرض فعال است. برای غیرفعال کردن پایداری، گزینه 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
test.firestore.js
سویفت
توجه: این محصول در 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
ViewController.swift
هدف-سی
توجه: این محصول در 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;
ViewController.m

Kotlin 

val settings = firestoreSettings {
    // Use memory cache
    setLocalCacheSettings(memoryCacheSettings {})
    // Use persistent disk cache (default)
    setLocalCacheSettings(persistentCacheSettings {})
}
db.firestoreSettings = settings
DocSnippets.kt

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);
DocSnippets.java

Dart 

// Apple and Android
db.settings = const Settings(persistenceEnabled: true);

// Web
await db
    .enablePersistence(const PersistenceSettings(synchronizeTabs: true));
firestore.dart

پیکربندی اندازه حافظه پنهان

وقتی پایداری فعال باشد، Cloud Firestore هر سندی را که از backend دریافت می‌شود برای دسترسی آفلاین ذخیره می‌کند. Cloud Firestore یک آستانه پیش‌فرض برای اندازه حافظه پنهان تعیین می‌کند. پس از عبور از حد پیش‌فرض، Cloud Firestore به صورت دوره‌ای سعی می‌کند اسناد قدیمی‌تر و بلااستفاده را پاک کند. می‌توانید آستانه اندازه حافظه پنهان متفاوتی را پیکربندی کنید یا فرآیند پاک‌سازی را به طور کامل غیرفعال کنید:

Web 

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

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

Web

firebase.firestore().settings({
    cacheSizeBytes: firebase.firestore.CACHE_SIZE_UNLIMITED
});
test.firestore.js
سویفت
توجه: این محصول در 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
ViewController.swift
هدف-سی
توجه: این محصول در 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;
ViewController.m

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,
);
firestore.dart

گوش دادن به داده‌های آفلاین

در حالی که دستگاه آفلاین است، اگر پایداری آفلاین را فعال کرده باشید، شنونده‌های شما هنگام تغییر داده‌های ذخیره‌شده محلی، رویدادهای شنود را دریافت می‌کنند. می‌توانید به اسناد، مجموعه‌ها و پرس‌وجوها گوش دهید.

برای بررسی اینکه آیا داده‌ها را از سرور دریافت می‌کنید یا از حافظه پنهان، از ویژگی fromCache در SnapshotMetadata در رویداد snapshot خود استفاده کنید. اگر fromCache true باشد، داده‌ها از حافظه پنهان آمده‌اند و ممکن است قدیمی یا ناقص باشند. اگر fromCache برابر با false باشد، داده‌ها کامل و به‌روز هستند و آخرین به‌روزرسانی‌ها روی سرور روی آنها اعمال شده است.

به طور پیش‌فرض، اگر فقط SnapshotMetadata تغییر کند، هیچ رویدادی رخ نمی‌دهد. اگر به مقادیر fromCache تکیه می‌کنید، هنگام اتصال کنترل‌کننده‌ی شنود خود، گزینه‌ی includeMetadataChanges listen را مشخص کنید.

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);
    });
});
use_from_cache.js

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);
      });
  });
test.firestore.js
سویفت
توجه: این محصول در 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)")
  }
ViewController.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 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);
    }];
ViewController.m

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")
        }
    }
DocSnippets.kt

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

            }
        });
DocSnippets.java

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}");
    }
  }
});
firestore.dart

دریافت داده‌های آفلاین

اگر در حالت آفلاین بودن دستگاه، سندی دریافت کنید، 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 

// 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
// ...
disable_network.js

Web

firebase.firestore().disableNetwork()
    .then(() => {
        // Do offline actions
        // ...
    });
test.firestore.js
سویفت
توجه: این محصول در watchOS و App Clip موجود نیست. 
Firestore.firestore().disableNetwork { (error) in
  // Do offline things
  // ...
}
ViewController.swift
هدف-سی
توجه: این محصول در watchOS و App Clip موجود نیست. 
[[FIRFirestore firestore] disableNetworkWithCompletion:^(NSError *_Nullable error) {
  // Do offline actions
  // ...
}];
ViewController.m

Kotlin 

db.disableNetwork().addOnCompleteListener {
    // Do offline things
    // ...
}
DocSnippets.kt

Java 

db.disableNetwork()
        .addOnCompleteListener(new OnCompleteListener<Void>() {
            @Override
            public void onComplete(@NonNull Task<Void> task) {
                // Do offline things
                // ...
            }
        });
DocSnippets.java

Dart 

db.disableNetwork().then((_) {
  // Do offline things
});
firestore.dart

برای فعال کردن مجدد دسترسی به شبکه از روش زیر استفاده کنید:

Web 

import { enableNetwork } from "firebase/firestore"; 

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

Web

firebase.firestore().enableNetwork()
    .then(() => {
        // Do online actions
        // ...
    });
test.firestore.js
سویفت
توجه: این محصول در watchOS و App Clip موجود نیست. 
Firestore.firestore().enableNetwork { (error) in
  // Do online things
  // ...
}
ViewController.swift
هدف-سی
توجه: این محصول در watchOS و App Clip موجود نیست. 
[[FIRFirestore firestore] enableNetworkWithCompletion:^(NSError *_Nullable error) {
  // Do online actions
  // ...
}];
ViewController.m

Kotlin 

db.enableNetwork().addOnCompleteListener {
    // Do online things
    // ...
}
DocSnippets.kt

Java 

db.enableNetwork()
        .addOnCompleteListener(new OnCompleteListener<Void>() {
            @Override
            public void onComplete(@NonNull Task<Void> task) {
                // Do online things
                // ...
            }
        });
DocSnippets.java

Dart 

db.enableNetwork().then((_) {
  // Back online
});
firestore.dart