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

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

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

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

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

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

Kotlin

Firebase.database.setPersistenceEnabled(true)

Java

FirebaseDatabase.getInstance().setPersistenceEnabled(true);

लगातार होने वाला व्यवहार

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

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

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

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

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

Kotlin

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

Java

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

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

Kotlin

scoresRef.keepSynced(false)

Java

scoresRef.keepSynced(false);

डिफ़ॉल्ट रूप से, पहले से सिंक किए गए 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}")
    }

    // ...
})

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());
    }

    // ...
});

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

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}")
    }

    // ...
})

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());
    }

    // ...
});

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

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

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

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

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

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

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

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

Kotlin

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

Java

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

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}")
    }
}

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());
        }
    }
});

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

Kotlin

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

Java

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

कनेक्शन की स्थिति का पता लगाया जा रहा है

मौजूदगी से जुड़ी कई सुविधाओं के लिए, आपके ऐप्लिकेशन को यह पता होना चाहिए कि वह कब ऑनलाइन या ऑफ़लाइन है. 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")
    }
})

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");
    }
});

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

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)

Java

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

क्लॉक स्क्यू

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

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");
    }
});

सैंपल 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")
    }
})

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");
    }
});