Catch up on everything announced at Firebase Summit, and learn how Firebase can help you accelerate app development and run your app with confidence. Learn More

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

تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.

يدعم Cloud Firestore استمرارية البيانات في وضع عدم الاتصال. تقوم هذه الميزة بتخزين نسخة من بيانات Cloud Firestore التي يستخدمها تطبيقك بشكل نشط ، حتى يتمكن تطبيقك من الوصول إلى البيانات عندما يكون الجهاز غير متصل بالإنترنت. يمكنك كتابة البيانات المخزنة مؤقتًا وقراءتها والاستماع إليها والاستعلام عنها. عندما يعود الجهاز متصلاً بالإنترنت ، يقوم Cloud Firestore بمزامنة أي تغييرات محلية يتم إجراؤها بواسطة تطبيقك مع الواجهة الخلفية لـ Cloud Firestore.

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

تكوين الاستمرار في وضع عدم الاتصال

عند تهيئة Cloud Firestore ، يمكنك تمكين أو تعطيل الاستمرار في وضع عدم الاتصال:

  • بالنسبة لأنظمة Android و Apple ، يتم تمكين الاستمرار في وضع عدم الاتصال افتراضيًا. لتعطيل الثبات ، اضبط خيار 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
سويفت
ملاحظة: هذا المنتج غير متوفر على أهداف watchOS و App Clip.
let settings = FirestoreSettings()
settings.isPersistenceEnabled = true

// Any additional options
// ...

// Enable offline data persistence
let db = Firestore.firestore()
db.settings = settings
ج موضوعية
ملاحظة: هذا المنتج غير متوفر على أهداف watchOS و App Clip.
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
});
سويفت
ملاحظة: هذا المنتج غير متوفر على أهداف 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
settings.cacheSizeBytes = FirestoreCacheSizeUnlimited
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;
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 في حدث اللقطة. إذا كانت 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);
      });
  });
سويفت
ملاحظة: هذا المنتج غير متوفر على أهداف 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 بمسح جميع المستندات في مجموعة في ذاكرة التخزين المؤقت المحلية الخاصة بها عند تنفيذ الاستعلامات دون اتصال. باستخدام هذا السلوك الافتراضي ، يمكن أن يتأثر أداء الاستعلام دون اتصال عندما يكون المستخدمون غير متصلين لفترات طويلة من الوقت.

يمكنك تحسين أداء الاستعلامات دون اتصال من خلال تكوين فهارس الاستعلامات المحلية:

سويفت

توفر منصة Apple SDK طريقة 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)
ج موضوعية

يوفر نظام Apple الأساسي 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

يوفر setIndexConfigurationFromJSON 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 لتكوين الفهارس باستخدام واجهة برمجة تطبيقات تعتمد على الفئة.

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 for 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
        // ...
    });
سويفت
ملاحظة: هذا المنتج غير متوفر على أهداف 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 version 9

import { enableNetwork } from "firebase/firestore"; 

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

Web version 8

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