获取我们在 Firebase 峰会上发布的所有信息,了解 Firebase 可如何帮助您加快应用开发速度并满怀信心地运行应用。了解详情

Verilere çevrimdışı erişin

Cloud Firestore, çevrimdışı veri kalıcılığını destekler. Bu özellik, uygulamanızın aktif olarak kullandığı Cloud Firestore verilerinin bir kopyasını önbelleğe alır, böylece uygulamanız cihaz çevrimdışıyken verilere erişebilir. Önbelleğe alınan verileri yazabilir, okuyabilir, dinleyebilir ve sorgulayabilirsiniz. Cihaz tekrar çevrimiçi olduğunda Cloud Firestore, uygulamanız tarafından yapılan tüm yerel değişiklikleri Cloud Firestore arka ucuyla senkronize eder.

Çevrimdışı kalıcılığı kullanmak için Cloud Firestore verilerine erişmek için kullandığınız kodda herhangi bir değişiklik yapmanız gerekmez. Çevrimdışı kalıcılık etkinleştirildiğinde, Cloud Firestore istemci kitaplığı, çevrimiçi ve çevrimdışı veri erişimini otomatik olarak yönetir ve cihaz tekrar çevrimiçi olduğunda yerel verileri senkronize eder.

Çevrimdışı kalıcılığı yapılandırın

Cloud Firestore'u başlattığınızda, çevrimdışı kalıcılığı etkinleştirebilir veya devre dışı bırakabilirsiniz:

  • Android ve Apple platformları için çevrimdışı kalıcılık varsayılan olarak etkindir. Kalıcılığı devre dışı bırakmak için PersistenceEnabled seçeneğini false olarak ayarlayın.
  • Web için çevrimdışı kalıcılık varsayılan olarak devre dışıdır. Kalıcılığı etkinleştirmek için enablePersistence yöntemini çağırın. Cloud Firestore'un önbelleği, oturumlar arasında otomatik olarak temizlenmez. Sonuç olarak, web uygulamanız hassas bilgileri işliyorsa kalıcılığı etkinleştirmeden önce kullanıcıya güvenilir bir cihazda olup olmadıklarını sorduğunuzdan emin olun.

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
Süratli
Not: Bu ürün, watchOS ve App Clip hedeflerinde mevcut değildir.
let settings = FirestoreSettings()
settings.isPersistenceEnabled = true

// Any additional options
// ...

// Enable offline data persistence
let db = Firestore.firestore()
db.settings = settings
Amaç-C
Not: Bu ürün, watchOS ve App Clip hedeflerinde mevcut değildir.
FIRFirestoreSettings *settings = [[FIRFirestoreSettings alloc] init];
settings.persistenceEnabled = YES;

// Any additional options
// ...

// Enable offline data persistence
FIRFirestore *db = [FIRFirestore firestore];
db.settings = settings;

Java

FirebaseFirestoreSettings settings = new FirebaseFirestoreSettings.Builder()
        .setPersistenceEnabled(true)
        .build();
db.setFirestoreSettings(settings);

Kotlin+KTX

val settings = firestoreSettings {
    isPersistenceEnabled = true
}
db.firestoreSettings = settings

Dart

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

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

Önbellek boyutunu yapılandır

Kalıcılık etkinleştirildiğinde, Cloud Firestore, çevrimdışı erişim için arka uçtan alınan her belgeyi önbelleğe alır. Cloud Firestore, önbellek boyutu için varsayılan bir eşik ayarlar. Varsayılanı aştıktan sonra Cloud Firestore, eski, kullanılmayan belgeleri düzenli aralıklarla temizlemeye çalışır. Farklı bir önbellek boyutu eşiği yapılandırabilir veya temizleme işlemini tamamen devre dışı bırakabilirsiniz:

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
});
Süratli
Not: Bu ürün, watchOS ve App Clip hedeflerinde mevcut değildir.
// 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
Amaç-C
Not: Bu ürün, watchOS ve App Clip hedeflerinde mevcut değildir.
// 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;
  

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

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

Dart

db.settings = const Settings(
  persistenceEnabled: true,
  cacheSizeBytes: Settings.CACHE_SIZE_UNLIMITED,
);

Çevrimdışı verileri dinleyin

Cihaz çevrimdışıyken, çevrimdışı kalıcılığı etkinleştirdiyseniz, yerel olarak önbelleğe alınan veriler değiştiğinde dinleyicileriniz dinleme olaylarını alır. Belgeleri, koleksiyonları ve sorguları dinleyebilirsiniz.

Sunucudan mı yoksa önbellekten mi veri alıp almadığınızı kontrol etmek için, anlık görüntü olayınızdaki SnapshotMetadata üzerindeki fromCache özelliğini kullanın. fromCache true ise, veriler önbellekten geldi ve eski veya eksik olabilir. fromCache false ise, veriler sunucudaki en son güncellemelerle eksiksiz ve günceldir.

