ऑफ़लाइन क्षमताएं चालू करना

अगर आपके ऐप्लिकेशन का नेटवर्क कनेक्शन कुछ समय के लिए बंद हो जाता है, तब भी Firebase ऐप्लिकेशन काम करते हैं. इसके अलावा, Firebase डेटा को स्थानीय तौर पर सेव करने, मौजूदगी को मैनेज करने, और लेटेन्सी को मैनेज करने के लिए टूल उपलब्ध कराता है.

डिस्क पर्सिस्टेंस

Firebase ऐप्लिकेशन, नेटवर्क में कुछ समय के लिए आने वाली रुकावटों को अपने-आप ठीक कर लेते हैं. कैश मेमोरी में सेव किया गया डेटा, ऑफ़लाइन होने पर भी उपलब्ध होता है. नेटवर्क कनेक्शन ठीक होने पर, Firebase सभी राइट ऑपरेशन फिर से भेजता है.

डिस्क पर डेटा सेव करने की सुविधा चालू करने पर, आपका ऐप्लिकेशन डेटा को डिवाइस पर सेव करता है. इससे ऐप्लिकेशन ऑफ़लाइन होने पर भी अपनी स्थिति बनाए रख सकता है. ऐसा तब भी होता है, जब उपयोगकर्ता या ऑपरेटिंग सिस्टम ऐप्लिकेशन को रीस्टार्ट करता है.

सिर्फ़ एक लाइन के कोड की मदद से, डिस्क पर डेटा सेव करने की सुविधा चालू की जा सकती है.

FirebaseDatabase.instance.setPersistenceEnabled(true);

स्थायी कुकी के काम करने का तरीका

डेटा को सेव रखने की सुविधा चालू करने पर, Firebase रीयलटाइम डेटाबेस क्लाइंट ऑनलाइन होने पर जिस डेटा को सिंक करता है वह डिस्क में सेव रहता है. साथ ही, यह ऑफ़लाइन होने पर भी उपलब्ध रहता है. ऐसा तब भी होता है, जब उपयोगकर्ता या ऑपरेटिंग सिस्टम ऐप्लिकेशन को फिर से चालू करता है. इसका मतलब है कि आपका ऐप्लिकेशन, कैश मेमोरी में सेव किए गए स्थानीय डेटा का इस्तेमाल करके, ऑनलाइन की तरह काम करता है. स्थानीय अपडेट के लिए, लिसनर कॉलबैक ट्रिगर होते रहेंगे.

Firebase रीयलटाइम डेटाबेस क्लाइंट, आपके ऐप्लिकेशन के ऑफ़लाइन होने पर की गई सभी राइट कार्रवाइयों की एक सूची अपने-आप बना लेता है. डेटा को सेव करने की सुविधा चालू होने पर, इस क्यू को डिस्क में भी सेव किया जाता है. इससे, जब उपयोगकर्ता या ऑपरेटिंग सिस्टम ऐप्लिकेशन को फिर से चालू करता है, तब आपके सभी राइट उपलब्ध होते हैं. जब ऐप्लिकेशन को फिर से कनेक्टिविटी मिलती है, तब सभी कार्रवाइयां Firebase Realtime Database सर्वर को भेज दी जाती हैं.

अगर आपका ऐप्लिकेशन Firebase Authentication का इस्तेमाल करता है, तो Firebase Realtime Database क्लाइंट, ऐप्लिकेशन को फिर से चालू करने पर भी उपयोगकर्ता के पुष्टि करने वाले टोकन को सेव रखता है. अगर आपका ऐप्लिकेशन ऑफ़लाइन होने के दौरान पुष्टि करने वाले टोकन की समयसीमा खत्म हो जाती है, तो क्लाइंट, लिखने की कार्रवाइयों को तब तक रोक देता है, जब तक आपका ऐप्लिकेशन उपयोगकर्ता की फिर से पुष्टि नहीं कर लेता. ऐसा न होने पर, सुरक्षा नियमों की वजह से लिखने की कार्रवाइयां पूरी नहीं हो सकती हैं.

