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

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

डिस्क पर डेटा सेव करने की सुविधा

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

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

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

Kotlin

Firebase.database.setPersistenceEnabled(true)OfflineActivity.kt

Java

FirebaseDatabase.getInstance().setPersistenceEnabled(true);OfflineActivity.java

डेटा सेव करने की सुविधा का काम करने का तरीका

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

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

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

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

Firebase Realtime Database चालू लिसनर के लिए डेटा की स्थानीय कॉपी को सिंक और सेव करता है. इसके अलावा, खास जगहों को सिंक में रखा जा सकता है.

Kotlin

val scoresRef = Firebase.database.getReference("scores")
scoresRef.keepSynced(true)OfflineActivity.kt

Java

DatabaseReference scoresRef = FirebaseDatabase.getInstance().getReference("scores");
scoresRef.keepSynced(true);OfflineActivity.java

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

Kotlin

scoresRef.keepSynced(false)OfflineActivity.kt

Java

scoresRef.keepSynced(false);OfflineActivity.java

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

ऑफ़लाइन होने पर डेटा के लिए क्वेरी करना

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

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

Kotlin

val scoresRef = Firebase.database.getReference("scores")
scoresRef.orderByValue().limitToLast(4).addChildEventListener(object : ChildEventListener {
    override fun onChildAdded(snapshot: DataSnapshot, previousChild: String?) {
        Log.d(TAG, "The ${snapshot.key} dinosaur's score is ${snapshot.value}")
    }

    // ...
})OfflineActivity.kt

Java

DatabaseReference scoresRef = FirebaseDatabase.getInstance().getReference("scores");
scoresRef.orderByValue().limitToLast(4).addChildEventListener(new ChildEventListener() {
    @Override
    public void onChildAdded(@NonNull DataSnapshot snapshot, String previousChild) {
        Log.d(TAG, "The " + snapshot.getKey() + " dinosaur's score is " + snapshot.getValue());
    }

    // ...
});OfflineActivity.java

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

Kotlin

scoresRef.orderByValue().limitToLast(2).addChildEventListener(object : ChildEventListener {
    override fun onChildAdded(snapshot: DataSnapshot, previousChild: String?) {
        Log.d(TAG, "The ${snapshot.key} dinosaur's score is ${snapshot.value}")
    }

    // ...
})OfflineActivity.kt

Java

scoresRef.orderByValue().limitToLast(2).addChildEventListener(new ChildEventListener() {
    @Override
    public void onChildAdded(@NonNull DataSnapshot snapshot, String previousChild) {
        Log.d(TAG, "The " + snapshot.getKey() + " dinosaur's score is " + snapshot.getValue());
    }

    // ...
});OfflineActivity.java

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

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

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

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

ऐप्लिकेशन को रीस्टार्ट करने पर, लेन-देन सेव नहीं होते

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

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

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

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

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

Kotlin

val presenceRef = Firebase.database.getReference("disconnectmessage")
// Write a string when this client loses connection
presenceRef.onDisconnect().setValue("I disconnected!")OfflineActivity.kt

Java

DatabaseReference presenceRef = FirebaseDatabase.getInstance().getReference("disconnectmessage");
// Write a string when this client loses connection
presenceRef.onDisconnect().setValue("I disconnected!");OfflineActivity.java

onDisconnect का काम करने का तरीका

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

आपका ऐप्लिकेशन, सेव करने की कार्रवाई पर कॉलबैक का इस्तेमाल करके, यह पक्का कर सकता है कि onDisconnect सही तरीके से अटैच किया गया है या नहीं:

Kotlin

presenceRef.onDisconnect().removeValue { error, reference ->
    error?.let {
        Log.d(TAG, "could not establish onDisconnect event: ${error.message}")
    }
}OfflineActivity.kt

Java

presenceRef.onDisconnect().removeValue(new DatabaseReference.CompletionListener() {
    @Override
    public void onComplete(DatabaseError error, @NonNull DatabaseReference reference) {
        if (error != null) {
            Log.d(TAG, "could not establish onDisconnect event:" + error.getMessage());
        }
    }
});OfflineActivity.java

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

Kotlin

val onDisconnectRef = presenceRef.onDisconnect()
onDisconnectRef.setValue("I disconnected")
// ...
// some time later when we change our minds
// ...
onDisconnectRef.cancel()OfflineActivity.kt

Java

OnDisconnect onDisconnectRef = presenceRef.onDisconnect();
onDisconnectRef.setValue("I disconnected");
// ...
// some time later when we change our minds
// ...
onDisconnectRef.cancel();OfflineActivity.java

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

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

Kotlin

val connectedRef = Firebase.database.getReference(".info/connected")
connectedRef.addValueEventListener(object : ValueEventListener {
    override fun onDataChange(snapshot: DataSnapshot) {
        val connected = snapshot.getValue(Boolean::class.java) ?: false
        if (connected) {
            Log.d(TAG, "connected")
        } else {
            Log.d(TAG, "not connected")
        }
    }

    override fun onCancelled(error: DatabaseError) {
        Log.w(TAG, "Listener was cancelled")
    }
})OfflineActivity.kt

