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

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

توجه: تداوم آفلاین فقط در برنامه‌های اندروید، اپل و وب پشتیبانی می‌شود.

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

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

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

• برای پلتفرم های اندروید و اپل، ماندگاری آفلاین به طور پیش فرض فعال است. برای غیرفعال کردن تداوم، گزینه PersistenceEnabled را روی false قرار دهید.
• برای وب، ماندگاری آفلاین به طور پیش‌فرض غیرفعال است. برای فعال کردن ماندگاری، متد enablePersistence را فراخوانی کنید. حافظه پنهان Cloud Firestore به طور خودکار بین جلسات پاک نمی شود. در نتیجه، اگر برنامه وب شما اطلاعات حساسی را مدیریت می‌کند، قبل از فعال کردن تداوم، حتماً از کاربر بپرسید که آیا در دستگاه قابل اعتمادی است یا خیر.

مهم: برای وب، ماندگاری آفلاین فقط توسط مرورگرهای وب Chrome، Safari و Firefox پشتیبانی می‌شود.

Web

درباره SDK مدولار Web v9 قابل تکان دادن درخت و ارتقا از نسخه 8 بیشتر بیاموزید .

// 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

درباره SDK مدولار Web v9 قابل تکان دادن درخت و ارتقا از نسخه 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
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

هدف-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;
ViewController.m

Kotlin+KTX

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 هر سند دریافت شده از باطن را برای دسترسی آفلاین ذخیره می کند. Cloud Firestore یک آستانه پیش فرض برای اندازه کش تعیین می کند. پس از فراتر رفتن از پیش‌فرض، Cloud Firestore به‌طور دوره‌ای سعی می‌کند اسناد قدیمی‌تر و استفاده‌نشده را پاک‌سازی کند. می توانید آستانه اندازه کش متفاوتی را پیکربندی کنید یا فرآیند پاکسازی را به طور کامل غیرفعال کنید:

Web

درباره Web API مدولار قابل تکان دادن درخت بیشتر بیاموزید و از API فضای نامی ارتقا دهید .

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

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

Web

درباره Web API مدولار قابل تکان دادن درخت بیشتر بیاموزید و از API فضای نامی ارتقا دهید .

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

هدف-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;
ViewController.m
  

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

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

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

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

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

Web

درباره Web API مدولار قابل تکان دادن درخت بیشتر بیاموزید و از 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);
    });
});
use_from_cache.js

Web

درباره Web API مدولار قابل تکان دادن درخت بیشتر بیاموزید و از 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);
      });
  });
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

هدف-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);
    }];
ViewController.m

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

هدف-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

درباره Web API مدولار قابل تکان دادن درخت بیشتر بیاموزید و از API فضای نامی ارتقا دهید .

import { disableNetwork } from "firebase/firestore"; 

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

Web

درباره Web API مدولار قابل تکان دادن درخت بیشتر بیاموزید و از API فضای نامی ارتقا دهید .

firebase.firestore().disableNetwork()
    .then(() => {
        // Do offline actions
        // ...
    });
test.firestore.js

سویفت

توجه: این محصول در اهداف watchOS و App Clip موجود نیست.

Firestore.firestore().disableNetwork { (error) in
  // Do offline things
  // ...
}
ViewController.swift

هدف-C

توجه: این محصول در اهداف watchOS و App Clip موجود نیست.

[[FIRFirestore firestore] disableNetworkWithCompletion:^(NSError *_Nullable error) {
  // Do offline actions
  // ...
}];
ViewController.m

Kotlin+KTX

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

درباره Web API مدولار قابل تکان دادن درخت بیشتر بیاموزید و از API فضای نامی ارتقا دهید .

import { enableNetwork } from "firebase/firestore"; 

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

Web

درباره Web API مدولار قابل تکان دادن درخت بیشتر بیاموزید و از API فضای نامی ارتقا دهید .

firebase.firestore().enableNetwork()
    .then(() => {
        // Do online actions
        // ...
    });
test.firestore.js

سویفت

توجه: این محصول در اهداف watchOS و App Clip موجود نیست.

Firestore.firestore().enableNetwork { (error) in
  // Do online things
  // ...
}
ViewController.swift

هدف-C

توجه: این محصول در اهداف watchOS و App Clip موجود نیست.

[[FIRFirestore firestore] enableNetworkWithCompletion:^(NSError *_Nullable error) {
  // Do online actions
  // ...
}];
ViewController.m

Kotlin+KTX

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