डेटा को अप-टू-डेट रखना

Firebase रीयल टाइम डेटाबेस, ऐक्टिव लिसनर के लिए डेटा की लोकल कॉपी को सिंक और सेव करता है. इसके अलावा, कुछ जगहों की जानकारी को सिंक किया जा सकता है.

final scoresRef = FirebaseDatabase.instance.ref("scores");
scoresRef.keepSynced(true);

Firebase रीयलटाइम डेटाबेस क्लाइंट, इन जगहों पर डेटा अपने-आप डाउनलोड करता है. साथ ही, इसे सिंक रखता है. भले ही, रेफ़रंस में कोई भी ऐक्टिव लिसनर न हो. सिंक्रनाइज़ेशन की सुविधा को फिर से बंद करने के लिए, कोड की इस लाइन का इस्तेमाल करें.

scoresRef.keepSynced(false);

डिफ़ॉल्ट रूप से, पहले सिंक किए गए 10 एमबी डेटा को कैश मेमोरी में सेव किया जाता है. ज़्यादातर ऐप्लिकेशन के लिए यह काफ़ी है. अगर कैश मेमोरी का साइज़, कॉन्फ़िगर किए गए साइज़ से ज़्यादा हो जाता है, तो Firebase Realtime Database उस डेटा को मिटा देता है जिसका इस्तेमाल हाल ही में सबसे कम किया गया है. सिंक किए गए डेटा को कैश मेमोरी से नहीं हटाया जाता.

ऑफ़लाइन डेटा से क्वेरी करना

Firebase रीयलटाइम डेटाबेस, क्वेरी से मिले डेटा को सेव करता है. इसका इस्तेमाल ऑफ़लाइन होने पर किया जाता है. ऑफ़लाइन होने पर बनाई गई क्वेरी के लिए, Firebase रीयलटाइम डेटाबेस, पहले से लोड किए गए डेटा के लिए काम करता रहता है. अगर अनुरोध किया गया डेटा लोड नहीं हुआ है, तो Firebase Realtime Database, लोकल कैश मेमोरी से डेटा लोड करता है. नेटवर्क कनेक्टिविटी फिर से उपलब्ध होने पर, डेटा लोड हो जाता है और क्वेरी दिखने लगती है.

उदाहरण के लिए, यह कोड स्कोर के डेटाबेस में मौजूद आखिरी चार आइटम के लिए क्वेरी करता है:

final scoresRef = FirebaseDatabase.instance.ref("scores");
scoresRef.orderByValue().limitToLast(4).onChildAdded.listen((event) {
  debugPrint("The ${event.snapshot.key} dinosaur's score is ${event.snapshot.value}.");
});

मान लें कि उपयोगकर्ता का इंटरनेट कनेक्शन बंद हो जाता है, वह ऑफ़लाइन हो जाता है, और ऐप्लिकेशन को फिर से चालू करता है. ऑफ़लाइन होने के बावजूद, ऐप्लिकेशन उसी जगह के पिछले दो आइटम के बारे में क्वेरी करता है. इस क्वेरी से, आखिरी दो आइटम दिखेंगे. ऐसा इसलिए होगा, क्योंकि ऐप्लिकेशन ने ऊपर दी गई क्वेरी में सभी चार आइटम लोड किए थे.

scoresRef.orderByValue().limitToLast(2).onChildAdded.listen((event) {
  debugPrint("The ${event.snapshot.key} dinosaur's score is ${event.snapshot.value}.");
});

