Ikuti semua informasi yang diumumkan di Firebase Summit, dan pelajari bagaimana Firebase dapat membantu Anda mempercepat pengembangan aplikasi dan menjalankan aplikasi dengan percaya diri. Pelajari Lebih Lanjut

Baca dan Tulis Data di Android

Dokumen ini mencakup dasar-dasar membaca dan menulis data Firebase.

Data Firebase ditulis ke referensi FirebaseDatabase dan diambil dengan melampirkan listener asinkron ke referensi. Listener dipicu sekali untuk status awal data dan sekali lagi kapan saja data berubah.

(Opsional) Prototipe dan uji dengan Firebase Local Emulator Suite

Sebelum berbicara tentang cara aplikasi Anda membaca dan menulis ke Realtime Database, mari perkenalkan seperangkat alat yang dapat Anda gunakan untuk membuat prototipe dan menguji fungsionalitas Realtime Database: Firebase Local Emulator Suite. Jika Anda mencoba model data yang berbeda, mengoptimalkan aturan keamanan Anda, atau bekerja untuk menemukan cara yang paling hemat biaya untuk berinteraksi dengan back-end, dapat bekerja secara lokal tanpa menerapkan layanan langsung bisa menjadi ide bagus.

Emulator Realtime Database adalah bagian dari Local Emulator Suite, yang memungkinkan aplikasi Anda berinteraksi dengan konten dan konfigurasi database yang diemulasi, serta secara opsional sumber daya proyek yang diemulasi (fungsi, database lain, dan aturan keamanan).

Menggunakan emulator Realtime Database hanya melibatkan beberapa langkah:

  1. Menambahkan baris kode ke konfigurasi pengujian aplikasi Anda untuk terhubung ke emulator.
  2. Dari root direktori proyek lokal Anda, jalankan firebase emulators:start .
  3. Melakukan panggilan dari kode prototipe aplikasi Anda menggunakan SDK platform Realtime Database seperti biasa, atau menggunakan REST API Realtime Database.

Panduan terperinci yang melibatkan Realtime Database dan Cloud Functions tersedia. Anda juga harus melihat pengenalan Local Emulator Suite .

Dapatkan Referensi Basis Data

Untuk membaca atau menulis data dari database, Anda memerlukan instance DatabaseReference :

Java

private DatabaseReference mDatabase;
// ...
mDatabase = FirebaseDatabase.getInstance().getReference();

Kotlin+KTX

private lateinit var database: DatabaseReference
// ...
database = Firebase.database.reference

Tulis data

Operasi tulis dasar

Untuk operasi penulisan dasar, Anda dapat menggunakan setValue() untuk menyimpan data ke referensi yang ditentukan, menggantikan data yang ada di jalur tersebut. Anda dapat menggunakan metode ini untuk:

  • Jenis pass yang sesuai dengan jenis JSON yang tersedia sebagai berikut:
    • String
    • Long
    • Double
    • Boolean
    • Map<String, Object>
    • List<Object>
  • Lewati objek Java kustom, jika kelas yang mendefinisikannya memiliki konstruktor default yang tidak membutuhkan argumen dan memiliki getter publik untuk properti yang akan ditetapkan.

Jika Anda menggunakan objek Java, konten objek Anda secara otomatis dipetakan ke lokasi anak dalam mode bersarang. Menggunakan objek Java juga biasanya membuat kode Anda lebih mudah dibaca dan lebih mudah dirawat. Misalnya, jika Anda memiliki aplikasi dengan profil pengguna dasar, objek User Anda mungkin terlihat sebagai berikut:

Java

@IgnoreExtraProperties
public class User {

    public String username;
    public String email;

    public User() {
        // Default constructor required for calls to DataSnapshot.getValue(User.class)
    }

    public User(String username, String email) {
        this.username = username;
        this.email = email;
    }

}

Kotlin+KTX

@IgnoreExtraProperties
data class User(val username: String? = null, val email: String? = null) {
    // Null default values create a no-argument default constructor, which is needed
    // for deserialization from a DataSnapshot.
}

Anda dapat menambahkan pengguna dengan setValue() sebagai berikut:

Java

public void writeNewUser(String userId, String name, String email) {
    User user = new User(name, email);

    mDatabase.child("users").child(userId).setValue(user);
}

Kotlin+KTX

fun writeNewUser(userId: String, name: String, email: String) {
    val user = User(name, email)

    database.child("users").child(userId).setValue(user)
}

