Android でのデータの取得

このドキュメントでは、データの取得に関する基本と、Firebase データの並べ替えとフィルタリングの方法について説明します。

Firebase データは、非同期リスナーを FirebaseDatabase 参照にアタッチして取得します。リスナーはデータの初期状態で 1 回トリガーされます。さらに、データが変更されると、そのたびに再びトリガーされます。

DatabaseReference を取得する

データベースからデータを読み取るには、次に示す DatabaseReference のインスタンスが必要です。

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

イベントをリッスンする

以下に示す種類のデータ検索イベントをリッスンできます。

リスナー イベント コールバック 一般的な使用方法
ValueEventListener onDataChange() パスのコンテンツ全体に対する変更の読み取りとリッスンを行います。
ChildEventListener onChildAdded() アイテムのリストを取得するか、アイテムのリストへの追加がないかリッスンします。 onChildChanged()onChildRemoved() と併用して、リストに対する変更をモニタリングすることをおすすめします。
onChildChanged() リスト内のアイテムに対する変更がないかリッスンします。onChildAdded()onChildRemoved() と併用して、リストに対する変更をモニタリングします。
onChildRemoved() リストから削除されるアイテムがないかリッスンします。onChildAdded()onChildChanged() と併用して、リストに対する変更をモニタリングします。
onChildMoved() 並べ替えリストの項目順に変更がないかリッスンします。 onChildMoved() イベントは常に、(現在の order-by メソッドに基づく)並べ替え変更が原因の onChildChanged() イベントに後続します。

value イベントのリスナーを追加するには、addValueEventListener() または addListenerForSingleValueEvent() メソッドを使用します。child イベントのリスナーを追加するには、addChildEventListener() メソッドを使用します。

value イベント

onDataChange() メソッドを使用して、特定のパスにあるコンテンツの静的スナップショットを、イベントのときに存在していたとおりに読み取ることができます。このメソッドはリスナーがアタッチされたときに 1 回トリガーされます。さらに、データ(子も含む)が変更されると、そのたびに再びトリガーされます。イベントのコールバックには、その場所にあるすべてのデータ(子のデータも含む)を含んでいるスナップショットが渡されます。データが存在しない場合、返されるスナップショットは 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 が返されます。

この例では、ValueEventListeneronCancelled() メソッドも定義しています。読み取りがキャンセルされた場合、このメソッドが呼び出されます。たとえば、Firebase データベースの場所から読み取る権限がクライアントにない場合、読み取りをキャンセルできます。このメソッドには、エラーが発生した理由を示す DatabaseError オブジェクトが渡されます。

child イベント

push() メソッドによる新しい子の追加や、updateChildren() メソッドによる子の更新など、ノードの子に対して発生した特定の操作に応じて、child イベントがトリガーされます。それぞれのイベントを組み合わせると、データベース内の特定のノードに対する変更をリッスンする場合に役立つことがあります。たとえば、ソーシャルブログ アプリでは、以下に示すように、これらのメソッドを組み合わせて使用して投稿のコメントでのアクティビティをモニタリングできます。

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() コールバックは既存の子ごとに 1 回トリガーされます。さらに、指定されたパスに新しい子が追加されると、そのたびに再びトリガーされます。リスナーには、新しい子のデータを含んでいるスナップショットが渡されます。

子ノードが変更されると、そのたびに onChildChanged() コールバックがトリガーされます。この変更には、子ノードの子孫に対する変更も含まれます。このコールバックはアイテムのリストに対する変更に応答するために通常、onChildAdded() コールバックや onChildRemoved() コールバックと組み合わせて使用されます。イベント リスナーに渡されるスナップショットには、子の更新済みデータが含まれています。

onChildRemoved() コールバックは直接の子が削除されるとトリガーされます。これは通常、onChildAdded() コールバックや onChildChanged() コールバックと組み合わせて使用します。イベントのコールバックに渡されるスナップショットには、削除された子のデータが含まれています。

onChildMoved() コールバックは、子の再並べ替えを引き起こす更新によって、onChildChanged() コールバックがトリガーされるたびにトリガーされます。orderByChild または orderByValue によるデータの並べ替えに使用されます。」

リスナーのデタッチ

コールバックを削除するには、Firebase データベース参照の removeEventListener() メソッドを呼び出します。

1 つのデータの場所にリスナーが複数回追加されると、そのリスナーはイベントごとに複数回呼び出されるので、そのリスナーを完全に削除するには同じ回数だけデタッチする必要があります。

親リスナーの removeEventListener() を呼び出しても、その子ノードに登録されているリスナーが自動的に削除されるわけでありません。また、コールバックを削除するために子リスナーの removeEventListener() も呼び出す必要があります。