ऊपर दिए गए उदाहरण में, Firebase Realtime Database क्लाइंट, सबसे ज़्यादा स्कोर वाले दो डायनासोर के लिए 'child added' इवेंट जनरेट करता है. इसके लिए, वह सेव की गई कैश मेमोरी का इस्तेमाल करता है. हालांकि, इससे 'value' इवेंट ट्रिगर नहीं होगा, क्योंकि ऐप्लिकेशन ने ऑनलाइन होने पर कभी उस क्वेरी को नहीं चलाया है.

अगर ऐप्लिकेशन ऑफ़लाइन होने पर पिछले छह आइटम का अनुरोध करता है, तो उसे कैश मेमोरी में सेव किए गए चार आइटम के लिए, 'बच्चा जोड़ा गया' इवेंट तुरंत मिल जाएंगे. डिवाइस के फिर से ऑनलाइन होने पर, Firebase Realtime Database क्लाइंट, सर्वर के साथ सिंक हो जाता है. साथ ही, ऐप्लिकेशन के लिए 'child added' और 'value' इवेंट की आखिरी दो वैल्यू मिल जाती हैं.

ऑफ़लाइन लेन-देन मैनेज करना

ऐप्लिकेशन के ऑफ़लाइन होने पर किए गए सभी लेन-देन को लाइन में लगा दिया जाता है. ऐप्लिकेशन के फिर से इंटरनेट से कनेक्ट होने पर, लेन-देन को Realtime Database सर्वर पर भेज दिया जाता है.

ध्यान दें: ऐप्लिकेशन को फिर से चालू करने पर, लेन-देन की जानकारी सेव नहीं रहती है. परसिस्टेंस की सुविधा चालू होने पर भी, ऐप्लिकेशन को फिर से चालू करने पर लेन-देन की जानकारी सेव नहीं होती. इसलिए, ऑफ़लाइन किए गए लेन-देन को Firebase रीयलटाइम डेटाबेस में सेव नहीं किया जा सकता. उपयोगकर्ताओं को बेहतरीन अनुभव देने के लिए, आपके ऐप्लिकेशन को यह दिखाना चाहिए कि लेन-देन को अब तक आपके Firebase रीयलटाइम डेटाबेस में सेव नहीं किया गया है. इसके अलावा, यह भी पक्का करें कि आपका ऐप्लिकेशन उन्हें मैन्युअल तरीके से याद रखे और ऐप्लिकेशन को फिर से शुरू करने के बाद उन्हें फिर से लागू करे.

Firebase रीयलटाइम डेटाबेस में, ऑफ़लाइन होने और नेटवर्क कनेक्टिविटी से जुड़ी समस्याओं को हल करने के लिए कई सुविधाएं उपलब्ध हैं. इस गाइड में दी गई बाकी जानकारी, आपके ऐप्लिकेशन पर लागू होती है. भले ही, आपने परसिस्टेंस की सुविधा चालू की हो या नहीं.

मौजूदगी की जानकारी मैनेज करना

रीयलटाइम ऐप्लिकेशन में, यह पता लगाना अक्सर काम का होता है कि क्लाइंट कब कनेक्ट और डिसकनेक्ट होते हैं. उदाहरण के लिए, जब कोई क्लाइंट डिसकनेक्ट हो जाता है, तब आपको उपयोगकर्ता को 'ऑफ़लाइन' के तौर पर मार्क करना पड़ सकता है.

Firebase Database क्लाइंट, आसान प्रिमिटिव उपलब्ध कराते हैं. इनका इस्तेमाल, क्लाइंट के Firebase Database सर्वर से डिसकनेक्ट होने पर डेटाबेस में लिखने के लिए किया जा सकता है. ये अपडेट तब भी होते हैं, जब क्लाइंट ठीक से डिसकनेक्ट नहीं होता है. इसलिए, डेटा को साफ़ करने के लिए इन पर भरोसा किया जा सकता है. भले ही, कनेक्शन बंद हो गया हो या क्लाइंट क्रैश हो गया हो. कनेक्शन बंद होने पर, लिखने से जुड़ी सभी कार्रवाइयां की जा सकती हैं. जैसे, सेटिंग करना, अपडेट करना, और हटाना.