Menggunakan setValue() dengan cara ini menimpa data di lokasi yang ditentukan, termasuk node anak apa pun. Namun, Anda masih dapat memperbarui anak tanpa menulis ulang seluruh objek. Jika Anda ingin mengizinkan pengguna memperbarui profilnya, Anda dapat memperbarui nama pengguna sebagai berikut:

Java

mDatabase.child("users").child(userId).child("username").setValue(name);

Kotlin+KTX

database.child("users").child(userId).child("username").setValue(name)

Baca data

Baca data dengan pendengar yang gigih

Untuk membaca data di jalur dan mendengarkan perubahan, gunakan metode addValueEventListener() untuk menambahkan ValueEventListener ke DatabaseReference .

Pendengar Panggilan balik acara Penggunaan umum
ValueEventListener onDataChange() Baca dan dengarkan perubahan pada seluruh konten jalur.

Anda dapat menggunakan metode onDataChange() untuk membaca snapshot statis konten pada jalur tertentu, seperti yang ada pada saat kejadian. Metode ini dipicu satu kali saat listener terpasang dan dipicu lagi setiap kali data, termasuk turunan, berubah. Callback peristiwa melewati snapshot yang berisi semua data di lokasi itu, termasuk data turunan. Jika tidak ada data, snapshot akan mengembalikan false saat Anda memanggil exists() dan null saat Anda memanggil getValue() di atasnya.

Contoh berikut menunjukkan aplikasi blog sosial yang mengambil detail postingan dari database:

Java

ValueEventListener postListener = new ValueEventListener() {
    @Override
    public void onDataChange(DataSnapshot dataSnapshot) {
        // Get Post object and use the values to update the UI
        Post post = dataSnapshot.getValue(Post.class);
        // ..
    }

    @Override
    public void onCancelled(DatabaseError databaseError) {
        // Getting Post failed, log a message
        Log.w(TAG, "loadPost:onCancelled", databaseError.toException());
    }
};
mPostReference.addValueEventListener(postListener);

Kotlin+KTX

val postListener = object : ValueEventListener {
    override fun onDataChange(dataSnapshot: DataSnapshot) {
        // Get Post object and use the values to update the UI
        val post = dataSnapshot.getValue<Post>()
        // ...
    }

    override fun onCancelled(databaseError: DatabaseError) {
        // Getting Post failed, log a message
        Log.w(TAG, "loadPost:onCancelled", databaseError.toException())
    }
}
postReference.addValueEventListener(postListener)

Listener menerima DataSnapshot yang berisi data di lokasi yang ditentukan dalam database pada saat kejadian. Memanggil getValue() pada snapshot mengembalikan representasi objek Java dari data. Jika tidak ada data di lokasi, memanggil getValue() mengembalikan null .

Dalam contoh ini, ValueEventListener juga mendefinisikan metode onCancelled() yang dipanggil jika pembacaan dibatalkan. Misalnya, pembacaan dapat dibatalkan jika klien tidak memiliki izin untuk membaca dari lokasi database Firebase. Metode ini melewati objek DatabaseError yang menunjukkan mengapa kegagalan terjadi.

Baca data sekali

Baca sekali menggunakan get()

SDK dirancang untuk mengelola interaksi dengan server database apakah aplikasi Anda online atau offline.

Umumnya, Anda harus menggunakan teknik ValueEventListener yang dijelaskan di atas untuk membaca data guna mendapatkan pemberitahuan tentang pembaruan data dari backend. Teknik pendengar mengurangi penggunaan dan penagihan Anda, dan dioptimalkan untuk memberikan pengalaman terbaik kepada pengguna saat mereka online dan offline.

Jika Anda membutuhkan data hanya sekali, Anda dapat menggunakan get() untuk mendapatkan snapshot data dari database. Jika karena alasan apa pun get() tidak dapat mengembalikan nilai server, klien akan menyelidiki cache penyimpanan lokal dan mengembalikan kesalahan jika nilainya masih tidak ditemukan.

Penggunaan get() yang tidak perlu dapat meningkatkan penggunaan bandwidth dan menyebabkan hilangnya kinerja, yang dapat dicegah dengan menggunakan pendengar waktu nyata seperti yang ditunjukkan di atas.

Java