Java

DatabaseReference connectedRef = FirebaseDatabase.getInstance().getReference(".info/connected");
connectedRef.addValueEventListener(new ValueEventListener() {
    @Override
    public void onDataChange(@NonNull DataSnapshot snapshot) {
        boolean connected = snapshot.getValue(Boolean.class);
        if (connected) {
            Log.d(TAG, "connected");
        } else {
            Log.d(TAG, "not connected");
        }
    }

    @Override
    public void onCancelled(@NonNull DatabaseError error) {
        Log.w(TAG, "Listener was cancelled");
    }
});OfflineActivity.java

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

Android पर, Firebase, बैंडविड्थ और बैटरी के इस्तेमाल को कम करने के लिए, कनेक्शन के स्टेटस को अपने-आप मैनेज करता है. जब किसी क्लाइंट के पास कोई चालू लिसनर, सेव करने या onDisconnect की कोई लंबित कार्रवाई नहीं होती है और goOffline तरीके से उसे साफ़ तौर पर डिसकनेक्ट नहीं किया जाता है, तो Firebase, 60 सेकंड तक कोई गतिविधि न होने पर कनेक्शन बंद कर देता है.

इंतज़ार के समय को मैनेज करना

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

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

Kotlin

val userLastOnlineRef = Firebase.database.getReference("users/joe/lastOnline")
userLastOnlineRef.onDisconnect().setValue(ServerValue.TIMESTAMP)OfflineActivity.kt

Java

DatabaseReference userLastOnlineRef = FirebaseDatabase.getInstance().getReference("users/joe/lastOnline");
userLastOnlineRef.onDisconnect().setValue(ServerValue.TIMESTAMP);OfflineActivity.java

घड़ी में अंतर

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

Kotlin

val offsetRef = Firebase.database.getReference(".info/serverTimeOffset")
offsetRef.addValueEventListener(object : ValueEventListener {
    override fun onDataChange(snapshot: DataSnapshot) {
        val offset = snapshot.getValue(Double::class.java) ?: 0.0
        val estimatedServerTimeMs = System.currentTimeMillis() + offset
    }

    override fun onCancelled(error: DatabaseError) {
        Log.w(TAG, "Listener was cancelled")
    }
})OfflineActivity.kt

Java

DatabaseReference offsetRef = FirebaseDatabase.getInstance().getReference(".info/serverTimeOffset");
offsetRef.addValueEventListener(new ValueEventListener() {
    @Override
    public void onDataChange(@NonNull DataSnapshot snapshot) {
        double offset = snapshot.getValue(Double.class);
        double estimatedServerTimeMs = System.currentTimeMillis() + offset;
    }

    @Override
    public void onCancelled(@NonNull DatabaseError error) {
        Log.w(TAG, "Listener was cancelled");
    }
});OfflineActivity.java

मौजूदगी दिखाने वाला सैंपल ऐप्लिकेशन

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

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

यहां उपयोगकर्ता की मौजूदगी दिखाने वाला एक आसान सिस्टम दिया गया है:

Kotlin

// 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
val database = Firebase.database
val myConnectionsRef = database.getReference("users/joe/connections")

// Stores the timestamp of my last disconnect (the last time I was seen online)
val lastOnlineRef = database.getReference("/users/joe/lastOnline")

val connectedRef = database.getReference(".info/connected")
connectedRef.addValueEventListener(object : ValueEventListener {
    override fun onDataChange(snapshot: DataSnapshot) {
        val connected = snapshot.getValue<Boolean>() ?: false
        if (connected) {
            val con = myConnectionsRef.push()

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

            // When I disconnect, update the last time I was seen online
            lastOnlineRef.onDisconnect().setValue(ServerValue.TIMESTAMP)

            // Add this device to my connections list
            // this value could contain info about the device or a timestamp too
            con.setValue(java.lang.Boolean.TRUE)
        }
    }

    override fun onCancelled(error: DatabaseError) {
        Log.w(TAG, "Listener was cancelled at .info/connected")
    }
})OfflineActivity.kt

Java

// 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 FirebaseDatabase database = FirebaseDatabase.getInstance();
final DatabaseReference myConnectionsRef = database.getReference("users/joe/connections");

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

final DatabaseReference connectedRef = database.getReference(".info/connected");
connectedRef.addValueEventListener(new ValueEventListener() {
    @Override
    public void onDataChange(@NonNull DataSnapshot snapshot) {
        boolean connected = snapshot.getValue(Boolean.class);
        if (connected) {
            DatabaseReference con = myConnectionsRef.push();

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

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

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

    @Override
    public void onCancelled(@NonNull DatabaseError error) {
        Log.w(TAG, "Listener was cancelled at .info/connected");
    }
});OfflineActivity.java