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

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

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

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

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

कोड की सिर्फ़ एक लाइन से, डिस्क का स्थायी तौर पर रखरखाव किया जा सकता है.

Kotlin+KTX

Firebase.database.setPersistenceEnabled(true)
OfflineActivity.kt

Java

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

स्थायी व्यवहार

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

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

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

डेटा को नया बनाए रखना

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

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

Kotlin+KTX

scoresRef.keepSynced(false)
OfflineActivity.kt

Java

scoresRef.keepSynced(false);
OfflineActivity.java

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

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

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

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

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 रीयल टाइम डेटाबेस क्लाइंट, परसिस्टेंट कैश मेमोरी का इस्तेमाल करके, सबसे ज़्यादा स्कोर पाने वाले दो डायनासॉर के लिए 'बच्चे के जोड़े' इवेंट को बढ़ाता है. हालांकि, इससे 'वैल्यू' इवेंट नहीं होगा, क्योंकि ऐप्लिकेशन ने ऑनलाइन रहते हुए उस क्वेरी को कभी एक्ज़ीक्यूट नहीं किया.

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

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

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

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

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

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

आपका ऐप्लिकेशन, लिखने की कार्रवाई पर कॉलबैक का इस्तेमाल कर सकता है, ताकि यह पक्का किया जा सके कि 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

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

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

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 एक बूलियन वैल्यू है, जो रीयल टाइम डेटाबेस क्लाइंट के बीच सिंक नहीं की जाती, क्योंकि वैल्यू, क्लाइंट की स्थिति पर निर्भर करती है. दूसरे शब्दों में, अगर एक क्लाइंट /.info/connected को गलत के तौर पर पढ़ता है, तो इस बात की कोई गारंटी नहीं है कि कोई दूसरा क्लाइंट भी 'गलत' पढ़ेगा.

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

हैंडलिंग में लगने वाले समय का अंतर

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

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

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 रीयल टाइम डेटाबेस के सर्वर के हिसाब से, क्लाइंट के समय में बदलाव का अनुमान लगाने में मदद कर सकता है. /.info/serverTimeOffset जगह पर कॉलबैक अटैच करके, मिलीसेकंड में वैल्यू पाई जा सकती है. Firebase रीयल टाइम डेटाबेस क्लाइंट, सर्वर के समय का अनुमान लगाने के लिए, रिपोर्ट किए गए स्थानीय समय (मिलीसेकंड में Epoch समय) में जो वैल्यू जोड़ता है. ध्यान दें कि इस ऑफ़सेट के सटीक होने पर, नेटवर्किंग में लगने वाले समय की वजह से असर पड़ सकता है. इसलिए, इसका इस्तेमाल खास तौर पर, क्लॉक टाइम (एक सेकंड से ज़्यादा) में बड़े अंतर का पता लगाने के लिए किया जाता है.

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

मौजूदगी ऐप्लिकेशन का नमूना

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

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

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

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