หน้านี้ได้รับการแปลโดย Cloud Translation API
Switch to English

อ่านและเขียนข้อมูลบน Android

เอกสารนี้ครอบคลุมพื้นฐานของการอ่านและเขียนข้อมูล Firebase

ข้อมูล Firebase เขียนไปยังการอ้างอิง FirebaseDatabase และดึงมาโดยการแนบตัวฟังแบบอะซิงโครนัสเข้ากับข้อมูลอ้างอิง Listener จะถูกเรียกหนึ่งครั้งสำหรับสถานะเริ่มต้นของข้อมูลและอีกครั้งเมื่อใดก็ตามที่ข้อมูลเปลี่ยนแปลง

รับ DatabaseReference

ในการอ่านหรือเขียนข้อมูลจากฐานข้อมูลคุณต้องมีอินสแตนซ์ของ DatabaseReference :

ชวา

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

Kotlin + KTX

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

อ่านและเขียนข้อมูล

การเขียนขั้นพื้นฐาน

สำหรับการเขียนขั้นพื้นฐานคุณสามารถใช้ setValue() เพื่อบันทึกข้อมูลไปยังการอ้างอิงที่ระบุโดยแทนที่ข้อมูลที่มีอยู่ในพา ธ นั้น คุณสามารถใช้วิธีนี้เพื่อ:

  • ประเภทพาสที่สอดคล้องกับประเภท JSON ที่มีดังต่อไปนี้:
    • String
    • Long
    • Double
    • Boolean
    • Map<String, Object>
    • List<Object>
  • ส่งผ่านอ็อบเจ็กต์ Java ที่กำหนดเองหากคลาสที่กำหนดมีคอนสตรัคเตอร์เริ่มต้นที่ไม่มีอาร์กิวเมนต์และมี public getters สำหรับคุณสมบัติที่จะกำหนด

หากคุณใช้ออบเจ็กต์ Java เนื้อหาของอ็อบเจ็กต์ของคุณจะถูกแมปกับตำแหน่งรองโดยอัตโนมัติในลักษณะซ้อนกัน การใช้ออบเจ็กต์ Java ยังทำให้โค้ดของคุณอ่านง่ายขึ้นและดูแลรักษาง่ายขึ้น ตัวอย่างเช่นหากคุณมีแอปที่มีโปรไฟล์ผู้ใช้พื้นฐานออบเจ็กต์ User ของคุณอาจมีลักษณะดังนี้:

ชวา

@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(
    var username: String? = "",
    var email: String? = ""
)

คุณสามารถเพิ่มผู้ใช้ด้วย setValue() ดังนี้:

ชวา

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

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

Kotlin + KTX

private fun writeNewUser(userId: String, name: String, email: String?) {
    val user = User(name, email)
    database.child("users").child(userId).setValue(user)
}

การใช้ setValue() ในลักษณะนี้จะเขียนทับข้อมูลในตำแหน่งที่ระบุรวมถึงโหนดลูกด้วย อย่างไรก็ตามคุณยังคงสามารถอัปเดตเด็กได้โดยไม่ต้องเขียนใหม่ทั้งวัตถุ หากคุณต้องการอนุญาตให้ผู้ใช้อัปเดตโปรไฟล์คุณสามารถอัปเดตชื่อผู้ใช้ดังต่อไปนี้:

ชวา

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

Kotlin + KTX

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

ฟังเหตุการณ์อันทรงคุณค่า

หากต้องการอ่านข้อมูลที่พา ธ และรับฟังการเปลี่ยนแปลงให้ใช้ addValueEventListener() หรือ addListenerForSingleValueEvent() เพื่อเพิ่ม ValueEventListener ให้กับ DatabaseReference

ผู้ฟัง ติดต่อกลับเหตุการณ์ การใช้งานทั่วไป
ValueEventListener onDataChange() อ่านและรับฟังการเปลี่ยนแปลงเนื้อหาทั้งหมดของเส้นทาง

คุณสามารถใช้ onDataChange() เพื่ออ่านสแนปช็อตแบบคงที่ของเนื้อหาตามเส้นทางที่กำหนดตามที่มีอยู่ในช่วงเวลาของเหตุการณ์ วิธีนี้จะถูกทริกเกอร์หนึ่งครั้งเมื่อมีการเชื่อมต่อ Listener และอีกครั้งทุกครั้งที่ข้อมูลรวมทั้งเด็กเปลี่ยนแปลง การเรียกกลับเหตุการณ์จะถูกส่งผ่านสแนปชอตที่มีข้อมูลทั้งหมดในตำแหน่งนั้นรวมถึงข้อมูลลูก หากไม่มีข้อมูล snapshot จะส่งคืน false เมื่อคุณเรียกว่า exists() และเป็น null เมื่อคุณเรียก getValue()

ตัวอย่างต่อไปนี้แสดงให้เห็นถึงแอปพลิเคชันบล็อกโซเชียลที่ดึงรายละเอียดของโพสต์จากฐานข้อมูล:

ชวา

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 ได้รับ DataSnapshot ที่มีข้อมูลที่ตำแหน่งที่ระบุในฐานข้อมูลในช่วงเวลาของเหตุการณ์ การเรียก getValue() บนสแน็ปช็อตจะส่งคืนการแสดงวัตถุ Java ของข้อมูล หากไม่มีข้อมูลอยู่ในตำแหน่งนั้นการเรียก getValue() จะคืน null

ในตัวอย่างนี้ ValueEventListener ยังกำหนด onCancelled() ที่เรียกว่าหากการอ่านถูกยกเลิก ตัวอย่างเช่นสามารถยกเลิกการอ่านได้หากไคลเอ็นต์ไม่มีสิทธิ์อ่านจากตำแหน่งฐานข้อมูล Firebase เมธอดนี้ถูกส่งผ่านอ็อบเจ็กต์ DatabaseError ระบุสาเหตุที่เกิดความล้มเหลว

อ่านข้อมูลครั้งเดียว

ในบางกรณีคุณอาจต้องการให้โทรกลับเพียงครั้งเดียวแล้วลบออกทันทีเช่นเมื่อเริ่มต้นองค์ประกอบ UI ที่คุณไม่คาดว่าจะเปลี่ยนแปลง คุณสามารถใช้เมธอด addListenerForSingleValueEvent() เพื่อลดความซับซ้อนของสถานการณ์นี้: ทริกเกอร์หนึ่งครั้งจากนั้นไม่ทริกเกอร์อีกครั้ง

สิ่งนี้มีประโยชน์สำหรับข้อมูลที่ต้องโหลดเพียงครั้งเดียวและไม่คาดว่าจะมีการเปลี่ยนแปลงบ่อยหรือต้องใช้การฟัง ตัวอย่างเช่นแอปบล็อกในตัวอย่างก่อนหน้านี้ใช้วิธีนี้เพื่อโหลดโปรไฟล์ของผู้ใช้เมื่อเริ่มเขียนโพสต์ใหม่:

การอัปเดตหรือลบข้อมูล

อัปเดตช่องเฉพาะ

หากต้องการเขียนไปยังชายด์เฉพาะของโหนดพร้อมกันโดยไม่ต้องเขียนทับโหนดลูกอื่นให้ใช้ updateChildren()

เมื่อเรียก updateChildren() คุณสามารถอัปเดตค่าลูกระดับล่างได้โดยระบุเส้นทางสำหรับคีย์ หากข้อมูลถูกเก็บไว้ในหลายตำแหน่งเพื่อให้ปรับขนาดได้ดีขึ้นคุณสามารถอัปเดตอินสแตนซ์ทั้งหมดของข้อมูลนั้นโดยใช้การ กระจายข้อมูล ตัวอย่างเช่นแอปบล็อกโซเชียลอาจมีชั้นเรียน Post ดังนี้

ชวา

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

ในการสร้างโพสต์และอัปเดตไปยังฟีดกิจกรรมล่าสุดและฟีดกิจกรรมของผู้โพสต์พร้อมกันแอปพลิเคชันบล็อกจะใช้รหัสดังนี้:

ชวา

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

ตัวอย่างนี้ใช้ push() เพื่อสร้างโพสต์ในโหนดที่มีโพสต์สำหรับผู้ใช้ทั้งหมดที่ /posts/$postid และดึงคีย์พร้อมกับ getKey() จากนั้นสามารถใช้คีย์เพื่อสร้างรายการที่สองในโพสต์ของผู้ใช้ที่ /user-posts/$userid/$postid

เมื่อใช้เส้นทางเหล่านี้คุณสามารถทำการอัปเดตพร้อมกันไปยังตำแหน่งต่างๆในโครงสร้าง JSON ด้วยการเรียกใช้ updateChildren() เพียงครั้งเดียวเช่นตัวอย่างนี้สร้างโพสต์ใหม่ในทั้งสองตำแหน่งได้อย่างไร การอัปเดตพร้อมกันที่ทำด้วยวิธีนี้ถือเป็นปรมาณู: การอัปเดตทั้งหมดสำเร็จหรือการอัปเดตทั้งหมดล้มเหลว

เพิ่มการโทรกลับที่เสร็จสมบูรณ์

หากคุณต้องการทราบว่าข้อมูลของคุณได้รับการคอมมิตเมื่อใดคุณสามารถเพิ่มตัวฟังที่สมบูรณ์ได้ ทั้ง setValue() และ updateChildren() รับฟังการกรอกข้อมูลที่เป็นทางเลือกซึ่งถูกเรียกใช้เมื่อการเขียนได้รับการยืนยันกับฐานข้อมูลสำเร็จแล้ว หากการโทรไม่สำเร็จผู้ฟังจะถูกส่งผ่านวัตถุข้อผิดพลาดที่ระบุสาเหตุที่เกิดความล้มเหลว

ชวา

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
            // ...
        }

ลบข้อมูล

