Android でのデータの保存

Firebase Realtime Database にデータを書き込むメソッドは次の 4 種類です。

メソッド	一般的な使用例
setValue()	users/<user-id>/<username> など、定義済みのパスへのデータの書き込みや、データの置換を行います。
push()	データのリストに追加します。push() を呼び出すたびに、user-posts/<user-id>/<unique-post-id> のような一意の識別子としても使用できる一意のキーが生成されます。
updateChildren()	データのすべてを置換することなく、定義済みのパスのキーの一部を更新します。
runTransaction()	同時更新によって破損する可能性がある複合データを更新します。

DatabaseReference を取得する

データベースにデータを書き込むには、DatabaseReference のインスタンスが必要です。

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

参照でのデータの書き込み、更新、削除

基本的な書き込み操作

基本的な書き込み操作には、setValue() を使用してデータを特定の参照に保存できます。そのパスにある既存のデータが置換されます。このメソッドを使用してできる内容は次のとおりです。

• 次のような、使用可能な JSON 型に対応する型を渡します。
  • String
  • Long
  • Double
  • Boolean
  • Map<String, Object>
  • List<Object>
• カスタム Java オブジェクトを渡します。そのオブジェクトを定義するクラスに、引数を取らないデフォルト コンストラクタと、代入するプロパティのパブリック ゲッターが存在することが条件です。

Java オブジェクトを使用した場合、オブジェクトのコンテンツが子の場所にネスト式に自動マッピングされます。一般に、Java オブジェクトを使用するとコードが読みやすくなり、メンテナンスが容易になります。たとえば、アプリでユーザーの基本的なプロフィールを使用する場合、User オブジェクトは次のようになります。

@IgnoreExtraProperties
public class User {

    public String username;
    public String email;

    public User() {
        // Default constructor required for calls to DataSnapshot.getValue(User.class)
    }

    public User(String username, String email) {
        this.username = username;
        this.email = email;
    }

}

次のように setValue() でユーザーを追加できます。

private void writeNewUser(String userId, String name, String email) {
    User user = new User(name, email);

    mDatabase.child("users").child(userId).setValue(user);
}

setValue() をこの方法で使用すると、特定の場所にあるデータ（子ノードも含む）が上書きされます。ただし、オブジェクト全体を書き換えずに子を更新することも可能です。users に自分のプロフィールの更新を許可する場合、次のように username を更新できます。

mDatabase.child("users").child(userId).child("username").setValue(name);

データのリストへの追加

push() メソッドを使用して、マルチユーザー アプリケーションでリストにデータを追加します。 指定した Firebase 参照に新しい子が追加されると、そのたびに push() メソッドは一意のキーを生成します。この自動生成されたキーをリスト内の新しい各要素に使用することで、書き込みの競合を伴わずに複数のクライアントが同時に子を同じ場所に追加できます。push() によって生成される一意のキーはタイムスタンプに基づいているので、リストのアイテムは自動的に時系列で並べ替えられます。

push() メソッドによって返された新しいデータを参照することで、子の自動生成されたキーの値を取得することも、子のデータを設定することも可能になります。push() 参照の getKey() を呼び出すと、自動生成されたキーの値が返されます。

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

特定のフィールドの更新

他の子ノードを上書きすることなく、ノードの特定の複数の子に同時に書き込むには、updateChildren() メソッドを使用します。

updateChildren() の呼び出し時に、キーのパスを指定して下位レベルの子の値を更新できます。拡張性を向上させるためにデータが複数の場所に保存されている場合、データのファンアウトを使用してそのデータのすべてのインスタンスを更新できます。たとえば、ソーシャル ブログ アプリでは、次のような Post クラスを使用することがあります。

@IgnoreExtraProperties
public class Post {

    public String uid;
    public String author;
    public String title;
    public String body;
    public int starCount = 0;
    public Map<String, Boolean> stars = new HashMap<>();

    public Post() {
        // Default constructor required for calls to DataSnapshot.getValue(Post.class)
    }

    public Post(String uid, String author, String title, String body) {
        this.uid = uid;
        this.author = author;
        this.title = title;
        this.body = body;
    }

    @Exclude
    public Map<String, Object> toMap() {
        HashMap<String, Object> result = new HashMap<>();
        result.put("uid", uid);
        result.put("author", author);
        result.put("title", title);
        result.put("body", body);
        result.put("starCount", starCount);
        result.put("stars", stars);

        return result;
    }

}

投稿を作成して、それと同時にその投稿から最近のアクティビティ フィードと投稿ユーザーのアクティビティ フィードを更新するには、ブログアプリで次のようなコードを使用します。

