Android에서 데이터 목록 다루기

이 문서에서는 Firebase에서 데이터 목록을 다루는 방법을 설명합니다. Firebase 데이터를 읽고 쓰는 기초적인 방법은 Android에서 데이터 읽기 및 쓰기를 참조하세요.

DatabaseReference 가져오기

데이터베이스에서 데이터를 읽고 쓰려면 DatabaseReference 인스턴스가 필요합니다.

Kotlin

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

Java

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

목록 읽기 및 쓰기

데이터 목록에 추가

멀티 사용자 애플리케이션에서 목록에 데이터를 추가하려면 push() 메서드를 사용합니다. push() 메서드는 지정된 Firebase 참조에 새 하위 요소가 추가될 때마다 고유 키를 생성합니다. 목록의 새 요소마다 이러한 자동 생성 키를 사용하면 여러 클라이언트에서 쓰기 충돌 없이 동시에 하위 요소를 같은 위치에 추가할 수 있습니다. push()가 생성하는 고유 키는 타임스탬프에 기반하므로 목록 항목은 시간순으로 자동 정렬됩니다.

push() 메서드가 반환하는 새 데이터에 대한 참조를 사용하여 하위 요소의 자동 생성 키 값을 가져오거나 하위 데이터를 설정할 수 있습니다. push() 참조에 대해 getKey()를 호출하면 자동 생성 키 값이 반환됩니다.

이러한 자동 생성 키를 사용하면 데이터 구조의 평면화 작업이 단순해집니다. 자세한 내용은 데이터 팬아웃 예시를 참조하세요.

하위 이벤트 수신 대기

목록을 사용할 경우 애플리케이션에서 단일 객체에 사용되는 값 이벤트가 아닌 하위 이벤트를 수신 대기해야 합니다.

하위 이벤트는 노드의 하위 요소에서 발생하는 특정 작업에 대응하여 트리거됩니다. 하위 요소가 push() 메서드를 통해 새로 추가되거나 updateChildren() 메서드를 통해 업데이트되는 경우가 그 예시입니다. 이러한 메서드는 데이터베이스의 특정 노드에 대한 변경사항을 수신 대기하는 데 유용할 수 있습니다.

DatabaseReference의 하위 이벤트를 수신 대기하려면 ChildEventListener를 연결합니다.

리스너 이벤트 콜백 일반적인 용도
ChildEventListener onChildAdded() 항목 목록을 검색하거나 항목 목록에 대한 추가를 수신 대기합니다. 이 콜백은 기존 하위 요소마다 한 번씩 트리거된 후 새 하위 요소가 지정된 경로에 추가될 때마다 다시 트리거됩니다. 리스너에 전달되는 DataSnapshot에는 새 하위 데이터가 포함됩니다.
onChildChanged() 목록의 항목에 대한 변경사항을 수신 대기합니다. 이 이벤트는 하위 노드가 수정될 때마다 발생하며 여기에는 하위 노드의 하위 요소에 대한 수정사항이 포함됩니다. 이벤트 리스너에 전달되는 DataSnapshot에는 하위 요소의 업데이트된 데이터가 포함됩니다.
onChildRemoved() 목록의 항목 삭제를 수신 대기합니다. 이벤트 콜백에 전달되는 DataSnapshot에는 삭제된 하위 요소의 데이터가 포함됩니다.
onChildMoved() 순서가 지정된 목록의 항목 순서 변경사항을 수신 대기합니다. 하위 요소 재정렬을 야기하는 업데이트로 인해 onChildChanged() 콜백이 트리거될 때마다 이 이벤트가 트리거됩니다. 이 이벤트는 orderByChild 또는 orderByValue로 정렬된 데이터에 사용됩니다.

예를 들어 소셜 미디어 블로깅 앱은 아래와 같이 이러한 메서드를 함께 사용하여 게시물의 댓글 활동을 모니터링할 수 있습니다.

Kotlin 

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

값 이벤트 수신 대기

데이터 목록을 읽을 때 ChildEventListener를 사용하는 것이 좋지만 목록 참조에 ValueEventListener를 연결하는 것이 유용한 상황도 있습니다.

데이터 목록에 ValueEventListener를 연결하면 전체 데이터 목록이 단일 DataSnapshot으로 반환되며 이를 루프 처리하여 개별 하위 요소에 액세스할 수 있습니다.