วิธีที่ง่ายที่สุดในการลบข้อมูลคือการเรียก removeValue() โดยอ้างอิงตำแหน่งของข้อมูลนั้น

คุณยังสามารถลบได้โดยระบุ null เป็นค่าสำหรับการดำเนินการเขียนอื่นเช่น setValue() หรือ updateChildren() คุณสามารถใช้เทคนิคนี้กับ updateChildren() เพื่อลบลูกหลายคนในการเรียก API ครั้งเดียว

แยกผู้ฟัง

การโทรกลับจะถูกลบออกโดยการเรียกเมธอด removeEventListener() ในการอ้างอิงฐานข้อมูล Firebase ของคุณ

หากมีการเพิ่ม Listener ลงในตำแหน่งข้อมูลหลายครั้งระบบจะเรียกผู้ฟังหลายครั้งสำหรับแต่ละเหตุการณ์และคุณต้องถอดออกในจำนวนครั้งเท่ากันเพื่อลบออกทั้งหมด

การเรียก removeEventListener() บนตัวฟังหลักไม่ได้ลบผู้ฟังที่ลงทะเบียนไว้บนโหนดลูกโดยอัตโนมัติ removeEventListener() ยังต้องถูกเรียกให้กับผู้ฟังเด็กทุกคนเพื่อลบการเรียกกลับ

บันทึกข้อมูลเป็นธุรกรรม

เมื่อทำงานกับข้อมูลที่อาจเสียหายจากการแก้ไขพร้อมกันเช่นตัวนับส่วนเพิ่มคุณสามารถใช้การ ดำเนินการธุรกรรม คุณให้การดำเนินการนี้สองอาร์กิวเมนต์: ฟังก์ชันอัพเดตและการเรียกกลับที่เป็นทางเลือก ฟังก์ชันอัพเดตจะใช้สถานะปัจจุบันของข้อมูลเป็นอาร์กิวเมนต์และส่งคืนสถานะที่ต้องการใหม่ที่คุณต้องการเขียน หากไคลเอนต์อื่นเขียนไปยังตำแหน่งก่อนที่จะเขียนค่าใหม่ของคุณสำเร็จฟังก์ชันอัพเดตของคุณจะถูกเรียกอีกครั้งพร้อมกับค่าปัจจุบันใหม่และการเขียนจะถูกลองอีกครั้ง

ตัวอย่างเช่นในแอปบล็อกโซเชียลตัวอย่างคุณสามารถอนุญาตให้ผู้ใช้ติดดาวและเลิกติดดาวโพสต์และติดตามจำนวนดาวที่โพสต์ได้รับดังนี้:

ชวา

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

การใช้ธุรกรรมช่วยป้องกันการนับดาวไม่ถูกต้องหากผู้ใช้หลายคนติดดาวโพสต์เดียวกันในเวลาเดียวกันหรือไคลเอ็นต์มีข้อมูลเก่า หากธุรกรรมถูกปฏิเสธเซิร์ฟเวอร์จะส่งคืนค่าปัจจุบันไปยังไคลเอนต์ซึ่งเรียกใช้ธุรกรรมอีกครั้งด้วยค่าที่อัปเดต สิ่งนี้จะเกิดขึ้นซ้ำจนกว่าธุรกรรมจะได้รับการยอมรับหรือพยายามทำหลายครั้งเกินไป

เขียนข้อมูลแบบออฟไลน์

หากไคลเอนต์ขาดการเชื่อมต่อเครือข่ายแอปของคุณจะยังคงทำงานได้อย่างถูกต้อง

ไคลเอนต์ทุกรายที่เชื่อมต่อกับฐานข้อมูล Firebase จะรักษาเวอร์ชันภายในของข้อมูลที่ใช้งานอยู่ เมื่อข้อมูลถูกเขียนข้อมูลจะถูกเขียนลงในเวอร์ชันท้องถิ่นนี้ก่อน จากนั้นไคลเอ็นต์ Firebase จะซิงโครไนซ์ข้อมูลนั้นกับเซิร์ฟเวอร์ฐานข้อมูลระยะไกลและกับไคลเอนต์อื่น ๆ โดยใช้ "ความพยายามอย่างดีที่สุด"

ด้วยเหตุนี้การเขียนทั้งหมดไปยังฐานข้อมูลจะทริกเกอร์เหตุการณ์ภายในเครื่องทันทีก่อนที่ข้อมูลใด ๆ จะถูกเขียนไปยังเซิร์ฟเวอร์ ซึ่งหมายความว่าแอปของคุณยังคงตอบสนองโดยไม่คำนึงถึงเวลาแฝงของเครือข่ายหรือการเชื่อมต่อ

เมื่อสร้างการเชื่อมต่อใหม่แล้วแอปของคุณจะได้รับชุดเหตุการณ์ที่เหมาะสมเพื่อให้ไคลเอนต์ซิงค์กับสถานะเซิร์ฟเวอร์ปัจจุบันโดยไม่ต้องเขียนโค้ดที่กำหนดเองใด ๆ

ขั้นตอนถัดไป