Firebase Realtime DBを実践投入するにあたって考えたこと

# Firebase Realtime DBを実践に投入する

Databaseと聞くと、これから利用しようとする**[Firebase](https://firebase.google.com/)**がmBaaSであることを忘れてついREST(Client Server Model)で考えてしまいがちですが、大前提はMobile Platformなので、一度REST、RDBの考え方は捨ててみてください。

RDBの考え方を引き継いだままでは、Firebase Realtime DBの最善の設計はできないと考えています。
そして、RDBの考え方を引き継いだままFirebase Realtime DBを理解しようとすることが、導入の一つの障壁となっていると思っています。
ぜひ頭をリフレッシュしてFirebase Realtime DBの見方を変えてみてください。
この記事では、Firebase Realtime DBの導入するにあたっての考え方やテクニックを紹介します。少しでも導入の参考になれば嬉しいです。

※ この記事は2016年に書かれた記事で、現在はFirestoreの利用を推奨しています。

- [Cloud Firestoreを実践投入するにあたって考えたこと](https://qiita.com/1amageek/items/d606dcee9fbcf21eeec6)

#### 参考リンク
- 
[Firebase Realtime Databaseとはなんなのか？](http://qiita.com/1amageek/items/b350ee5ef0c9b2406583)
- [既存のDBをFirebase Realtime DBへマイグレーション時に考えたこと](http://qiita.com/1amageek/items/684ad6733708337f8fd7)
- [Firebase Cloud Functionsを使ってFacebook AccountKitをFirebase Authと連携する](http://qiita.com/1amageek/items/c7adbd9f2bbf3a57d352)


### 🔖 RDBとFirebase Realtime DBの考え方の違い
#### 構造の違い
まず、RDBとFirebase Realtime DBではどのくらいデータ構造に差があるのかを明確にしましょう。
`Group`と`User`の簡単なDBを考えます。複数の`Group`と`User`があり`User`は複数の`Group`に所属することが可能です。
ここで考えるDBの状態は以下の通りです。

[DBの状態]
<img width="622" alt="スクリーンショット 2016-10-26 12.29.53.png" src="https://qiita-image-store.s3.amazonaws.com/0/80287/1b8ac84e-0095-7e2c-7c4d-fbe38f9b1b48.png">
`groupA`に`userA`,`userB`が参加
`groupB`に`userC`,`userD`が参加

##### ■ RDB
まず、RDBの場合は以下のようになります。見慣れた構造だと思いますので特に説明はしません。

###### Group table
| group_id | name |
| --- | --- |
| 0 | groupA |
| 1 | groupB |

###### User table
| user_id | name | group_id |
| --- | --- | --- |
| 0 | userA | 0 |
| 1 | userB | 0 |
| 2 | userC | 1 |
| 3 | userD | 1 |

##### ■ Firebase Realtime DB
Firebase Realtime DBでRDBの構造を単純に表現すると下のようになります。
※`{key: true}`のような構造が出てきますが、ここでは一旦Firebase Realtime DBのリレーションはこうすると理解して読み進めてください。
<img width="227" alt="スクリーンショット 2016-10-19 12.23.52.png" src="https://qiita-image-store.s3.amazonaws.com/0/80287/e9597f87-e550-790d-480e-1d68e15a79b7.png">

ここで性能について考えます。次の条件を考えてみましょう。

- 'Group'に所属する'User'を取得したい場合
- 'User'が所属する'Group'を取得したい場合

RDBの場合は、User tableを操作すれば`User` `Group`いずれもすぐに取得できそうです。
Firebase Realtime DBの場合、そう簡単にはいきません。
なぜならFirebase Realtime DBはネストした構造に**連続**でアクセスすることが苦手だからです。

`Group`に所属する`User`を抽出したい場合を考えてください。
上の構造では、`User`は`Group`の情報を保持していますが、`Group`は`name`以外を保持していません。
つまり、この構造では`User`の持つ`groups`プロパティ以下、全てにアクセスしない限りある`Group`に所属する`User`を取得することができません。


この性能劣化の問題を解決するために、この下のような構造にします。
![スクリーンショット 2016-10-24 15.27.59.png](https://qiita-image-store.s3.amazonaws.com/0/80287/0049af8d-3ed4-7d8e-3db6-c8a7e3c1a3d9.png)

このように各モデルが相互で参照を持つ構造は、Firebase Realtime DBでのModel設計の定石です。
RDBの正規化の考え方からすると非常に冗長に見えるかもしれませんが、Firebaseでは、この割り切った考え方こそが重要になってきます。

Firebase Realtime DBではリレーションをする場合、`{key: true}`の形にします。ここで出てくる`true`の意味に関しては私も完全に理解できていません。ソート順では利用されるようですが、`false`にする機会に出会ったことがないので慣例的に`true`としています。`key`に関しては、この記事を読み進めるにあたって理解が深まると思います。`key`はFirebaseにおいて非常に大きな意味を持っています。

Firebaseのリレーションに関しては以下を参照してください。
- [データベースの構造化](https://firebase.google.com/docs/database/ios/structure-data)
- [Best Practices: Arrays in Firebase](https://firebase.googleblog.com/2014/04/best-practices-arrays-in-firebase.html)
- [データが並べ替えられる仕組み](https://firebase.google.com/docs/database/ios/retrieve-data)

#### Queryの違い
次に、RDBとFirebase Realtime DBのデータの取得について考えます。
`groupA`に所属する`User`の`name`を抽出したい場合を考えてください。

##### ■ RDB
RDBの場合では、次のQueryになります。一般的なので特に説明しません。

```
select name from user where group_id = 0
```
###### 結果
| name |
| --- |
| userA |
| userB |


##### ■ Firebase Realtime DB(iOS)
Firebase Realtime DBでは次のようになります。

```
// FirebaseのDBの参照を定義（root）
let ref: FIRDatabaseReference = FIRDatabase.database().reference()　

// rootからgroupAの下にあるusersを取得する
ref.child("group").child("0").child("users").observeSingleEvent(of: .value, with: { (snapshot) in

    // 複数のユーザーのkeyが取得できる
    // ユーザーのkeyから順次ユーザーを取得する
    for (_, child) in snapshot.children.enumerated() {

        // ユーザーのkey
        let key: String = (child as AnyObject).key

　　　　　// ユーザーのキーからユーザーの情報を取得する
        ref.child("user").child(key).observeSingleEvent(of: .value, with: { (snapshot) in
            print(snapshot.value["name"])
        })
    }
})
// 結果
// userA
// userB
```

RDBから比べると、回りくどく非効率に見えるかもしれませんが、Mobile Appでは非常に効率的な手段です。
なぜこれがMobile Appにおいて効率的なのかは後の章で説明します。

- [NoSQL（Not Only SQL）データベースとは] (https://academy.datastax.com/what-is-nosql-jp)
- [CAP定理を見直す。“CAPの3つから2つを選ぶ”という説明はミスリーディングだった](http://www.publickey1.jp/blog/13/capcap32.html)
- [Cloudの技術的特徴について](http://qcontokyo.com/tokyo-2009/pdf/GeneralSession-Day2-Maruyama.pdf)

### 🔖 Mobile Appの性質
Firebaseを効率よく利用するためには、**Mobile App**の性質を考慮する必要があります。数年前までは**Web App**の開発が勢力的行われていましたがユーザーのニーズは明らかに**Mobile App**になりました。
**Mobile App**は**Web App**では要求事項が異なるため**Web App**の仕様をそのまま引きずって開発するのは得策ではありません。
※ この記事でいう**Web App**とはデスクトップで操作するウェブアプリケーションのことを指しています。またMobile AppとはiOSやAndroidのネイティヴアプリケーションを指しています。

#### Mobile Appで考慮すべきこと
1. ネットワークは不安定
1. リソースに制限がある
1. 表示領域に制限がある
1. 開発サイクルが速い（エンジニアに開発速度を要求される）

##### ■ ネットワークは不安定
Mobile Appは、オフラインになることを想定して設計されなければなりません。

##### ■ リソースに制限がある
2016年10月時点でiPhone7 plusが3GBのメモリを搭載していますが、複数のAppを同時に立ち上げるの当然となった現在では、少し重さが緩和されるだけであって十分ではありません。
Mobile Appでは、メモリやストレージが制限されていることを想定して設計されなければなりません。

##### ■ 表示領域に制限がある
見た目としてMobile AppとWeb Appに大きな差が出るのは、表示領域です。例えば、動線やコンテンツが多数盛り込まれた楽天のようなのページをMobileで再現するとなると、混沌としたAppになることは容易に想像がつきます。
Mobile Appでは、多くの情報を整理して効率的にユーザーに伝えることを想定して設計されなければなりません。

##### ■ 開発サイクルが速い
iOS SDK, Android NDKは毎年更新され、さらに顧客のニーズも常に変化していくため、開発速度を早めることは、最善のUXをユーザーへ提供するのであれば必須です。
Mobile Appでは、要件が変化することを想定して設計されなければなりません。


### 🔖 Firebase realtime DBの特徴

Mobile Appの性質と照らし合わせるため、Firebase realtime DBの特徴を説明します。

- Realtime・AutoSync
- Offline
- Schemaless
- Multi platform

##### ■ Realtime・AutoSync
Firebaseはデータの変化があると、それをリアルタイムに他のデバイスに同期します。また、この同期はリアルタイムに行われます。これは開発者が、データベースを監視するコードを数行書くだけで、**REST**で実装していた`GET` `POST`の処理を一切不要にすることを意味します。

##### ■ Offline
Firebaseは、Mobileがオフラインでも利用可能です。Firebaseには、オフラインからオンラインになった時に、データの差分を同期する仕組みがあります。これは、ほとんどの通信でネットワークエラーのハンドリングを考慮しなくていいことを意味します。※トランザクションが必要な部分には必要です。

##### ■ Schemaless
すべての Firebase Realtime DB データは JSON オブジェクトとして保存されます。
これは、DBの仕様を柔軟に変更できることを意味します。

##### ■ Multi platform
Firebaseは、`Objective-C` `Java` `Javascript`の複数の言語でSDKが提供されています。


### 🔖 FirebaseをMobile Appのソリューションにする
Firebaseを使うことで、Mobile Appが抱える課題を緩和することが可能です。


| 性質 | ソリューション |
| --- | --- |
| ネットワークは不安定 | Realtime・AutoSync<br>Offline |
| リソースに制限がある | Realtime・AutoSync |
| 表示領域に制限がある | Realtime・AutoSync |
| 開発速度が速い | Realtime・AutoSync<br>Schemaless |

#### 🤔 ネットワークは不安定
オフラインでも動作するFirebaseは、ネットワークが不安定であるMobile Appにとって大きな意味を持ちます。
REST APIでもネットワークが復旧した際に、`GET`をすることは簡単ですが、`POST`をキューイングして不整合なく処理しようとするならば、そのための実装は大きなものになるはずです。

#### 🤔 リソース・表示領域に制限がある
Mobile Appにおいて、リソースを最小限に止めるためには、表示領域に表示する以外のデータは保持しないことです。
Twitterを例にすると、現在のTwitterクライアントでは、iPhone6の表示領域に約3~4ツイートしか表示しません。

<img width="375" alt="IMG_5038.PNG" src="https://qiita-image-store.s3.amazonaws.com/0/80287/f46ad5c3-5670-3da7-8820-312cd9b853e8.png">

リソースを最小限にするならばこの数ツイート以外は保持するべきではありません。しかし、これは現在のMobile Appの開発では誤った考え方です。その理由は、ユーザー体験を阻害するからです。保持するデータが極端に少ない場合、次のツイートの取得するたびに、ユーザーを待たせることになります。
通常Mobile Appでは、表示領域以外のデータを保持しています。保持するデータの数はサービスの性質に依存しますが、起動時に、数十個保持することがほとんどです。
では、Google Photoのように大量のデータを持つ場合はどうでしょうか、当然全てのデータをクライアントに持たせることは最適解ではありません。必要な情報のみを保持し、表示領域に入る前にデータをフェッチすることが現状では最適です。

![スクリーンショット 2016-10-25 17.46.33.png](https://qiita-image-store.s3.amazonaws.com/0/80287/18bd42db-58c8-eada-6343-255c3d2dddbb.png)

Firebaseのデータ参照方法を思い出してください。Firebaseはkeyから連続でデータを読み込むことを推奨しています。

```
// FirebaseのDBの参照を定義（root）
let ref: FIRDatabaseReference = FIRDatabase.database().reference()　

// rootからgroupAの下にあるusersを取得する
ref.child("group").child("0").child("users").observeSingleEvent(of: .value, with: { (snapshot) in

    // 複数のユーザーのkeyが取得できる
    // ユーザーのkeyから順次ユーザーを取得する
    for (_, child) in snapshot.children.enumerated() {

        // ユーザーのkey
        let key: String = (child as AnyObject).key

　　　　　　　　　　　　　　　　// ユーザーのキーからユーザーの情報を取得する
        ref.child("user").child(key).observeSingleEvent(of: .value, with: { (snapshot) in
            print(snapshot.value["name"])
        })
    }
})
```

RDBやRESTを使った場合では、通信のオーバーヘッドや、DBの制約からこの方法を使用することが最適ではないことは、容易に想像できるかと思います。
またFirebase Realtime DBには、クエリで取得するデータを制限できるようになっています。クエリで取得するデータを制限方法に関してはこちらをご参照ください。

- [Firebase Realtime DBでページング](https://github.com/1amageek/Salada/blob/master/Salada/Salada.swift#L930)


#### 🤔 開発速度が速い

ここでは、導入フェイズ・開発フェイズ・運用フェイズに分けてFirebaseの実開発について説明します。
いずれの場面でもSeverlessで開発を進めることができるため、開発は非常にスピーディになります。

##### ■ 導入フェイズ
Firebaseの導入コストは、ほとんどかかりません、初期の調査や、試験的な運用に必要な部分は十分に無料枠でまかなえます。
また、既存システムからの移行に関しても十分なソリューションが準備されています。
既存システムをすでに運用している場合、まず最初に困るのは、ユーザー情報の移行です。Firebaseでは、[カスタム認証システム](https://firebase.google.com/docs/auth/web/custom-auth)と呼ばれる仕組みを持っており、既存システムに大きな変更を加えることなくFirebaseを利用することができるようになっています。

##### ■ 開発フェイズ
開発フェイズで一番困ったのは、上で述べているように**REST** **RDB**を用いたシステムの頭から考えを方切り替えることでした。また後に記述しますが、Firebaseでデータスキーマを考えることは、RDBの正規化を考えるのとはアプローチが違うので、そこにも悩まされましたが、制約を設けて設計することで、RDBよりも設計はスムーズに進みます。
Firebaseには、[コンソール](https://console.firebase.google.com/)が準備されています。コンソールを使っての開発はデバッグ時に非常に役に立ちます。サンプルデータの準備を手動でも即入力でき、リアルタイムに結果を確認できることは、開発において非常に有利だと考えています。

##### ■ 運用フェイズ
運用では、現2016年10月時点で[Firebaseが不安定](https://status.firebase.google.com/)であることを考慮し、Firebaseが停止した場合、バックアップシステムに切り替えができるようにしています。
運用においては、Realtime DBよりも、**Analytics**, **Remote config**, **Notifications**の機能が強力で開発者を幸せにしています。
**Analytics**, **Remote config**, **Notifications**の連携の記事は別途ご紹介します。

# Firebase Realtime DB Best Practice（beta）

## Killswitch
Firebaseは開発者が意図的に停止することはできません。
Firebaseの運用を考えるのならばFirebaseへの[Killswitch](https://en.wikipedia.org/wiki/Kill_switch)(アクセスを制御できる機能)をクライアントにを準備するべきです。
停止だけでなくメンテナンスにおいても同じ問題は発生します。

## Model
Firebase Realtime DBはスキーマレスです。スキーマがないことは開発の幅を広げますが、バグをうみやすくします。いずれのDBにおいても、概念を抽象化し設計を行うべきです。その意味で**Model**は重要な役割を持つと考えています。そこで、Firebase Realtime DBに適したModel設計を考案しました。以下の制約を設けることでスムーズに設計が進むと思います。
この制約をよりブラッシュアップさせたいので、たくさんの方の意見を頂ければ幸いです。

### Model設計の制約

- Modelは並列に構成する
- Model名は単数形の名詞にする
- ModelのKeyはSortできるキーをセットする
- Modelは`_updatedAt` `_createdAt`を保持する
- Model内に配列を保持しない
- Model内のプロパティに`AccessKey`を含める



![スクリーンショット 2016-10-25 19.16.03.png](https://qiita-image-store.s3.amazonaws.com/0/80287/e2db7f7f-39bc-6b77-69fc-1c7036f75878.png)
*モデルの略図*

#### ■ Modelは並列に構成する
設計を簡略化して考えるため、隠れたModelを作るべきではありません。
Modelをネストして作ることもFirebase Realtime DBであれば可能ですが、大きなメリットを持ちません。

**モデルの中にモデルがある構成の例**
簡単な例としてチャットアプリをあげます。このチャットアプリでは`User` `Room` `Message`のModelが存在するとします。

**推奨しません**

```
room: {
  roomID1: {
    messages: {
      messageID1: {
        text: "hello!",
        _createdAt: 123456780,
        _updatedAt: 123456780,
      },
  　　messageID2: {
        text: "hi!!",
        _createdAt: 123456780,
        _updatedAt: 123456780,
      }
    }
  },
  roomID2: {

  }
}
```

**推奨**

```
room: {
  roomID1: {
    messages: {
      messageID1: true,
      messageID2: true 
    }
  },
  roomID2: {

  }
},
message: {
  messageID1: {
    text: "hello!",
    _createdAt: 123456780,
    _updatedAt: 123456780,
  },
  messageID2: {
    text: "hi!!",
    _createdAt: 123456780,
    _updatedAt: 123456780,
  }
}
```

Modelをネストしなければ実現できないこともあります。

- データを`key`でなく`value`でソートする場合
- `value`に[データのインデックス作成](https://firebase.google.com/docs/database/security/indexing-data)する場合

例えば、シューティングゲームの`Score`を`User`ごとに管理したい場合は以下のように設計すべきです。
以下のようにすることで、スコア順にデータをソートすることができます。

```
user: {
  userID1: {
    histories: {
      historyID1: {
        score: 112,
        _createdAt: 123456780,
        _updatedAt: 123456780,
      },
      historyID2: {
        score: 312,
        _createdAt: 123456780,
        _updatedAt: 123456780,
      }
    }
  },
  userID2: {

  }
}
```

ただし、Firebase Realtime DBにはRDBのように複合的なクエリを実行できる仕様ではないため、もし既存のシステムがクエリを実行することによって成り立っているのであれば、根本的にFirebaseの導入を見直した方がいいでしょう。

#### ■ Model名は単数形の名詞にする
FirebaseではModelをクライアント・サーバーで分け隔てなく、統一管理をすることが望ましいため統一しましょう。
<img width="362" alt="スクリーンショット 2016-10-26 14.38.12.png" src="https://qiita-image-store.s3.amazonaws.com/0/80287/009284a1-ece9-37f1-c3d3-eac9acb5b49b.png">


#### ■ ModelのKeyはSortできるキーをセットする
Firebaseの性能は**Key**で決まります。**Key**はデータのユニークを担保しているだけではありません。時系列を含み作成された順番を保っています。任意で**Key**をセットする場合は辞書順になることを意識することをお勧めします。

- [データが並べ替えられる仕組み (Firebaseドキュメント)](https://firebase.google.com/docs/database/ios/retrieve-data)
- [Lexicographical order: 辞書式順序 ](https://en.wikipedia.org/wiki/Lexicographical_order)


#### ■ Modelは`_updatedAt` `_createdAt`を保持する
「いつ発生した」は、あらゆる問題を解決するための重要ないとぐちです。
時系列で問題を追えるようにしておくことをお勧めします。

#### ■ Model内に配列を保持しない
前述しましたが、Firebaseの性能は**Key**で決まります。データを配列で管理することにメリットはありません。
有名なブログ記事があるので是非ご覧ください。

- [Best Practices: Arrays in Firebase](https://firebase.googleblog.com/2014/04/best-practices-arrays-in-firebase.html)

#### ■ Model内のプロパティに`AccessKey`を含める
Firebaseにはデータアクセス制御をする[Rule](https://firebase.google.com/docs/database/security/)と呼ばれるセキュリティが存在します。Modelが誰からアクセスを許可するのかを明示することは、データのセキュリティを向上させます。
双方向なリレーションを行うことが推奨されているため、意識しなくても`AccessKey`を付与していることがほとんどですが、誰からアクセスされるべきデータなのか意識して設計することをお勧めします。

```
{
  user: {
    userID0: {
      activities: {
        activityID0: true,
        activityID1: true
      }
    }
  }, 
  activity: {
    activityID0: {
      userID: userID0  // activityID0にアクセスするためのAccessKey
      content: "hello",
      _createdAt: 012345678,
      _updatedAt: 012345678,
    }
  }
}

```


##### Rule

```
{
    "rules": {
        "user": {
            "$user_id": {
                ".read": "auth != null && auth.uid == $user_id", // 認証後、ログインユーザーと一致している場合データを読むことができる
                ".write": "auth != null && auth.uid == $user_id" // 認証後、ログインユーザーと一致している場合データを書き込むことができる
            }
        },
        "activity": {
            "$activity_id": {
                ".read": "root.child('user/'+ auth.uid +'/activities/'+$activity_id).exists()" // Userのactivitiesの中に$activity_idを保持していればデータを読むことができる
                ".read": "data.child('user_id').val() == auth.uid" // このデータのuser_idがログインユーザーのIDと一致していればデータを読むことができる。
            }
        }
    }
}

```

Firebaseにおいての上記の設計思想からModelを管理できるLibraryを作りました。
https://github.com/1amageek/Salada RealtimeDatabase用
https://github.com/1amageek/Pring　 CloudFirestore用

Firebaseについてさらに詳しく知りたい方は次をご覧ください。

- [Firebase Realtime Databaseとはなんなのか？](https://qiita.com/1amageek/items/b350ee5ef0c9b2406583)
- [Firebaseでアプリを開発するならClient Side Joinを前提にすること](https://qiita.com/1amageek/items/afc1c0ceb15ffc2372fd)