Mengaktifkan Kemampuan Offline

Aplikasi Firebase tetap berfungsi bahkan ketika aplikasi Anda kehilangan koneksi jaringan untuk sementara. Selain itu, Firebase menyediakan alat untuk mempertahankan data secara lokal, mengelola kehadiran, dan menangani latensi.

Persistensi Disk

Aplikasi Firebase menangani gangguan sementara pada jaringan secara otomatis. Data yang tersimpan di cache akan tersedia saat offline, dan Firebase akan mengirim ulang setiap operasi tulis saat terhubung kembali ke jaringan.

Jika persistensi disk diaktifkan, aplikasi Anda akan menulis data secara lokal ke perangkat agar dapat mempertahankan status saat offline, bahkan saat aplikasi dimulai ulang oleh pengguna atau sistem operasi.

Anda dapat mengaktifkan persistensi disk cukup dengan 1 baris kode.

FirebaseDatabase.instance.setPersistenceEnabled(true);

Perilaku Persistensi

Dengan mengaktifkan persistensi, data apa pun yang disinkronkan oleh klien Firebase Realtime Database saat online akan dipertahankan di disk dan tersedia secara offline, bahkan saat aplikasi dimulai ulang oleh pengguna atau sistem operasi. Artinya, aplikasi Anda akan berfungsi seperti halnya ketika online dengan menggunakan data lokal yang disimpan dalam cache. Callback pemroses akan terus aktif untuk pembaruan lokal.

Klien Firebase Realtime Database secara otomatis menyimpan antrean semua operasi tulis yang dijalankan saat aplikasi sedang offline. Saat persistensi diaktifkan, antrean ini juga akan dipertahankan di disk sehingga semua operasi tulis akan tersedia saat aplikasi dimulai ulang oleh pengguna atau sistem operasi. Setelah aplikasi kembali terhubung, semua operasi tersebut akan dikirim ke server Firebase Realtime Database.

Jika aplikasi Anda menggunakan Firebase Authentication, klien Firebase Realtime Database akan mempertahankan token autentikasi pengguna setiap kali aplikasi dimulai ulang. Jika masa berlaku token autentikasi habis saat aplikasi offline, klien akan menjeda operasi tulis hingga aplikasi Anda mengautentikasi ulang pengguna. Jika tidak, operasi tulis mungkin akan gagal akibat aturan keamanan.

Menjaga Data Tetap Baru

Firebase Realtime Database menyinkronkan dan menyimpan salinan lokal data untuk pemroses aktif. Selain itu, Anda dapat terus menyinkronkan lokasi tertentu.

final scoresRef = FirebaseDatabase.instance.ref("scores");
scoresRef.keepSynced(true);

Klien Firebase Realtime Database akan otomatis mendownload data di lokasi tersebut dan terus menyinkronkannya meskipun referensi itu tidak memiliki pemroses aktif. Anda dapat kembali menonaktifkan sinkronisasi dengan baris kode berikut.

scoresRef.keepSynced(false);

Secara default, data sebesar 10 MB yang telah disinkronkan sebelumnya akan disimpan ke dalam cache. Jumlah ini tentunya cukup untuk sebagian besar aplikasi. Jika ukuran cache melebihi ukuran yang dikonfigurasi, Firebase Realtime Database akan menghapus permanen data yang paling lama tidak digunakan. Data yang terus disinkronkan tidak akan dihapus secara permanen dari cache.

Memproses Kueri Data secara Offline

Firebase Realtime Database menyimpan data yang ditampilkan dari kueri untuk digunakan saat offline. Untuk kueri yang dibuat saat offline, Firebase Realtime Database akan terus berfungsi untuk data yang dimuat sebelumnya. Jika data yang diminta belum dimuat, Firebase Realtime Database akan memuat data dari cache lokal. Setelah koneksi jaringan kembali tersedia, data akan dimuat dan mencerminkan kueri tersebut.