यहां onDisconnect प्रिमिटिव का इस्तेमाल करके, कनेक्शन बंद होने पर डेटा लिखने का एक सामान्य उदाहरण दिया गया है:

final presenceRef = FirebaseDatabase.instance.ref("disconnectmessage");
// Write a string when this client loses connection
presenceRef.onDisconnect().set("I disconnected!");

onDisconnect कैसे काम करता है

onDisconnect() ऑपरेशन शुरू करने पर, यह ऑपरेशन Firebase रीयल टाइम डेटाबेस सर्वर पर चलता है. सर्वर, सुरक्षा की जाँच करता है, ताकि यह पक्का किया जा सके कि उपयोगकर्ता, अनुरोध किया गया राइट इवेंट कर सकता है. अगर यह अमान्य है, तो सर्वर आपके ऐप्लिकेशन को इसकी सूचना देता है. इसके बाद, सर्वर कनेक्शन की निगरानी करता है. अगर किसी भी समय कनेक्शन टाइम आउट हो जाता है या Realtime Database क्लाइंट उसे बंद कर देता है, तो सर्वर दूसरी बार सुरक्षा की जांच करता है. इससे यह पक्का किया जाता है कि ऑपरेशन अब भी मान्य है. इसके बाद, सर्वर इवेंट को शुरू करता है.

try {
    await presenceRef.onDisconnect().remove();
} catch (error) {
    debugPrint("Could not establish onDisconnect event: $error");
}

.cancel() को कॉल करके, onDisconnect इवेंट को भी रद्द किया जा सकता है:

final onDisconnectRef = presenceRef.onDisconnect();
onDisconnectRef.set("I disconnected");
// ...
// some time later when we change our minds
// ...
onDisconnectRef.cancel();

कनेक्शन का स्टेटस पता लगाना

उपयोगकर्ता की मौजूदगी से जुड़ी कई सुविधाओं के लिए, आपके ऐप्लिकेशन को यह पता होना चाहिए कि वह ऑनलाइन है या ऑफ़लाइन. Firebase रीयलटाइम डेटाबेस, /.info/connected पर एक खास जगह उपलब्ध कराता है. यह जगह, Firebase रीयलटाइम डेटाबेस क्लाइंट की कनेक्शन स्थिति में बदलाव होने पर अपडेट होती है. यहां एक उदाहरण दिया गया है:

final connectedRef = FirebaseDatabase.instance.ref(".info/connected");
connectedRef.onValue.listen((event) {
  final connected = event.snapshot.value as bool? ?? false;
  if (connected) {
    debugPrint("Connected.");
  } else {
    debugPrint("Not connected.");
  }
});

/.info/connected एक बूलियन वैल्यू है, जो Realtime Database क्लाइंट के बीच सिंक नहीं होती. ऐसा इसलिए होता है, क्योंकि वैल्यू क्लाइंट की स्थिति पर निर्भर करती है. दूसरे शब्दों में कहें, तो अगर कोई क्लाइंट /.info/connected को 'गलत' के तौर पर पढ़ता है, तो इस बात की कोई गारंटी नहीं है कि कोई दूसरा क्लाइंट भी इसे 'गलत' के तौर पर पढ़ेगा.

हैंडलिंग में लगने वाला समय

सर्वर टाइमस्टैंप

Firebase रीयलटाइम डेटाबेस के सर्वर, सर्वर पर जनरेट किए गए टाइमस्टैंप को डेटा के तौर पर डालने का तरीका उपलब्ध कराते हैं. इस सुविधा और onDisconnect का इस्तेमाल करके, यह आसानी से पता लगाया जा सकता है कि Realtime Database क्लाइंट कब डिसकनेक्ट हुआ था:

final userLastOnlineRef =
    FirebaseDatabase.instance.ref("users/joe/lastOnline");