mDatabase.child("users").child(userId).get().addOnCompleteListener(new OnCompleteListener<DataSnapshot>() {
    @Override
    public void onComplete(@NonNull Task<DataSnapshot> task) {
        if (!task.isSuccessful()) {
            Log.e("firebase", "Error getting data", task.getException());
        }
        else {
            Log.d("firebase", String.valueOf(task.getResult().getValue()));
        }
    }
});

Kotlin+KTX

mDatabase.child("users").child(userId).get().addOnSuccessListener {
    Log.i("firebase", "Got value ${it.value}")
}.addOnFailureListener{
    Log.e("firebase", "Error getting data", it)
}

Baca sekali menggunakan pendengar

Dalam beberapa kasus, Anda mungkin ingin nilai dari cache lokal segera dikembalikan, alih-alih memeriksa nilai yang diperbarui di server. Dalam kasus tersebut, Anda dapat menggunakan addListenerForSingleValueEvent untuk segera mendapatkan data dari cache disk lokal.

Ini berguna untuk data yang hanya perlu dimuat sekali dan diperkirakan tidak akan sering berubah atau memerlukan pendengaran aktif. Misalnya, aplikasi blog dalam contoh sebelumnya menggunakan metode ini untuk memuat profil pengguna ketika mereka mulai menulis posting baru.

Memperbarui atau menghapus data

Perbarui bidang tertentu

Untuk menulis secara bersamaan ke anak-anak tertentu dari sebuah node tanpa menimpa node anak lainnya, gunakan metode updateChildren() .

Saat memanggil updateChildren() , Anda dapat memperbarui nilai turunan tingkat rendah dengan menentukan jalur untuk kunci tersebut. Jika data disimpan di beberapa lokasi untuk skala yang lebih baik, Anda dapat memperbarui semua contoh data tersebut menggunakan penyebaran data . Misalnya, aplikasi blog sosial mungkin memiliki kelas Post seperti ini:

Java

@IgnoreExtraProperties
public class Post {

    public String uid;
    public String author;
    public String title;
    public String body;
    public int starCount = 0;
    public Map<String, Boolean> stars = new HashMap<>();

    public Post() {
        // Default constructor required for calls to DataSnapshot.getValue(Post.class)
    }

    public Post(String uid, String author, String title, String body) {
        this.uid = uid;
        this.author = author;
        this.title = title;
        this.body = body;
    }

    @Exclude
    public Map<String, Object> toMap() {
        HashMap<String, Object> result = new HashMap<>();
        result.put("uid", uid);
        result.put("author", author);
        result.put("title", title);
        result.put("body", body);
        result.put("starCount", starCount);
        result.put("stars", stars);

        return result;
    }
}

Kotlin+KTX

@IgnoreExtraProperties
data class Post(
    var uid: String? = "",
    var author: String? = "",
    var title: String? = "",
    var body: String? = "",
    var starCount: Int = 0,
    var stars: MutableMap<String, Boolean> = HashMap()
) {

    @Exclude
    fun toMap(): Map<String, Any?> {
        return mapOf(
                "uid" to uid,
                "author" to author,
                "title" to title,
                "body" to body,
                "starCount" to starCount,
                "stars" to stars
        )
    }
}

Untuk membuat postingan dan sekaligus memperbaruinya ke umpan aktivitas terkini dan umpan aktivitas pengguna pengeposan, aplikasi blog menggunakan kode seperti ini:

Java

private void writeNewPost(String userId, String username, String title, String body) {
    // Create new post at /user-posts/$userid/$postid and at
    // /posts/$postid simultaneously
    String key = mDatabase.child("posts").push().getKey();
    Post post = new Post(userId, username, title, body);
    Map<String, Object> postValues = post.toMap();

    Map<String, Object> childUpdates = new HashMap<>();
    childUpdates.put("/posts/" + key, postValues);
    childUpdates.put("/user-posts/" + userId + "/" + key, postValues);

    mDatabase.updateChildren(childUpdates);
}

Kotlin+KTX

private fun writeNewPost(userId: String, username: String, title: String, body: String) {
    // Create new post at /user-posts/$userid/$postid and at
    // /posts/$postid simultaneously
    val key = database.child("posts").push().key
    if (key == null) {
        Log.w(TAG, "Couldn't get push key for posts")
        return
    }

    val post = Post(userId, username, title, body)
    val postValues = post.toMap()

    val childUpdates = hashMapOf<String, Any>(
            "/posts/$key" to postValues,
            "/user-posts/$userId/$key" to postValues
    )

    database.updateChildren(childUpdates)
}