Misalnya, kode berikut memproses kueri untuk empat item terakhir dalam database skor:

final scoresRef = FirebaseDatabase.instance.ref("scores");
scoresRef.orderByValue().limitToLast(4).onChildAdded.listen((event) {
  debugPrint("The ${event.snapshot.key} dinosaur's score is ${event.snapshot.value}.");
});

Asumsikan pengguna kehilangan koneksi, statusnya menjadi offline, dan memulai ulang aplikasi. Selagi masih offline, aplikasi akan memproses kueri untuk dua item terakhir dari lokasi yang sama. Kueri ini akan berhasil menampilkan dua item terakhir karena aplikasi telah memuat keempat item dalam kueri di atas.

scoresRef.orderByValue().limitToLast(2).onChildAdded.listen((event) {
  debugPrint("The ${event.snapshot.key} dinosaur's score is ${event.snapshot.value}.");
});

Pada contoh sebelumnya, klien Firebase Realtime Database memunculkan peristiwa 'turunan ditambahkan' untuk dua dinosaurus dengan skor tertinggi melalui cache persisten. Namun, klien tidak akan memunculkan peristiwa 'nilai', karena aplikasi tidak pernah menjalankan kueri tersebut selagi online.

Jika ingin meminta keenam item terakhir selagi offline, aplikasi akan langsung mendapatkan peristiwa 'turunan ditambahkan' untuk keempat item yang disimpan dalam cache. Saat perangkat kembali online, klien Firebase Realtime Database akan melakukan sinkronisasi dengan server dan mendapatkan dua peristiwa 'turunan ditambahkan' dan 'nilai' terakhir untuk aplikasi.

Menangani Transaksi saat Offline

Setiap transaksi yang dijalankan sewaktu aplikasi offline akan dimasukkan ke dalam antrean. Setelah aplikasi kembali online, transaksi akan dikirim ke server Realtime Database.

Firebase Realtime Database memiliki banyak fitur untuk menangani skenario offline dan koneksi jaringan. Seluruh bagian berikutnya dalam panduan ini berlaku bagi aplikasi Anda, terlepas dari aktif atau tidaknya persistensi.

Mengelola Kehadiran

Pada aplikasi real-time, mendeteksi kapan klien membuat dan memutus koneksi sering kali bermanfaat. Misalnya, Anda dapat menandai pengguna sebagai 'offline' saat kliennya memutus koneksi.

Klien Firebase Database menyediakan sejumlah primitif sederhana yang dapat Anda gunakan untuk menulis ke database saat suatu klien memutuskan koneksi ke server Firebase Database. Update ini akan terjadi, terlepas dari apakah klien memutuskan koneksi secara bersih atau tidak, sehingga Anda dapat mengandalkan update ini untuk membersihkan data, meskipun koneksi terputus atau klien mengalami error. Semua operasi tulis, termasuk penyetelan, update, dan penghapusan, dapat dilakukan setelah koneksi diputus.

Berikut adalah contoh sederhana penulisan data setelah koneksi diputus menggunakan primitif onDisconnect:

final presenceRef = FirebaseDatabase.instance.ref("disconnectmessage");
// Write a string when this client loses connection
presenceRef.onDisconnect().set("I disconnected!");

Cara Kerja onDisconnect

Ketika Anda membuat operasi onDisconnect(), operasi tersebut akan berlangsung di server Firebase Realtime Database. Server akan memeriksa keamanan untuk memastikan bahwa pengguna dapat menjalankan peristiwa tulis yang diminta, dan memberi tahu aplikasi Anda jika operasi tersebut tidak valid. Selanjutnya, server akan memantau koneksinya. Jika waktu koneksi habis, atau koneksi ditutup secara aktif oleh klien Realtime Database, server akan memeriksa keamanan sekali lagi (untuk memastikan operasi masih valid) kemudian memanggil peristiwa tersebut.

try {
    await presenceRef.onDisconnect().remove();
} catch (error) {
    debugPrint("Could not establish onDisconnect event: $error");
}