userLastOnlineRef.onDisconnect().set(ServerValue.timestamp);

क्लॉक स्क्यू

ServerValue.timestamp ज़्यादा सटीक है और ज़्यादातर रीड/राइट ऑपरेशन के लिए इसका इस्तेमाल करना बेहतर होता है. हालांकि, कभी-कभी Firebase Realtime Database के सर्वर के हिसाब से क्लाइंट के क्लॉक स्क्यू का अनुमान लगाने के लिए इसका इस्तेमाल किया जा सकता है. आपके पास, /.info/serverTimeOffset लोकेशन में कॉलबैक अटैच करने का विकल्प होता है. इससे आपको मिलीसेकंड में वह वैल्यू मिलती है जिसे Firebase Realtime Database क्लाइंट, सर्वर के समय का अनुमान लगाने के लिए, स्थानीय रिपोर्ट किए गए समय (मिलीसेकंड में इपोक टाइम) में जोड़ते हैं. ध्यान दें कि इस ऑफ़सेट की सटीक जानकारी पर नेटवर्क की वजह से होने वाली देरी का असर पड़ सकता है. इसलिए, यह मुख्य रूप से घड़ी के समय में बड़े (> 1 सेकंड) अंतर का पता लगाने के लिए काम आता है.

final offsetRef = FirebaseDatabase.instance.ref(".info/serverTimeOffset");
offsetRef.onValue.listen((event) {
  final offset = event.snapshot.value as num? ?? 0.0;
  final estimatedServerTimeMs =
      DateTime.now().millisecondsSinceEpoch + offset;
});

सैंपल के तौर पर मौजूद ऐप्लिकेशन

कनेक्शन की स्थिति की निगरानी करने और सर्वर के टाइमस्टैंप के साथ डिसकनेक्ट करने की कार्रवाइयों को मिलाकर, उपयोगकर्ता की मौजूदगी का सिस्टम बनाया जा सकता है. इस सिस्टम में, हर उपयोगकर्ता डेटा को डेटाबेस की किसी जगह पर सेव करता है. इससे यह पता चलता है कि Realtime Database क्लाइंट ऑनलाइन है या नहीं. क्लाइंट, ऑनलाइन होने पर इस जगह की जानकारी को सही पर सेट करते हैं. साथ ही, डिसकनेक्ट होने पर टाइमस्टैंप सेट करते हैं. इस टाइमस्टैंप से पता चलता है कि उपयोगकर्ता पिछली बार कब ऑनलाइन था.

ध्यान दें कि उपयोगकर्ता को ऑनलाइन के तौर पर मार्क करने से पहले, आपके ऐप्लिकेशन को डिसकनेक्ट करने की कार्रवाइयों को लाइन में लगाना चाहिए. इससे, अगर क्लाइंट का नेटवर्क कनेक्शन सर्वर को दोनों कमांड भेजने से पहले ही बंद हो जाता है, तो रेस कंडीशन से बचा जा सकता है.

// Since I can connect from multiple devices, we store each connection
// instance separately any time that connectionsRef's value is null (i.e.
// has no children) I am offline.
final myConnectionsRef =
    FirebaseDatabase.instance.ref("users/joe/connections");

// Stores the timestamp of my last disconnect (the last time I was seen online)
final lastOnlineRef =
    FirebaseDatabase.instance.ref("/users/joe/lastOnline");

final connectedRef = FirebaseDatabase.instance.ref(".info/connected");
connectedRef.onValue.listen((event) {
  final connected = event.snapshot.value as bool? ?? false;
  if (connected) {
    final con = myConnectionsRef.push();

    // When this device disconnects, remove it.
    con.onDisconnect().remove();

    // When I disconnect, update the last time I was seen online.
    lastOnlineRef.onDisconnect().set(ServerValue.timestamp);

    // Add this device to my connections list.
    // This value could contain info about the device or a timestamp too.
    con.set(true);
  }
});