Varsayılan olarak, yalnızca SnapshotMetadata değiştiyse hiçbir olay başlatılmaz. fromCache değerlerine güveniyorsanız, dinleme işleyicinizi eklediğinizde includeMetadataChanges dinleme seçeneğini belirtin.

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);
      });
  });
Süratli
Not: Bu ürün, watchOS ve App Clip hedeflerinde mevcut değildir.
// 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)")
}
Amaç-C
Not: Bu ürün, watchOS ve App Clip hedeflerinde mevcut değildir.
// 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);
    }];

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

            }
        });

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

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

Çevrimdışı verileri alın

Cihaz çevrimdışıyken bir belge alırsanız Cloud Firestore, önbellekten veri döndürür.

Bir koleksiyonu sorgularken, önbelleğe alınmış belge yoksa boş bir sonuç döndürülür. Belirli bir belgeyi getirirken bunun yerine bir hata döndürülür.

Çevrimdışı verileri sorgula

Sorgulama, çevrimdışı kalıcılıkla çalışır. Sorguların sonuçlarını, önceki bölümlerde açıklandığı gibi, doğrudan bir alma ile veya dinleyerek alabilirsiniz. Aygıt çevrimdışıyken yerel olarak kalıcı veriler üzerinde de yeni sorgular oluşturabilirsiniz, ancak sorgular başlangıçta yalnızca önbelleğe alınmış belgelere karşı çalışır.

Çevrimdışı sorgu dizinlerini yapılandırın

Varsayılan olarak, Firestore SDK, çevrimdışı sorguları yürütürken yerel önbelleğindeki bir koleksiyondaki tüm belgeleri tarar. Bu varsayılan davranışla, kullanıcılar uzun süre çevrimdışı olduklarında çevrimdışı sorgu performansı düşebilir.

Apple platformu , Android ve JavaScript SDK'ları, çevrimdışı sorgularınızın performansını artırmak için yerel sorgu dizinlerini yapılandırmanıza olanak tanıyan bir setIndexConfiguration yöntemi sağlar.

Bu yöntemler, aynı dizin tanımı biçimini izleyerek sunucudaki dizinleri yapılandırmak için kullanılan aynı JSON yapılı yapılandırmayı okur.

Kullanılacak çevrimdışı dizin yapılandırması, çevrimdışıyken uygulamanızın yoğun olarak hangi koleksiyonlara ve belgelere eriştiğine ve istediğiniz çevrimdışı performansa bağlıdır. İstemcide kullanım için arka uç dizin yapılandırmanızı dışa aktarabilirsiniz, ancak uygulamanızın çevrimdışı erişim kalıpları büyük olasılıkla çevrimiçi erişim kalıplarından önemli ölçüde farklıdır, bu nedenle çevrimiçi dizin yapılandırmanız çevrimdışı kullanım için uygun olmayabilir. Uygulamanızın yüksek performansla çevrimdışı olarak hangi koleksiyonlara ve belgelere erişmesini istiyorsunuz? Uygulamanızın davranışını analiz ettikten sonra, dizin oluşturma kılavuzundaki dizin tanımı ilkelerini izleyin.

İstemci uygulamanızda çevrimdışı dizin yapılandırmalarını yüklemeye hazır hale getirmek için:

  • bunları uygulamanızla derleyin ve dağıtın
  • onları bir CDN'den indirin
  • bunları Firebase için Cloud Storage gibi bir depolama sisteminden alın.

Ağ erişimini devre dışı bırakın ve etkinleştirin

Cloud Firestore istemciniz için ağ erişimini devre dışı bırakmak için aşağıdaki yöntemi kullanabilirsiniz. Ağ erişimi devre dışı bırakıldığında, tüm anlık görüntü dinleyicileri ve belge istekleri, sonuçları önbellekten alır. Ağ erişimi yeniden etkinleştirilene kadar yazma işlemleri sıraya alınır.

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
        // ...
    });
Süratli
Not: Bu ürün, watchOS ve App Clip hedeflerinde mevcut değildir.
Firestore.firestore().disableNetwork { (error) in
    // Do offline things
    // ...
}
Amaç-C
Not: Bu ürün, watchOS ve App Clip hedeflerinde mevcut değildir.
[[FIRFirestore firestore] disableNetworkWithCompletion:^(NSError *_Nullable error) {
  // Do offline actions
  // ...
}];

Java

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

Kotlin+KTX

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

Dart

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

Ağ erişimini yeniden etkinleştirmek için aşağıdaki yöntemi kullanın:

Web version 9

import { enableNetwork } from "firebase/firestore"; 

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

Web version 8

firebase.firestore().enableNetwork()
    .then(() => {
        // Do online actions
        // ...
    });
Süratli
Not: Bu ürün, watchOS ve App Clip hedeflerinde mevcut değildir.
Firestore.firestore().enableNetwork { (error) in
    // Do online things
    // ...
}
Amaç-C
Not: Bu ürün, watchOS ve App Clip hedeflerinde mevcut değildir.
[[FIRFirestore firestore] enableNetworkWithCompletion:^(NSError *_Nullable error) {
  // Do online actions
  // ...
}];

Java

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

Kotlin+KTX

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

Dart

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