콘솔로 이동

Android에서 데이터 검색

이 문서에서는 데이터 검색의 기초와 함께 Firebase 데이터를 정렬 및 필터링하는 방법을 설명합니다.

Firebase 데이터를 검색하려면 FirebaseDatabase 참조에 비동기 리스너를 연결합니다. 리스너는 데이터의 초기 상태가 확인될 때 한 번 호출된 후 데이터가 변경될 때마다 다시 호출됩니다.

DatabaseReference 가져오기

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

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

이벤트 수신 대기

데이터를 검색하는 다음과 같은 유형의 이벤트를 수신 대기할 수 있습니다.

리스너 이벤트 콜백 일반적인 용도
ValueEventListener onDataChange() 경로의 전체 내용에 대한 변경을 읽고 수신 대기합니다.
ChildEventListener onChildAdded() 항목 목록을 검색하거나 항목 목록에 대한 추가를 수신 대기합니다. onChildChanged()onChildRemoved()와 함께 사용하여 목록의 변경을 모니터링할 수 있습니다.
onChildChanged() 목록의 항목에 대한 변경을 수신 대기합니다. onChildAdded()onChildRemoved()와 함께 사용하여 목록의 변경을 모니터링할 수 있습니다.
onChildRemoved() 목록의 항목 삭제를 수신 대기합니다. onChildAdded()onChildChanged()와 함께 사용하여 목록의 변경을 모니터링할 수 있습니다.
onChildMoved() 순서 있는 목록의 항목 순서 변경을 수신 대기합니다. 현재의 정렬 기준에 따라 항목 순서 변경의 원인이 된 onChildMoved() 이벤트가 onChildChanged() 이벤트를 항상 뒤따릅니다.

값 이벤트 리스너를 추가하려면 addValueEventListener() 또는 addListenerForSingleValueEvent() 메소드를 사용합니다. 하위 이벤트 리스너를 추가하려면 addChildEventListener() 메소드를 사용합니다.

값 이벤트

onDataChange() 메소드를 사용하여 이벤트 발생 시점을 기준으로 지정된 경로에 있는 내용의 정적 스냅샷을 읽을 수 있습니다. 이 메소드는 리스너가 연결될 때 한 번 호출된 후 하위를 포함한 데이터가 변경될 때마다 다시 호출됩니다. 하위 데이터를 포함하여 해당 위치의 모든 데이터를 포함하는 스냅샷이 이벤트 콜백에 전달됩니다. 데이터가 없는 경우 반환되는 스냅샷은 null입니다.

다음 예는 데이터베이스에서 게시물 세부정보를 검색하는 소셜 블로깅 애플리케이션을 보여 줍니다.

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

리스너는 이벤트 발생 시점에 데이터베이스에서 지정된 위치에 있던 데이터를 포함하는 DataSnapshot을 수신합니다. 스냅샷에 대해 getValue()를 호출하면 데이터를 나타내는 Java 개체 표현이 반환됩니다. 지정된 위치에 데이터가 없는 경우 getValue()를 호출하면 null이 반환됩니다.

이 예제에서 ValueEventListener는 읽기가 취소된 경우에 호출되는 onCancelled() 메소드도 정의합니다. 예를 들어 클라이언트에 Firebase 데이터베이스 위치에서 데이터를 읽을 권한이 없으면 읽기가 취소될 수 있습니다. 이 메소드에는 실패 이유를 나타내는 DatabaseError 개체가 전달됩니다.

하위 이벤트

하위 이벤트는 노드의 하위에서 발생하는 특정 작업에 대응하여 발생합니다. 하위 항목이 push() 메소드를 통해 새로 추가되거나 updateChildren() 메소드를 통해 업데이트되는 경우가 그 예입니다. 이러한 메소드는 데이터베이스의 특정 노드에 대한 변경을 수신 대기하는 데 유용할 수 있습니다. 예를 들어 소셜 블로깅 앱은 아래와 같이 이러한 메소드를 함께 사용하여 게시물의 댓글 활동을 모니터링할 수 있습니다.

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();
    }
};
ref.addChildEventListener(childEventListener);