쿼리에 일치하는 항목이 단 한 개인 경우에도 스냅샷은 목록으로 표시됩니다. 단지 항목이 한 개 있을 뿐입니다. 항목에 액세스하려면 결과를 루프 처리해야 합니다.

Kotlin 

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

onChildAdded 이벤트를 추가로 수신 대기하는 대신 한 번의 작업으로 목록의 모든 하위 요소를 가져오려는 경우 이 패턴이 유용할 수 있습니다.

리스너 분리

Firebase 데이터베이스 참조에 대해 removeEventListener() 메서드를 호출하면 콜백이 삭제됩니다.

한 데이터 위치에 리스너를 여러 번 추가하면 이벤트가 발생할 때마다 리스너가 여러 번 호출되며 리스너를 완전히 삭제하려면 동일한 횟수만큼 리스너를 분리해야 합니다.

상위 리스너에 removeEventListener()를 호출해도 하위 노드에 등록된 리스너가 자동으로 삭제되지 않습니다. 하위 리스너에도 removeEventListener()를 호출하여 콜백을 삭제해야 합니다.

데이터 정렬 및 필터링

Realtime Database의 Query 클래스를 사용하여 키, 값 또는 하위 요소 값으로 정렬된 데이터를 검색할 수 있습니다. 정렬된 결과를 특정 개수로 필터링하거나 키 또는 값 범위에 따라 필터링할 수도 있습니다.

데이터 정렬

정렬된 데이터를 검색하려면 우선 정렬 기준 메서드 중 하나를 지정하여 결과를 어떤 순서로 정렬할지 결정합니다.

메서드 사용
orderByChild() 지정된 하위 키 또는 중첩된 하위 경로의 값에 따라 결과를 정렬합니다.
orderByKey() 하위 키에 따라 결과를 정렬합니다.
orderByValue() 하위 값에 따라 결과를 정렬합니다.

정렬 기준 메서드는 한번에 하나만 사용할 수 있습니다. 동일한 쿼리에서 정렬 기준 메서드를 여러 번 호출하면 오류가 발생합니다.

다음 예시에서는 별표 수를 기준으로 사용자의 최상위 게시물 목록을 검색하는 방법을 보여줍니다.

Kotlin 

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

여기에서는 쿼리를 하위 리스너와 함께 사용하여 사용자 ID를 기준으로 데이터베이스의 특정 경로에 있는 사용자의 게시물을 각 게시물이 받는 별표 수에 따라 정렬한 결과를 클라이언트와 동기화하도록 쿼리를 정의합니다. 이와 같이 ID를 색인 키로 사용하는 기법을 데이터 팬아웃이라고 합니다. 자세한 내용은 데이터베이스 구조화를 참조하세요.

orderByChild() 메서드를 호출할 때는 결과를 정렬하는 기준이 될 하위 키를 지정합니다. 여기에서는 각 게시물의 "starCount" 하위 요소 값에 따라 게시물이 정렬됩니다. 다음과 같은 데이터가 있다면 중첩된 하위 요소에 따라 쿼리를 정렬할 수도 있습니다.

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

이 예시에서는 orderByChild() 호출에서 중첩된 하위 요소의 상대 경로를 지정하여 metrics 키 아래에 중첩된 값에 따라 목록 요소를 정렬할 수 있습니다.

Kotlin 

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

다른 데이터 유형을 정렬하는 방법에 대한 자세한 내용은 쿼리 데이터 정렬 방법을 참조하세요.

데이터 필터링

데이터를 필터링하려면 제한 또는 범위 메서드를 정렬 기준 메서드와 조합하여 쿼리를 작성합니다.

메서드 사용
limitToFirst() 정렬된 결과 목록의 시작 부분부터 반환할 최대 항목 수를 설정합니다.
limitToLast() 정렬된 결과 목록에서 맨 끝부터 반환할 최대 항목 개수를 설정합니다.
startAt() 선택한 정렬 기준 메서드에 따라 지정된 키 또는 값보다 크거나 같은 항목을 반환합니다.
startAfter() 선택한 정렬 기준 메서드에 따라 지정된 키 또는 값보다 큰 항목을 반환합니다.
endAt() 선택한 정렬 기준 메서드에 따라 지정된 키 또는 값보다 작거나 같은 항목을 반환합니다.
endBefore() 선택한 정렬 기준 메서드에 따라 지정된 키 또는 값보다 작은 항목을 반환합니다.
equalTo() 선택한 정렬 기준 메서드에 따라 지정된 키 또는 값과 동일한 항목을 반환합니다.