データの 1 回読み取り

変更を想定していない UI 要素を初期化するときなど、コールバックを 1 回呼び出してから直ちに削除したい場合があります。addListenerForSingleValueEvent() メソッドを使用して、このシナリオを簡素化できます。このメソッドは 1 回トリガーされ、その後再びトリガーされることはありません。

これは 1 回読み込む必要があるだけで頻繁な変更やアクティブなリッスンを行うことは想定していないデータに対して有用です。たとえば、以前の例にあるブログアプリでは、このメソッドを使用して、ユーザーが新しい投稿を作成し始めたときにユーザーのプロフィールを読み込んでいます。

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

データの並べ替えとフィルタリング

Realtime Database の Query クラスを使用して、キー、値、または子の値で並べ替えられたデータを取得できます。また、並べ替えられた結果を、特定の個数の結果またはある範囲のキーや値にフィルタリングできます。

データを並べ替える

並べ替えられたデータを取得するには、最初にいずれかの order-by メソッドを指定して、結果の並べ替え方法を決定します。

メソッド 使用方法
orderByChild() 指定した子キーの値で結果を並べ替えます。
orderByKey() 子キーで結果を並べ替えます。
orderByValue() 子の値で結果を並べ替えます。

同時に使用できる order-by メソッドは 1 つだけです。同じクエリで order-by メソッドを複数回呼び出すとエラーがスローされます。

次の例では、スターの数で並べ替えられたユーザーの上位の投稿のリストを取得する方法について示しています。

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

ここでは、子リスナーと組み合わせて、ユーザー ID に基づいてデータベース内のパスからクライアントをユーザーの投稿と同期させるクエリを定義しています。ユーザー ID は、それぞれの投稿が受けたスターの数で並べ替えられています。このように ID をインデックス キーとして使用する手法はデータのファンアウトと呼ばれています。詳細については、データベースの構造化をご覧ください。

orderByChild() メソッドの呼び出しでは、結果を並べ替えるための子キーを指定します。ここでは、投稿はそれぞれの投稿の子 "starCount" の値で並べ替えられます。他の種類のデータを並べ替える方法の詳細については、クエリデータが並べ替えられる仕組みをご覧ください。

データのフィルタリング

データをフィルタリングするには、クエリの構築時に、制限メソッドまたは範囲メソッドのいずれかを order-by メソッドと組み合わせることができます。

メソッド 使用方法
limitToFirst() 並べ替えられた結果リストの先頭から返すアイテムの最大数を設定します。
limitToLast() 並べ替えられた結果リストの末尾から返すアイテムの最大数を設定します。
startAt() 選択した order-by メソッドに応じて、指定したキーまたは値以上のアイテムを返します。
endAt() 選択した order-by メソッドに応じて、指定したキーまたは値以下のアイテムを返します。
equalTo() 選択した order-by メソッドに応じて、指定したキーまたは値に等しいアイテムを返します。

order-by メソッドとは異なり、複数の制限関数または範囲関数を組み合わせることができます。たとえば、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 クラスのそれぞれの order-by メソッドでデータがどのように並べ替えられるのかを説明します。

orderByChild

orderByChild() を使用すると、指定した子キーを含むデータは次のように並べ替えられます。

  1. 指定した子キーに null 値を持つ子が最初に来ます。
  2. 指定した子キーに false 値を持つ子が次に来ます。複数の子が値 false を持つ場合、キーで辞書順に並べ替えられます。
  3. 指定した子キーに true 値を持つ子が次に来ます。複数の子が値 true を持つ場合、キーで辞書順に並べ替えられます。
  4. 数値を持つ子が次に来ます。ただし、昇順に並べ替えられます。複数の子が指定した子ノードに同じ数値を持つ場合、キーで並べ替えられます。
  5. 文字列は数値の後に来て、辞書順で昇順に並べ替えられます。複数の子が指定した子ノードに同じ値を持つ場合、キーで辞書順に並べ替えられます。
  6. オブジェクトが最後に来て、キーの辞書順で昇順に並べ替えられます。

orderByKey

orderByKey() を使用してデータを並べ替えると、キー名の昇順でデータが返されます。

  1. 32 ビット整数として解析できるキーを持つ子が最初に来ます。ただし、昇順に並べ替えられます。
  2. 文字列値をキーとして持つ子が次に来ます。ただし、辞書順で昇順に並べ替えられます。

orderByValue

orderByValue() を使用すると、子がその値で並べ替えられます。並べ替えの条件は、指定した子キーの値の代わりにノードの値が使用されるという点を除いて、orderByChild() の場合と同じです。

次のステップ

フィードバックを送信...