Android 上でのデータのリストの操作

このドキュメントでは、Firebase でデータのリストを操作する方法について説明します。Firebase データの読み取りと書き込みの基本については、Android でのデータの読み取りと書き込みをご覧ください。

注: デフォルトでは、認証されたユーザーのみがデータベースのデータを読み書きできるように、読み取りと書き込みのアクセス権が制限されています。Authentication を設定せずに開始するには、公開アクセスルールを構成します。この場合、アプリを使用しない人を含むあらゆる人々にデータベースが公開されるため、認証の設定時には、データベースのアクセスを必ず制限してください。

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() を呼び出すと、自動生成されたキーの値が返されます。

この自動生成されたキーを使用すると、データ構造を平坦化しやすくなります。詳細については、データのファンアウトの例をご覧ください。

child イベントのリッスン

リストを操作するときには、単一のオブジェクトに使用される value イベントではなく、child イベントをアプリケーションでリッスンする必要があります。

push() メソッドによる新しい子の追加や、updateChildren() メソッドによる子の更新など、ノードの子に対して発生した特定のオペレーションに応じて child イベントがトリガーされます。それぞれのイベントを組み合わせると、データベース内の特定のノードの変更内容をリッスンするうえで役立ちます。

DatabaseReference で child イベントをリッスンするには、ChildEventListener をアタッチします。

リスナー	イベント コールバック	一般的な使用方法
ChildEventListener	onChildAdded()	アイテムのリストを取得します。また、アイテムのリストへの追加をリッスンします。このコールバックは既存の子ごとに 1 回トリガーされます。さらに、指定されたパスに新しい子が追加されると、そのたびに再びトリガーされます。リスナーに渡される 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

value イベントのリッスン

データのリストの読み取りには ChildEventListener の使用をおすすめしますが、リスト参照に ValueEventListener をアタッチするほうが有効な場合もあります。

データのリストに ValueEventListener をアタッチすると、データのリスト全体が単一の DataSnapshot として返されるため、これをループして個別の子にアクセスできます。

クエリで一致が 1 つしかない場合でも、スナップショットはリストになります（ただし、アイテムは 1 つしか含まれていません）。アイテムにアクセスするには、結果をループする必要があります。

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() メソッドを呼び出します。

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

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

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

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

注: フィルタリングや並べ替えは、特にクライアント上で行うと、高コストになることがあります。アプリでクエリを使用する場合は、データのインデックス作成で説明されているように、サーバー上でキーにインデックスを付ける .indexOn ルールを定義して、クエリのパフォーマンスを改善してください。

データを並べ替える

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

メソッド	用途
orderByChild()	指定した子キーまたはネストされた子のパスの値によって結果を並べ替えます。
orderByKey()	子キーによって結果を並べ替えます。
orderByValue()	子の値によって結果を並べ替えます。

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

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

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 は、それぞれの投稿が受けたスターの数で並べ替えられています。このように 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

他の種類のデータを並べ替える方法の詳細については、クエリデータが並べ替えられる仕組みをご覧ください。

データのフィルタリング

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

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

order-by メソッドとは異なり、複数の制限関数または範囲関数を組み合わせることができます。たとえば、startAt() メソッドと endAt() メソッドを組み合わせて、結果を特定の範囲の値に制限できます。

クエリで一致が 1 つしかない場合でも、スナップショットはリストになります（ただし、アイテムは 1 つしか含まれていません）。そのアイテムにアクセスするには、結果をループする必要があります。

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 クラスのそれぞれの order-by メソッドでデータがどのように並べ替えられるのかを説明します。

orderByChild

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

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

orderByKey

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

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

orderByValue

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

次のステップ

• データを構造化する方法を学ぶ
• データをオフラインで保存する