Làm việc với Danh sách dữ liệu trên Android

Tài liệu này trình bày cách làm việc với danh sách dữ liệu trong Firebase. Để tìm hiểu các kiến thức cơ bản về cách đọc và ghi dữ liệu Firebase, hãy xem bài viết Đọc và ghi dữ liệu trên Android.

Nhận một DatabaseReference

Để đọc và ghi dữ liệu từ cơ sở dữ liệu, bạn cần có một thực thể của DatabaseReference:

Kotlin+KTX

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

Java

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

Đọc và ghi danh sách

Thêm vào danh sách dữ liệu

Sử dụng phương thức push() để nối dữ liệu vào một danh sách trong các ứng dụng nhiều người dùng. Phương thức push() tạo một khoá duy nhất mỗi khi có một khoá mới con sẽ được thêm vào tham chiếu Firebase được chỉ định. Bằng cách sử dụng các khoá được tạo tự động này cho mỗi phần tử mới trong danh sách, một số ứng dụng có thể thêm các phần tử con vào cùng một vị trí cùng một lúc mà không xảy ra xung đột ghi. Chiến lược phát hành đĩa đơn khoá duy nhất do push() tạo dựa trên dấu thời gian, vì vậy các mục trong danh sách tự động sắp xếp theo trình tự thời gian.

Bạn có thể sử dụng tệp tham chiếu đến dữ liệu mới do phương thức push() trả về để lấy giá trị của khoá được tạo tự động của phần tử con hoặc đặt dữ liệu cho phần tử con. Việc gọi getKey() trên tệp tham chiếu push() sẽ trả về giá trị của khoá được tạo tự động.

Bạn có thể sử dụng những khoá được tạo tự động này để đơn giản hoá quá trình làm phẳng dữ liệu cấu trúc. Để biết thêm thông tin, hãy xem phần chia sẻ dữ liệu ví dụ.

Theo dõi các sự kiện của trẻ

Khi làm việc với danh sách, ứng dụng của bạn phải theo dõi các sự kiện con thay vì các sự kiện giá trị được dùng cho đối tượng đơn lẻ.

Các sự kiện con được kích hoạt để phản hồi các thao tác cụ thể xảy ra với các nút con của một nút từ một thao tác, chẳng hạn như một nút con mới được thêm thông qua phương thức push() hoặc một nút con đang được cập nhật thông qua phương thức updateChildren(). Mỗi loại trong số này có thể hữu ích khi theo dõi các thay đổi đối với một nút cụ thể trong cơ sở dữ liệu.

Để theo dõi các sự kiện con trên DatabaseReference, hãy đính kèm một ChildEventListener:

gửi biểu mẫu Lệnh gọi lại sự kiện Mức sử dụng thông thường
ChildEventListener onChildAdded() Truy xuất danh sách các mục hoặc theo dõi để bổ sung vào danh sách các mục. Lệnh gọi lại này được kích hoạt một lần cho mỗi nhà xuất bản con hiện có rồi lặp lại mỗi khi thêm một thành phần con mới vào đường dẫn được chỉ định. DataSnapshot được truyền đến trình nghe chứa dữ liệu của nhà xuất bản con mới.
onChildChanged() Theo dõi những thay đổi đối với các mục trong danh sách. Sự kiện này được kích hoạt bất cứ khi nào một nút con được sửa đổi, bao gồm mọi nội dung sửa đổi đối với các phần tử con của nút con đó. DataSnapshot được truyền đến trình nghe sự kiện chứa dữ liệu đã cập nhật cho phần tử con.
onChildRemoved() Nghe các mục bị xoá khỏi danh sách. Chiến lược phát hành đĩa đơn DataSnapshot được truyền đến lệnh gọi lại sự kiện chứa dữ liệu của trẻ bị xoá.
onChildMoved() Theo dõi những thay đổi đối với thứ tự của các mục trong danh sách theo thứ tự. Sự kiện này được kích hoạt bất cứ khi nào onChildChanged() lệnh gọi lại được kích hoạt bởi một bản cập nhật dẫn đến việc sắp xếp lại thứ tự thành phần con. Phương diện này được dùng với dữ liệu được sắp xếp bằng orderByChild hoặc orderByValue.

Ví dụ: một ứng dụng viết blog xã hội có thể sử dụng các phương pháp này cùng nhau để theo dõi hoạt động trong phần nhận xét của bài đăng, như sau:

Kotlin+KTX 

val childEventListener = object : ChildEventListener {
    override fun onChildAdded(dataSnapshot: DataSnapshot, previousChildName: String?) {
        Log.d(TAG, "onChildAdded:" + dataSnapshot.key!!)

        // A new comment has been added, add it to the displayed list
        val comment = dataSnapshot.getValue<Comment>()

        // ...
    }

    override fun onChildChanged(dataSnapshot: DataSnapshot, previousChildName: String?) {
        Log.d(TAG, "onChildChanged: ${dataSnapshot.key}")

        // A comment has changed, use the key to determine if we are displaying this
        // comment and if so displayed the changed comment.
        val newComment = dataSnapshot.getValue<Comment>()
        val commentKey = dataSnapshot.key

        // ...
    }

    override fun onChildRemoved(dataSnapshot: DataSnapshot) {
        Log.d(TAG, "onChildRemoved:" + dataSnapshot.key!!)

        // A comment has changed, use the key to determine if we are displaying this
        // comment and if so remove it.
        val commentKey = dataSnapshot.key

        // ...
    }

    override fun onChildMoved(dataSnapshot: DataSnapshot, previousChildName: String?) {
        Log.d(TAG, "onChildMoved:" + dataSnapshot.key!!)

        // A comment has changed position, use the key to determine if we are
        // displaying this comment and if so move it.
        val movedComment = dataSnapshot.getValue<Comment>()
        val commentKey = dataSnapshot.key

        // ...
    }

    override fun onCancelled(databaseError: DatabaseError) {
        Log.w(TAG, "postComments:onCancelled", databaseError.toException())
        Toast.makeText(
            context,
            "Failed to load comments.",
            Toast.LENGTH_SHORT,
        ).show()
    }
}
databaseReference.addChildEventListener(childEventListener)
QueryActivity.kt

Java 

ChildEventListener childEventListener = new ChildEventListener() {
    @Override
    public void onChildAdded(DataSnapshot dataSnapshot, String previousChildName) {
        Log.d(TAG, "onChildAdded:" + dataSnapshot.getKey());

        // A new comment has been added, add it to the displayed list
        Comment comment = dataSnapshot.getValue(Comment.class);

        // ...
    }

    @Override
    public void onChildChanged(DataSnapshot dataSnapshot, String previousChildName) {
        Log.d(TAG, "onChildChanged:" + dataSnapshot.getKey());

        // A comment has changed, use the key to determine if we are displaying this
        // comment and if so displayed the changed comment.
        Comment newComment = dataSnapshot.getValue(Comment.class);
        String commentKey = dataSnapshot.getKey();

        // ...
    }

    @Override
    public void onChildRemoved(DataSnapshot dataSnapshot) {
        Log.d(TAG, "onChildRemoved:" + dataSnapshot.getKey());

        // A comment has changed, use the key to determine if we are displaying this
        // comment and if so remove it.
        String commentKey = dataSnapshot.getKey();

        // ...
    }

    @Override
    public void onChildMoved(DataSnapshot dataSnapshot, String previousChildName) {
        Log.d(TAG, "onChildMoved:" + dataSnapshot.getKey());

        // A comment has changed position, use the key to determine if we are
        // displaying this comment and if so move it.
        Comment movedComment = dataSnapshot.getValue(Comment.class);
        String commentKey = dataSnapshot.getKey();

        // ...
    }

    @Override
    public void onCancelled(DatabaseError databaseError) {
        Log.w(TAG, "postComments:onCancelled", databaseError.toException());
        Toast.makeText(mContext, "Failed to load comments.",
                Toast.LENGTH_SHORT).show();
    }
};
databaseReference.addChildEventListener(childEventListener);
QueryActivity.java

Theo dõi các sự kiện giá trị

Bạn nên dùng ChildEventListener để đọc danh sách dữ liệu, có những trường hợp trong đó việc đính kèm ValueEventListener vào danh sách tài liệu tham khảo rất hữu ích.

Việc đính kèm ValueEventListener vào một danh sách dữ liệu sẽ trả về toàn bộ danh sách dữ liệu dưới dạng một DataSnapshot mà sau đó bạn có thể lặp lại truy cập vào từng mục con.