private void writeNewPost(String userId, String username, String title, String body) {
    // Create new post at /user-posts/$userid/$postid and at
    // /posts/$postid simultaneously
    String key = mDatabase.child("posts").push().getKey();
    Post post = new Post(userId, username, title, body);
    Map<String, Object> postValues = post.toMap();

    Map<String, Object> childUpdates = new HashMap<>();
    childUpdates.put("/posts/" + key, postValues);
    childUpdates.put("/user-posts/" + userId + "/" + key, postValues);

    mDatabase.updateChildren(childUpdates);
}

この例では、push() を使用して /posts/$postid にある全ユーザーの投稿を含んでいるノードに投稿を作成し、それと同時に getKey() でキーを取得しています。その後、このキーを使用して、/user-posts/$userid/$postid にあるユーザーの投稿に別のエントリを作成できます。

これらのパスを使用すると、上記の例で両方の場所に新しい投稿を作成したように、updateChildren() を 1 回呼び出すだけで JSON ツリー内の複数の場所に対して更新を同時に実行できます。この方法による同時更新はアトミック（不可分）です。つまり、すべての更新が成功するか、すべての更新が失敗するかのどちらかです。

データの削除

データを削除する最も簡単な方法は、そのデータの場所への参照の removeValue() を呼び出すことです。

setValue() や updateChildren() など、他の書き込み操作の値として null を指定する方法でも削除できます。この方法と updateChildren() を併用すると、API を 1 回呼び出すだけで複数の子を削除できます。

完了コールバックの受信

Firebase Realtime Database サーバーにデータが commit（確定）されたタイミングを把握するには、完了リスナーを追加します。setValue() と updateChildren() のどちらも、書き込みがデータベースに commit されたときに呼び出される完了リスナーをオプションとして取ります。なんらかの理由で呼び出しに失敗した場合、失敗した理由を示すエラー オブジェクトがリスナーに渡されます。

トランザクションとしてのデータの保存

増分カウンタなど、同時変更によって破損する可能性があるデータを操作する場合は、transaction 操作を使用できます。 この操作には、2 つの引数（update 関数とオプションの完了コールバック）を与えます。update 関数はデータの現在の状態を引数として取り、書き込みたい新しい状態を返します。新しい値が正常に書き込まれる前に別のクライアントがその場所に書き込んだ場合、update 関数が現在の新しい値で再度呼び出されて、書き込みが再試行されます。

たとえば、このソーシャルブログ アプリの例では、次のようにして、投稿にスターを付ける / 投稿のスターを取り消す操作をユーザーに許可し、投稿で得られたスターの数を追跡できます。

private void onStarClicked(DatabaseReference postRef) {
    postRef.runTransaction(new Transaction.Handler() {
        @Override
        public Transaction.Result doTransaction(MutableData mutableData) {
            Post p = mutableData.getValue(Post.class);
            if (p == null) {
                return Transaction.success(mutableData);
            }

            if (p.stars.containsKey(getUid())) {
                // Unstar the post and remove self from stars
                p.starCount = p.starCount - 1;
                p.stars.remove(getUid());
            } else {
                // Star the post and add self to stars
                p.starCount = p.starCount + 1;
                p.stars.put(getUid(), true);
            }

            // Set value and report transaction success
            mutableData.setValue(p);
            return Transaction.success(mutableData);
        }

        @Override
        public void onComplete(DatabaseError databaseError, boolean b,
                               DataSnapshot dataSnapshot) {
            // Transaction completed
            Log.d(TAG, "postTransaction:onComplete:" + databaseError);
        }
    });
}

トランザクションを使用することで、複数のユーザーが同じ投稿にスターを同時に付けた場合や、クライアントのデータが古くなった場合でも、スターの数が不正確になることを防ぎます。トランザクションが拒否された場合、サーバーは現在の値をクライアントに返します。クライアントは更新された値でトランザクションを再度実行します。この処理は、トランザクションが受け入れられるか、試行が上限の回数に達するまで繰り返されます。

オフラインでのデータの書き込み

クライアントでネットワーク接続が切断された場合でも、アプリは引き続き適切に機能します。

Firebase データベースに接続しているクライアントはそれぞれ、アクティブ データの内部バージョンを独自に保持しています。データが書き込まれると、まず、このローカル バージョンに書き込まれます。次に Firebase クライアントは、「ベスト エフォート」ベースでそのデータをリモート データベース サーバーや他のクライアントと同期します。

その結果、データベースへの書き込みはすべて、直ちにローカル イベントをトリガーします（これは、サーバーにデータが書き込まれる前の段階です）。つまり、ネットワークのレイテンシや接続に関係なく、アプリは応答性の高い状態を維持します。

接続が再確立されると、アプリは適切な一連のイベントを受信して、クライアントが現在のサーバー状態と同期するようにします。この処理のためにカスタムコードを記述する必要はありません。

次のステップ

• Realtime Database からデータを取得する
• データを構造化する方法を学ぶ