Contoh ini menggunakan push() untuk membuat postingan di node yang berisi postingan untuk semua pengguna di /posts/$postid dan secara bersamaan mengambil kunci dengan getKey() . Kuncinya kemudian dapat digunakan untuk membuat entri kedua di postingan pengguna di /user-posts/$userid/$postid .

Dengan menggunakan jalur ini, Anda dapat melakukan pembaruan simultan ke beberapa lokasi di pohon JSON dengan satu panggilan ke updateChildren() , seperti bagaimana contoh ini membuat postingan baru di kedua lokasi. Pembaruan simultan yang dilakukan dengan cara ini bersifat atomik: semua pembaruan berhasil atau semua pembaruan gagal.

Tambahkan Panggilan Balik Penyelesaian

Jika Anda ingin tahu kapan data Anda telah dikomit, Anda dapat menambahkan pendengar penyelesaian. Baik setValue() dan updateChildren() mengambil listener penyelesaian opsional yang dipanggil saat penulisan telah berhasil dilakukan ke database. Jika panggilan tidak berhasil, pendengar diberikan objek kesalahan yang menunjukkan mengapa kegagalan terjadi.

Java

mDatabase.child("users").child(userId).setValue(user)
        .addOnSuccessListener(new OnSuccessListener<Void>() {
            @Override
            public void onSuccess(Void aVoid) {
                // Write was successful!
                // ...
            }
        })
        .addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception e) {
                // Write failed
                // ...
            }
        });

Kotlin+KTX

database.child("users").child(userId).setValue(user)
        .addOnSuccessListener {
            // Write was successful!
            // ...
        }
        .addOnFailureListener {
            // Write failed
            // ...
        }

Hapus data

Cara paling sederhana untuk menghapus data adalah dengan memanggil removeValue() pada referensi ke lokasi data tersebut.

Anda juga dapat menghapus dengan menetapkan null sebagai nilai untuk operasi penulisan lain seperti setValue() atau updateChildren() . Anda dapat menggunakan teknik ini dengan updateChildren() untuk menghapus banyak anak dalam satu panggilan API.

Lepaskan pendengar

Callback dihapus dengan memanggil metode removeEventListener() pada referensi database Firebase Anda.

Jika listener telah ditambahkan beberapa kali ke lokasi data, itu akan dipanggil beberapa kali untuk setiap peristiwa, dan Anda harus melepaskannya sebanyak yang sama untuk menghapusnya sepenuhnya.

Memanggil removeEventListener() pada listener induk tidak secara otomatis menghapus listener yang terdaftar pada node turunannya; removeEventListener() juga harus dipanggil pada setiap pendengar anak untuk menghapus panggilan balik.

Simpan data sebagai transaksi

Saat bekerja dengan data yang dapat dirusak oleh modifikasi bersamaan, seperti penghitung tambahan, Anda dapat menggunakan operasi transaksi . Anda memberikan operasi ini dua argumen: fungsi pembaruan dan panggilan balik penyelesaian opsional. Fungsi pembaruan mengambil status data saat ini sebagai argumen dan mengembalikan status baru yang diinginkan yang ingin Anda tulis. Jika klien lain menulis ke lokasi sebelum nilai baru Anda berhasil ditulis, fungsi pembaruan Anda dipanggil lagi dengan nilai baru saat ini, dan penulisan akan dicoba lagi.

Misalnya, dalam contoh aplikasi blog sosial, Anda dapat mengizinkan pengguna untuk memberi bintang dan menghapus bintang pada postingan dan melacak berapa banyak bintang yang diterima sebuah postingan sebagai berikut:

Java

private void onStarClicked(DatabaseReference postRef) {
    postRef.runTransaction(new Transaction.Handler() {
        @Override
        public Transaction.Result doTransaction(MutableData mutableData) {
            Post p = mutableData.getValue(Post.class);
            if (p == null) {
                return Transaction.success(mutableData);
            }

            if (p.stars.containsKey(getUid())) {
                // Unstar the post and remove self from stars
                p.starCount = p.starCount - 1;
                p.stars.remove(getUid());
            } else {
                // Star the post and add self to stars
                p.starCount = p.starCount + 1;
                p.stars.put(getUid(), true);
            }

            // Set value and report transaction success
            mutableData.setValue(p);
            return Transaction.success(mutableData);
        }

        @Override
        public void onComplete(DatabaseError databaseError, boolean committed,
                               DataSnapshot currentData) {
            // Transaction completed
            Log.d(TAG, "postTransaction:onComplete:" + databaseError);
        }
    });
}