Peristiwa onDisconnect juga dapat dibatalkan dengan memanggil .cancel():

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

Mendeteksi Status Koneksi

Untuk banyak fitur yang terkait dengan kehadiran, ada baiknya bila aplikasi mengetahui apakah status koneksi sedang online atau offline. Firebase Realtime Database menyediakan lokasi khusus di /.info/connected yang diupdate setiap kali status koneksi klien Firebase Realtime Database berubah. Berikut ini contohnya:

final connectedRef = FirebaseDatabase.instance.ref(".info/connected");
connectedRef.onValue.listen((event) {
  final connected = event.snapshot.value as bool? ?? false;
  if (connected) {
    debugPrint("Connected.");
  } else {
    debugPrint("Not connected.");
  }
});

/.info/connected adalah nilai boolean yang tidak disinkronkan antarklien Realtime Database karena nilainya bergantung pada status klien. Dengan kata lain, jika satu klien membaca /.info/connected sebagai salah (false), tidak ada jaminan bahwa klien lain juga akan membacanya sebagai salah (false).

Menangani Latensi

Stempel Waktu Server

Server Firebase Realtime Database memberikan mekanisme untuk menyisipkan stempel waktu yang dibuat di server sebagai data. Fitur ini, bersama dengan onDisconnect, memberikan cara mudah dan andal untuk mencatat kapan koneksi klien Realtime Database diputus:

final userLastOnlineRef =
    FirebaseDatabase.instance.ref("users/joe/lastOnline");
userLastOnlineRef.onDisconnect().set(ServerValue.timestamp);

Clock Skew

Meskipun ServerValue.timestamp jauh lebih akurat dan lebih cocok untuk sebagian besar operasi baca/tulis, terkadang ada baiknya memperkirakan clock skew klien terhadap server Firebase Realtime Database. Anda dapat menambahkan callback ke lokasi /.info/serverTimeOffset untuk mendapatkan nilai, dalam milidetik, yang ditambahkan oleh klien Firebase Realtime Database ke waktu lokal yang dilaporkan (waktu epoch dalam milidetik) untuk memperkirakan waktu server. Perlu diperhatikan bahwa keakuratan selisih waktu ini dapat dipengaruhi oleh latensi jaringan, sehingga lebih bermanfaat untuk menemukan selisih waktu jam yang besar (> 1 detik).

final offsetRef = FirebaseDatabase.instance.ref(".info/serverTimeOffset");
offsetRef.onValue.listen((event) {
  final offset = event.snapshot.value as num? ?? 0.0;
  final estimatedServerTimeMs =
      DateTime.now().millisecondsSinceEpoch + offset;
});

Contoh Aplikasi Kehadiran

Dengan menggabungkan operasi pemutusan koneksi dengan pemantauan status koneksi dan stempel waktu server, Anda dapat membuat suatu sistem kehadiran pengguna. Dalam sistem ini, setiap pengguna menyimpan data di suatu lokasi database untuk menunjukkan apakah klien Realtime Database sedang online atau tidak. Klien akan menetapkan lokasi ini ke benar (true) ketika mulai online dan ke stempel waktu ketika memutuskan koneksi. Stempel waktu ini menunjukkan kapan terakhir kali pengguna tertentu online.

Perlu diperhatikan bahwa aplikasi Anda harus mengantrekan operasi pemutusan koneksi sebelum pengguna ditandai sebagai online, untuk menghindari kondisi race yang dapat terjadi jika koneksi jaringan klien terputus sebelum kedua perintah dapat dikirimkan ke server.

// 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 myConnectionsRef =
    FirebaseDatabase.instance.ref("users/joe/connections");

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

final connectedRef = FirebaseDatabase.instance.ref(".info/connected");
connectedRef.onValue.listen((event) {
  final connected = event.snapshot.value as bool? ?? false;
  if (connected) {
    final con = myConnectionsRef.push();

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

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

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