정렬 기준 메서드와 달리 여러 제한 또는 범위 함수를 결합할 수 있습니다. 예를 들어 startAt() 및 endAt() 메서드를 조합하여 결과를 지정된 값 범위로 제한할 수 있습니다.

쿼리에 일치하는 항목이 단 한 개인 경우에도 스냅샷은 목록으로 표시됩니다. 단지 항목이 한 개 있을 뿐입니다. 항목에 액세스하려면 결과를 루프 처리해야 합니다.

Kotlin 

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

결과 수 제한

limitToFirst() 및 limitToLast() 메서드를 사용하여 특정 콜백에서 동기화할 하위 요소의 최대 개수를 설정할 수 있습니다. 예를 들어 limitToFirst()를 사용하여 제한을 100개로 설정하면 처음에 최대 100개의 onChildAdded() 콜백만 수신합니다. Firebase 데이터베이스에 저장된 항목이 100개 미만이면 각 항목에 onChildAdded() 콜백이 호출됩니다.

항목이 변경됨에 따라 쿼리에 새로 포함되는 항목에 대해 onChildAdded() 콜백, 쿼리에서 제외되는 항목에 대해 onChildRemoved() 콜백이 수신되며 총 개수는 100개로 유지됩니다.

다음 예시에서는 블로깅 앱이 모든 사용자의 게시물 중 최근 100개의 목록을 검색하는 쿼리를 정의하는 방법을 보여줍니다.

Kotlin 

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

이 예시에서는 쿼리를 정의하기만 하므로 데이터를 실제로 동기화하려면 리스너를 연결해야 합니다.

키 또는 값으로 필터링

startAt(), startAfter(), endAt(), endBefore(), equalTo()를 사용하여 쿼리의 시작, 종료, 동일 지점을 임의로 선택할 수 있습니다. 이 메서드는 특정 값을 갖는 하위 요소로 데이터를 페이지로 나누거나 항목을 찾는 데 유용합니다.

쿼리 데이터 정렬 방법

이 섹션에서는 Query 클래스의 각 정렬 기준 메서드에 따라 데이터를 정렬하는 방법을 설명합니다.

orderByChild

orderByChild()를 사용하면 지정된 하위 키를 포함하는 데이터가 다음과 같이 정렬됩니다.

  1. 지정된 하위 키의 값이 null인 하위 요소가 맨 처음에 옵니다.
  2. 지정된 하위 키의 값이 false인 하위 요소가 그다음에 옵니다. 값이 false인 하위 요소가 여러 개인 경우 키에 따라 사전순으로 정렬됩니다.
  3. 지정된 하위 키의 값이 true인 하위 요소가 그다음에 옵니다. 값이 true인 하위 요소가 여러 개인 경우 키에 따라 사전순으로 정렬됩니다.
  4. 숫자 값이 있는 하위 요소가 그다음에 나오며 오름차순으로 정렬됩니다. 지정된 하위 노드의 숫자 값이 동일한 하위 요소가 여러 개면 키에 따라 정렬됩니다.
  5. 숫자 다음에는 문자열이 나오며 사전순, 오름차순으로 정렬됩니다. 지정된 하위 노드의 값이 동일한 하위 요소가 여러 개면 키에 따라 사전순으로 정렬됩니다.
  6. 마지막으로 객체가 나오며 키에 따라 사전순, 오름차순으로 정렬됩니다.

orderByKey

orderByKey()를 사용하여 데이터를 정렬하면 데이터가 오름차순(키 기준)으로 반환됩니다.

  1. 키가 32비트 정수로 파싱될 수 있는 하위 요소가 맨 처음에 나오며 오름차순으로 정렬됩니다.
  2. 키가 문자열 값인 하위 요소가 그다음에 나오며 오름차순(사전순)으로 정렬됩니다.

orderByValue

orderByValue()를 사용하면 하위 요소가 값에 따라 정렬됩니다. 정렬 기준은 orderByChild()와 동일하지만 지정된 하위 키의 값 대신 노드의 값이 사용된다는 점이 다릅니다.

다음 단계