onChildAdded() 콜백은 일반적으로 Firebase 데이터베이스의 항목 목록을 검색하는 데 사용됩니다. onChildAdded() 콜백은 기존 하위 항목마다 한 번씩 발생한 후 지정된 경로에 하위 항목이 새로 추가될 때마다 다시 발생합니다. 리스너에는 새 하위 항목의 데이터를 포함하는 스냅샷이 전달됩니다.

onChildChanged() 콜백은 하위 노드가 수정될 때마다 호출됩니다. 여기에는 하위 노드의 하위에 대한 수정이 포함됩니다. 이 콜백은 일반적으로 onChildAdded()onChildRemoved() 콜백과 함께 항목 목록의 변경에 대응하는 데 사용됩니다. 이벤트 리스너에 전달되는 스냅샷에는 하위 항목의 업데이트된 데이터가 포함됩니다.

onChildRemoved() 콜백은 바로 아래 하위 항목이 삭제될 때 호출됩니다. 이 콜백은 일반적으로 onChildAdded()onChildChanged() 콜백과 함께 사용됩니다. 이벤트 콜백에 전달되는 스냅샷에는 삭제된 하위 항목의 데이터가 포함됩니다.

하위 항목의 재정렬을 야기하는 업데이트에 의해 onChildChanged() 콜백이 호출될 때마다 onChildMoved() 콜백이 호출됩니다. 이 이벤트는 orderByChild 또는 orderByValue로 정렬된 데이터에 사용됩니다.

리스너 분리

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

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

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

데이터 한 번 읽기

한 번만 호출되고 즉시 삭제되는 콜백이 필요한 경우가 있습니다. 이후에 변경되지 않는 UI 요소를 초기화할 때가 그 예입니다. 이러한 경우 addListenerForSingleValueEvent() 메소드를 사용하면 시나리오가 단순해집니다. 이 메소드는 한 번 호출된 후 다시 호출되지 않습니다.

이 방법은 한 번 로드된 후 자주 변경되지 않거나 능동적으로 수신 대기할 필요가 없는 데이터에 유용합니다. 예를 들어 위 예제의 블로깅 앱에서는 사용자가 새 게시물을 작성하기 시작할 때 이 메소드로 사용자의 프로필을 로드합니다.

final String userId = getUid();
mDatabase.child("users").child(userId).addListenerForSingleValueEvent(
        new ValueEventListener() {
            @Override
            public void onDataChange(DataSnapshot dataSnapshot) {
                // Get user value
                User user = dataSnapshot.getValue(User.class);

                // ...
            }

            @Override
            public void onCancelled(DatabaseError databaseError) {
                Log.w(TAG, "getUser:onCancelled", databaseError.toException());
            }
        });

데이터 정렬 및 필터링

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

데이터 정렬

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

메소드 용도
orderByChild() 지정된 하위 키의 값에 따라 결과를 정렬합니다.
orderByKey() 하위 키에 따라 결과를 정렬합니다.
orderByValue() 하위 값에 따라 결과를 정렬합니다.

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

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

// My top posts by number of stars
String myUserId = getUid();
Query myTopPostsQuery = databaseReference.child("user-posts").child(myUserId)
        .orderByChild("starCount");

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

orderByChild() 메소드를 호출할 때는 결과를 정렬할 기준이 될 하위 키를 지정합니다. 여기에서는 각 게시물의 "starCount" 하위 항목 값에 따라 게시물이 정렬됩니다. 다른 데이터 유형이 정렬되는 방법에 대한 자세한 내용은 쿼리 데이터의 순서를 참조하세요.

데이터 필터링

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

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

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

결과 수 제한

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

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

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

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

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

키 또는 값으로 필터링

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

쿼리 데이터의 순서

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

orderByChild

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

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

orderByKey

orderByKey()를 사용하여 데이터를 정렬하는 경우 데이터가 키에 따라 오름차순으로 반환됩니다.

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

orderByValue

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

다음 단계