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

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

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

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

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

सैंपल के तौर पर उपलब्ध Presence ऐप्लिकेशन

कनेक्शन की स्थिति की निगरानी करने और सर्वर के टाइमस्टैंप के साथ डिसकनेक्ट करने की कार्रवाइयों को मिलाकर, उपयोगकर्ता की मौजूदगी का सिस्टम बनाया जा सकता है. इस सिस्टम में, हर उपयोगकर्ता डेटा को डेटाबेस की किसी जगह पर सेव करता है. इससे यह पता चलता है कि 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