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

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

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

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

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

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

Kotlin+KTX

Firebase.database.setPersistenceEnabled(true)
OfflineActivity.kt

Java

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

पर्सिस्टेंस व्यवहार

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

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

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

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

Firebase Realtime Database, ऑडियंस के डेटा की एक स्थानीय कॉपी सिंक करता है और उसे सेव करता है. इसके अलावा, कुछ जगहों को सिंक भी किया जा सकता है.

Kotlin+KTX

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+KTX

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+KTX

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+KTX

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 डेटाबेस क्लाइंट, आसान प्राइमिटिव उपलब्ध कराते हैं. इनका इस्तेमाल, क्लाइंट के Firebase डेटाबेस सर्वर से डिसकनेक्ट होने पर, डेटाबेस में डेटा लिखने के लिए किया जा सकता है. ये अपडेट तब भी होते हैं, जब क्लाइंट सही तरीके से डिसकनेक्ट नहीं होता है. इसलिए, डेटा को क्लीन अप करने के लिए इन पर भरोसा किया जा सकता है. भले ही, कनेक्शन बंद हो गया हो या क्लाइंट क्रैश हो गया हो. डिसकनेक्ट होने पर, सेटिंग, अपडेट करने, और हटाने जैसे सभी लिखने के काम किए जा सकते हैं.

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

Kotlin+KTX

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+KTX

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

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

Kotlin+KTX

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+KTX

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 को गलत के तौर पर पढ़ता है, तो इस बात की कोई गारंटी नहीं है कि कोई दूसरा क्लाइंट भी गलत पढ़ेगा.

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

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

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

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

Kotlin+KTX

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+KTX

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+KTX

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