了解 2023 年 Google I/O 大会上介绍的 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 cihaz çevrimdışıyken uygulamanız 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 modular API

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

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

// Use memory-only cache
settings.cacheSettings =
    MemoryCacheSettings(garbageCollectorSettings: MemoryLRUGCSettings())

// Use persistent disk cache, with 1 MB cache size
settings.cacheSettings = PersistentCacheSettings(sizeBytes: 1_000_000)

// Any additional options
// ...

// Enable offline data persistence
let db = Firestore.firestore()
db.settings = settings
ViewController.swift
Amaç-C
Not: Bu ürün, watchOS ve App Clip hedeflerinde mevcut değildir.
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 1 million bytes, or 1 MB.
settings.cacheSettings = [[FIRPersistentCacheSettings alloc] initWithSizeBytes:@1000000];

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

Önbellek boyutunu yapılandırın

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

Web modular API

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

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

Web namespaced API

firebase.firestore().settings({
    cacheSizeBytes: firebase.firestore.CACHE_SIZE_UNLIMITED
});
test.firestore.js
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
// Set cache size to 1 MB
settings.cacheSettings = PersistentCacheSettings(sizeBytes: 1_000_000)
Firestore.firestore().settings = settings
ViewController.swift
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;
// Set cache size to 1 MB
settings.cacheSettings =
    [[FIRPersistentCacheSettings alloc] initWithSizeBytes:@1000000];
[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

Çevrimdışı verileri dinle

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

Sunucudan mı yoksa önbellekten mi veri aldığı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 eksiksizdir ve sunucudaki en son güncellemelerle günceldir.

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

Web modular 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 namespaced 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
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)")
}
ViewController.swift
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);
    }];
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

Çevrimdışı verileri al

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

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

Çevrimdışı verileri sorgula

Sorgulama, çevrimdışı kalıcılıkla çalışır. Önceki bölümlerde açıklandığı gibi, sorguların sonuçlarını doğrudan alma ile veya dinleyerek alabilirsiniz. Cihaz ç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ırma

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ışı kaldıklarında çevrimdışı sorgu performansı düşebilir.

Yerel sorgu dizinlerini yapılandırarak çevrimdışı sorguların performansını iyileştirebilirsiniz:

Süratli

Apple platformu SDK'sı, aynı dizin tanımlama biçimini izleyerek sunucudaki dizinleri yapılandırmak için kullanılan aynı JSON yapılı yapılandırmayı okuyan bir setIndexConfiguration yöntemi sağlar.

// You will normally read this from a file asset or cloud storage.
let indexConfigJson = """
  {
    indexes: [
        ...
    ],
    fieldOverrides: [
        ...
    ]
  }
"""

// Apply the configuration.
Firestore.firestore().setIndexConfiguration(indexConfigJson)
Amaç-C

Apple platformu SDK'sı, setIndexConfiguration - aynı dizin tanımlama biçimini izleyerek sunucudaki dizinleri yapılandırmak için kullanılan aynı JSON yapılı yapılandırmayı okuyan yöntemler sağlar.

// 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, aynı dizin tanım biçimini izleyerek sunucudaki dizinleri yapılandırmak için kullanılan aynı JSON yapılı yapılandırmayı okuyan bir setIndexConfiguration yöntemi sağlar.

// 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, aynı dizin tanım biçimini izleyerek sunucudaki dizinleri yapılandırmak için kullanılan aynı JSON yapılı yapılandırmayı okuyan bir setIndexConfiguration yöntemi sağlar.

// 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, aynı dizin tanımlama biçimini izleyerek sunucudaki dizinleri yapılandırmak için kullanılan aynı JSON yapılı yapılandırmayı okuyan bir setIndexConfigurationFromJSON yöntemi sağlar.

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

Alternatif olarak, dizinleri sınıf tabanlı bir API ile yapılandırmak için setIndexConfiguration yöntemini kullanabilirsiniz.

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

Kullanılacak çevrimdışı dizin yapılandırması, uygulamanızın çevrimdışıyken yoğun olarak hangi koleksiyonlara ve belgelere eriştiğine ve istediğiniz çevrimdışı performansa bağlıdır. İstemcide kullanmak için arka uç dizin yapılandırmanızı dışa aktarabilseniz de, uygulamanızın çevrimdışı erişim kalıpları büyük olasılıkla çevrimiçi erişim modellerinden ö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 hangi koleksiyonlara ve belgelere yüksek performansla çevrimdışı erişmesini istiyorsunuz? Uygulamanızın davranışını analiz ettikten sonra, dizine ekleme kılavuzundaki dizin tanımı ilkelerini uygulayın.

Çevrimdışı dizin yapılandırmalarını istemci uygulamanızda yüklemeye uygun hale getirmek için:

  • bunları uygulamanızla derleyin ve dağıtın
  • bunları bir CDN'den indirin
  • bunları Firebase için Bulut Depolama 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 üzere aşağıdaki yöntemi kullanabilirsiniz. Ağ erişimi devre dışıyken, tüm anlık görüntü dinleyicileri ve belge istekleri sonuçları önbellekten alır. Yazma işlemleri, ağ erişimi yeniden etkinleştirilene kadar kuyruğa alınır.

Web modular API

import { disableNetwork } from "firebase/firestore"; 

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

Web namespaced API

firebase.firestore().disableNetwork()
    .then(() => {
        // Do offline actions
        // ...
    });
test.firestore.js
Süratli
Not: Bu ürün, watchOS ve App Clip hedeflerinde mevcut değildir.
Firestore.firestore().disableNetwork { (error) in
    // Do offline things
    // ...
}
ViewController.swift
Amaç-C
Not: Bu ürün, watchOS ve App Clip hedeflerinde mevcut değildir.
[[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

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

Web modular API

import { enableNetwork } from "firebase/firestore"; 

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

Web namespaced API

firebase.firestore().enableNetwork()
    .then(() => {
        // Do online actions
        // ...
    });
test.firestore.js
Süratli
Not: Bu ürün, watchOS ve App Clip hedeflerinde mevcut değildir.
Firestore.firestore().enableNetwork { (error) in
    // Do online things
    // ...
}
ViewController.swift
Amaç-C
Not: Bu ürün, watchOS ve App Clip hedeflerinde mevcut değildir.
[[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