Kotlin+KTX

private fun onStarClicked(postRef: DatabaseReference) {
    // ...
    postRef.runTransaction(object : Transaction.Handler {
        override fun doTransaction(mutableData: MutableData): Transaction.Result {
            val p = mutableData.getValue(Post::class.java)
                    ?: return Transaction.success(mutableData)

            if (p.stars.containsKey(uid)) {
                // Unstar the post and remove self from stars
                p.starCount = p.starCount - 1
                p.stars.remove(uid)
            } else {
                // Star the post and add self to stars
                p.starCount = p.starCount + 1
                p.stars[uid] = true
            }

            // Set value and report transaction success
            mutableData.value = p
            return Transaction.success(mutableData)
        }

        override fun onComplete(
                databaseError: DatabaseError?,
                committed: Boolean,
                currentData: DataSnapshot?
        ) {
            // Transaction completed
            Log.d(TAG, "postTransaction:onComplete:" + databaseError!!)
        }
    })
}

Menggunakan transaksi mencegah kesalahan penghitungan bintang jika beberapa pengguna membintangi posting yang sama secara bersamaan atau klien memiliki data yang basi. Jika transaksi ditolak, server mengembalikan nilai saat ini ke klien, yang menjalankan transaksi lagi dengan nilai yang diperbarui. Ini berulang hingga transaksi diterima atau terlalu banyak upaya yang dilakukan.

Peningkatan sisi server atom

Dalam kasus penggunaan di atas, kami menulis dua nilai ke database: ID pengguna yang membintangi/menghapus bintang postingan, dan jumlah bintang yang bertambah. Jika kita sudah tahu bahwa pengguna membintangi posting, kita dapat menggunakan operasi kenaikan atom alih-alih transaksi.

Java

private void onStarClicked(String uid, String key) {
    Map<String, Object> updates = new HashMap<>();
    updates.put("posts/"+key+"/stars/"+uid, true);
    updates.put("posts/"+key+"/starCount", ServerValue.increment(1));
    updates.put("user-posts/"+uid+"/"+key+"/stars/"+uid, true);
    updates.put("user-posts/"+uid+"/"+key+"/starCount", ServerValue.increment(1));
    mDatabase.updateChildren(updates);
}

Kotlin+KTX

private fun onStarClicked(uid: String, key: String) {
    val updates: MutableMap<String, Any> = hashMapOf(
        "posts/$key/stars/$uid" to true,
        "posts/$key/starCount" to ServerValue.increment(1),
        "user-posts/$uid/$key/stars/$uid" to true,
        "user-posts/$uid/$key/starCount" to ServerValue.increment(1)
    )
    database.updateChildren(updates)
}

Kode ini tidak menggunakan operasi transaksi, sehingga tidak otomatis dijalankan kembali jika ada pembaruan yang bentrok. Namun, karena operasi kenaikan terjadi langsung di server database, tidak ada kemungkinan konflik.

Jika Anda ingin mendeteksi dan menolak konflik khusus aplikasi, seperti pengguna yang membintangi postingan yang telah mereka bintangi sebelumnya, Anda harus menulis aturan keamanan khusus untuk kasus penggunaan tersebut.

Bekerja dengan data offline

Jika klien kehilangan koneksi jaringannya, aplikasi Anda akan terus berfungsi dengan benar.

Setiap klien yang terhubung ke database Firebase mempertahankan versi internalnya sendiri dari data apa pun yang menggunakan listener atau yang ditandai agar tetap sinkron dengan server. Saat data dibaca atau ditulis, data versi lokal ini digunakan terlebih dahulu. Klien Firebase kemudian menyinkronkan data tersebut dengan server database jarak jauh dan dengan klien lain berdasarkan "upaya terbaik".

Akibatnya, semua penulisan ke database langsung memicu peristiwa lokal, sebelum interaksi apa pun dengan server. Ini berarti aplikasi Anda tetap responsif terlepas dari latensi jaringan atau konektivitas.

Setelah konektivitas dibangun kembali, aplikasi Anda menerima rangkaian peristiwa yang sesuai sehingga klien menyinkronkan dengan status server saat ini, tanpa harus menulis kode khusus apa pun.

Kita akan berbicara lebih banyak tentang perilaku offline di Pelajari lebih lanjut tentang kemampuan online dan offline .

Langkah selanjutnya