Ngay cả khi chỉ có một kết quả phù hợp duy nhất cho truy vấn, ảnh chụp nhanh vẫn là danh sách; nó chỉ chứa một mục duy nhất. Để truy cập vào mục, bạn cần sử dụng vòng lặp đối với kết quả:

Kotlin+KTX 

// My top posts by number of stars
myTopPostsQuery.addValueEventListener(object : ValueEventListener {
    override fun onDataChange(dataSnapshot: DataSnapshot) {
        for (postSnapshot in dataSnapshot.children) {
            // TODO: handle the post
        }
    }

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

Java 

// My top posts by number of stars
myTopPostsQuery.addValueEventListener(new ValueEventListener() {
    @Override
    public void onDataChange(@NonNull DataSnapshot dataSnapshot) {
        for (DataSnapshot postSnapshot: dataSnapshot.getChildren()) {
            // TODO: handle the post
        }
    }

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

Mẫu này có thể hữu ích khi bạn muốn tìm nạp tất cả phần tử con của danh sách trong một thao tác thay vì nghe thêm onChildAdded sự kiện.

Tách trình nghe

Các lệnh gọi lại sẽ bị xoá bằng cách gọi phương thức removeEventListener() trên Tài liệu tham khảo về cơ sở dữ liệu Firebase.

Nếu một trình nghe đã được thêm nhiều lần vào một vị trí dữ liệu, thì trình nghe đó sẽ được gọi nhiều lần cho mỗi sự kiện và bạn phải tách trình nghe đó ra cùng số lần để xoá hoàn toàn trình nghe đó.

Việc gọi removeEventListener() trên trình nghe cha mẹ sẽ không tự động xoá trình nghe đã đăng ký trên các nút con; removeEventListener() cũng phải được gọi trên mọi trình nghe con để loại bỏ lệnh gọi lại.

Sắp xếp và lọc dữ liệu

Bạn có thể sử dụng lớp Realtime Database Query để truy xuất dữ liệu được sắp xếp theo khoá, theo giá trị hoặc theo giá trị của phần tử con. Bạn cũng có thể lọc kết quả được sắp xếp cho một số lượng kết quả cụ thể hoặc một dải khoá hoặc giá trị.

Sắp xếp dữ liệu

Để truy xuất dữ liệu đã sắp xếp, hãy bắt đầu bằng cách chỉ định một trong các phương thức sắp xếp theo thứ tự để xác định cách sắp xếp kết quả:

Phương thức Cách sử dụng
orderByChild() Sắp xếp kết quả theo giá trị của một khoá con đã chỉ định hoặc đường dẫn con lồng nhau.
orderByKey() Sắp xếp kết quả theo khoá con.
orderByValue() Sắp xếp kết quả theo giá trị con.

Mỗi lần, bạn chỉ có thể sử dụng một phương thức đặt hàng. Gọi một phương thức đặt hàng nhiều lần trong cùng một truy vấn sẽ gây ra lỗi.

Ví dụ sau minh hoạ cách truy xuất danh sách thông tin bài đăng hàng đầu được sắp xếp theo số sao:

Kotlin+KTX 

// My top posts by number of stars
val myUserId = uid
val myTopPostsQuery = databaseReference.child("user-posts").child(myUserId)
    .orderByChild("starCount")

myTopPostsQuery.addChildEventListener(object : ChildEventListener {
    // TODO: implement the ChildEventListener methods as documented above
    // ...
})
QueryActivity.kt

Java 

// My top posts by number of stars
String myUserId = getUid();
Query myTopPostsQuery = databaseReference.child("user-posts").child(myUserId)
        .orderByChild("starCount");
myTopPostsQuery.addChildEventListener(new ChildEventListener() {
    // TODO: implement the ChildEventListener methods as documented above
    // ...
});
QueryActivity.java

Lệnh này xác định một truy vấn mà khi được kết hợp với trình nghe con đồng bộ hoá máy khách với các bài đăng của người dùng từ đường dẫn trong cơ sở dữ liệu dựa trên mã nhận dạng người dùng, được sắp xếp theo số sao mà mỗi bài đăng nhận được. Kỹ thuật sử dụng ID làm khoá chỉ mục này được gọi là di chuyển dữ liệu ra ngoài. Bạn có thể đọc thông tin khác về sản phẩm này trong Xây dựng cấu trúc cơ sở dữ liệu của bạn.

Lệnh gọi đến phương thức orderByChild() chỉ định khoá con để sắp xếp kết quả theo. Trong trường hợp này, các bài đăng được sắp xếp theo giá trị của "starCount" con tương ứng. Các truy vấn cũng có thể được sắp xếp theo con, trong trường hợp bạn có dữ liệu giống như sau:

"posts": {
  "ts-functions": {
    "metrics": {
      "views" : 1200000,
      "likes" : 251000,
      "shares": 1200,
    },
    "title" : "Why you should use TypeScript for writing Cloud Functions",
    "author": "Doug",
  },
  "android-arch-3": {
    "metrics": {
      "views" : 900000,
      "likes" : 117000,
      "shares": 144,
    },
    "title" : "Using Android Architecture Components with Firebase Realtime Database (Part 3)",
    "author": "Doug",
  }
},

Trong ví dụ này, chúng ta có thể sắp xếp các phần tử danh sách theo giá trị được lồng trong metrics bằng cách chỉ định đường dẫn tương đối đến thành phần con được lồng trong Cuộc gọi orderByChild().

Kotlin+KTX 

// Most viewed posts
val myMostViewedPostsQuery = databaseReference.child("posts")
    .orderByChild("metrics/views")
myMostViewedPostsQuery.addChildEventListener(object : ChildEventListener {
    // TODO: implement the ChildEventListener methods as documented above
    // ...
})
QueryActivity.kt

Java 

// Most viewed posts
Query myMostViewedPostsQuery = databaseReference.child("posts")
        .orderByChild("metrics/views");
myMostViewedPostsQuery.addChildEventListener(new ChildEventListener() {
    // TODO: implement the ChildEventListener methods as documented above
    // ...
});
QueryActivity.java

Để biết thêm thông tin về cách sắp xếp các loại dữ liệu khác, hãy xem Cách sắp xếp dữ liệu truy vấn.

Lọc dữ liệu

Để lọc dữ liệu, bạn có thể kết hợp bất kỳ phương pháp giới hạn hoặc phạm vi nào với theo thứ tự khi tạo truy vấn.

Phương thức Cách sử dụng
limitToFirst() Đặt số lượng mục tối đa cần trả về từ đầu danh sách kết quả theo thứ tự.
limitToLast() Đặt số lượng mặt hàng tối đa cần trả về tính từ cuối đơn đặt hàng danh sách kết quả.
startAt() Trả về các mục lớn hơn hoặc bằng khoá hoặc giá trị đã chỉ định tuỳ theo phương thức đã chọn.
startAfter() Trả về các mục lớn hơn khoá hoặc giá trị đã chỉ định tuỳ theo phương thức đã chọn.
endAt() Trả về các mục nhỏ hơn hoặc bằng khoá hoặc giá trị được chỉ định, tuỳ thuộc vào phương thức sắp xếp theo thứ tự đã chọn.
endBefore() Trả về các mục có giá trị thấp hơn khoá hoặc giá trị đã chỉ định tuỳ theo phương thức đã chọn.
equalTo() Trả về các mục bằng với khoá hoặc giá trị đã chỉ định tuỳ theo phương thức đã chọn.

Không giống như các phương thức sắp xếp theo, bạn có thể kết hợp nhiều hàm giới hạn hoặc hàm phạm vi. Ví dụ: bạn có thể kết hợp phương thức startAt() và endAt() để giới hạn kết quả trong phạm vi giá trị được chỉ định.

Ngay cả khi chỉ có một kết quả phù hợp duy nhất cho truy vấn, ảnh chụp nhanh vẫn sẽ một danh sách; nó chỉ chứa một mục duy nhất. Để truy cập vào mục này, bạn cần để lặp lại kết quả:

Kotlin+KTX 

// My top posts by number of stars
myTopPostsQuery.addValueEventListener(object : ValueEventListener {
    override fun onDataChange(dataSnapshot: DataSnapshot) {
        for (postSnapshot in dataSnapshot.children) {
            // TODO: handle the post
        }
    }

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

Java 

// My top posts by number of stars
myTopPostsQuery.addValueEventListener(new ValueEventListener() {
    @Override
    public void onDataChange(@NonNull DataSnapshot dataSnapshot) {
        for (DataSnapshot postSnapshot: dataSnapshot.getChildren()) {
            // TODO: handle the post
        }
    }

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

Giới hạn số lượng kết quả

Bạn có thể sử dụng các phương thức limitToFirst() và limitToLast() để đặt giá trị số lượng phần tử con tối đa cần đồng bộ hoá cho một lệnh gọi lại nhất định. Ví dụ: nếu bạn sử dụng limitToFirst() để đặt giới hạn là 100, ban đầu bạn chỉ nhận được thành 100 lệnh gọi lại onChildAdded(). Nếu bạn có ít hơn 100 mục được lưu trữ trong cơ sở dữ liệu Firebase, thì lệnh gọi lại onChildAdded() sẽ kích hoạt cho mỗi mục.

Khi các mục thay đổi, bạn sẽ nhận được lệnh gọi lại onChildAdded() cho các mục nhập và lệnh gọi lại onChildRemoved() cho các mục bị loại bỏ để thì tổng số vẫn là 100.

Ví dụ sau đây minh hoạ cách ứng dụng viết blog mẫu xác định truy vấn để truy xuất danh sách 100 bài đăng gần đây nhất của tất cả người dùng:

Kotlin+KTX 

// Last 100 posts, these are automatically the 100 most recent
// due to sorting by push() keys.
databaseReference.child("posts").limitToFirst(100)
QueryActivity.kt

Java 

// Last 100 posts, these are automatically the 100 most recent
// due to sorting by push() keys
Query recentPostsQuery = databaseReference.child("posts")
        .limitToFirst(100);
QueryActivity.java

Ví dụ này chỉ xác định một truy vấn để thực sự đồng bộ hoá dữ liệu mà truy vấn cần có một trình nghe đính kèm.

Lọc theo khoá hoặc giá trị

Bạn có thể sử dụng startAt(), startAfter(), endAt(), endBefore() và equalTo() để chọn điểm bắt đầu, kết thúc và điểm tương đương cho truy vấn. Điều này có thể hữu ích cho việc phân trang dữ liệu hoặc tìm các mục có phần tử con có giá trị cụ thể.

Cách sắp xếp dữ liệu truy vấn

Phần này giải thích cách dữ liệu được sắp xếp theo từng phương thức trong Lớp Query.

orderByChild

Khi sử dụng orderByChild(), dữ liệu chứa khoá con được chỉ định sẽ được sắp xếp như sau:

  1. Phần tử con có giá trị null cho khoá con đã chỉ định sẽ xuất hiện đầu tiên.
  2. Khoá con được chỉ định có giá trị false tiếp theo. Nếu nhiều phần tử con có giá trị false, thì chúng sẽ được sắp xếp theo từ điển theo khoá.
  3. Khoá con được chỉ định có giá trị true tiếp theo. Nếu nhiều phần tử con có giá trị true, thì chúng sẽ được sắp xếp theo từ điển theo khoá.
  4. Tiếp theo là các phần tử con có giá trị số, được sắp xếp theo thứ tự tăng dần. Nếu nhiều phần tử con có cùng giá trị số cho phần tử con được chỉ định nút, chúng được sắp xếp theo khoá.
  5. Chuỗi đứng sau số và được sắp xếp theo thứ tự bảng chữ cái theo thứ tự tăng dần. Nếu nhiều phần tử con có cùng giá trị đối với phần tử con được chỉ định nút, các nút này được sắp xếp từ vựng theo khoá.
  6. Các đối tượng nằm ở cuối cùng và được sắp xếp theo thứ tự bảng chữ cái theo khoá theo thứ tự tăng dần.

orderByKey

Khi sử dụng orderByKey() để sắp xếp dữ liệu, dữ liệu sẽ được trả về theo thứ tự tăng dần theo khoá.

  1. Phần tử con có khoá có thể được phân tích cú pháp dưới dạng số nguyên 32 bit sẽ đứng trước và được sắp xếp theo thứ tự tăng dần.
  2. Phần tử con có giá trị chuỗi là khoá tiếp theo, được sắp xếp theo từ điển theo thứ tự tăng dần.

orderByValue

Khi sử dụng orderByValue(), phần tử con được sắp xếp theo giá trị. Thứ tự tiêu chí sẽ giống như trong orderByChild(), ngoại trừ giá trị của nút là được dùng thay cho giá trị của khoá con được chỉ định.

Các bước tiếp theo