Realm

概要

保存できる型
- Bool, Int, Int8, Int16, Int32, Int64, Double, Float, String, Date, Data.
CGFloatで保存することは推奨されない（できなくはないが型がRealmで保証されていない）
String, Date, Data は Optional指定が可能。
その他の保存できる型で Optional指定をしたい場合は、RealmOptionalを利用する。RealmOptionalは「Int, Float, Double, Bool」に対応。
RealmOptionalプロパティは必ずletでなければいけない。

RealmDatabaseの作成（CREATE DATABASE）

RealmDatabaseの削除（DROP DATABASE）

モデルの定義（CREATE TABLE）

モデルの継承

モデルプロパティの属性

Realmモデルに定義されるプロパティは@obj dynamic var属性を持たなければならない。ただしSwift4以降で利用することのできる@objcMembers修飾子をクラスに宣言している場合、プロパティは単にdynamic var属性で宣言することができる。

ただし、LinkingObjects, List, RealmOptional属性は動的なプロパティとして宣言することができないので、常にletで宣言しなければならない。

Type	Non-optional	Optional
Bool	`@objc dynamic var value = false`	`let value = RealmOptional<Bool>()`
Int	`@objc dynamic var value = 0`	`let value = RealmOptional<Int>()`
Float	`@objc dynamic var value: Float = 0.0`	`let value = RealmOptional<Float>()`
Double	`@objc dynamic var value: Double = 0.0`	`let value = RealmOptional<Double>()`
String	`@objc dynamic var value = ""`	`@objc dynamic var value: String? = nil`
Data	`@objc dynamic var value = Data()`	`@objc dynamic var value: Data? = nil`
Date	`@objc dynamic var value = Date()`	`@objc dynamic var value: Date? = nil`
Object	`n/a`	`@objc dynamic var value: Class?`
List	`let value = List<Type>()`	`n/a`
LinkingObjects	`let value = LinkingObjects(fromType: Class.self, property: "property")`	`n/a`

プライマリキー

モデルを定義する時に primaryKeyメソッドをオーバーライドすることで、モデルの主キーを設定することができる。主キーを設定したオブジェクトをRealmに保存すると、後から変更することができない。

インデックス

Realmでは各モデルでプロパティのインデックスをindexedPropertiesメソッドをオーバーライドすることで作成できる。インデックスを作成することで、等号演算、IN演算しを用いたクエリを高速に実行することができる。（※ インデックスを作成するため Realmファイルのサイズは大きくなる）

RealmではString, Int, Bool, Date型プロパティのインデックスに対応している。

プロパティの無視

Realmに保存する必要のない変数（一時使用、一時的な変数）をignoredPropertiesメソッドをオーバーライドすることで設定できる。これを設定することでプロパティとして操作、利用することができるが、保存する際にデータは無視される。また、getterしか持たない変数は、自動的にモデル保存時に無視される。

モデルの書き込み

モデルを書き込むためには、モデルオブジェクトをインスタンス化してRealmに追加する必要がある。

オブジェクトのインスタンスを生成した後、直接プロパティに対して値を代入して作成する方法
オブジェクトをインスタンス化する際にDictionaryを用いて、初期化して作成する方法
オブジェクトをインスタンス化する際にArrayを用いて、初期化して作成する方法
（※ この場合、配列内要素の並びはモデルのプロパティ並びと同じでなければならない。またモデル保存時に無視されるプロパティやgetterのみのプロパティなどは無視する必要がある）

モデルオブジェクトを作成後、Realmに追加することができる。

Realmへの書き込みトランザクションが終了すると、他のスレッドでも追加した値を利用することができるようになる。このとき、複数の書き込みが同時進行で発生した場合は、他方の書き込みが終わるまでロックされる。これによって書き込みがロックされているスレッドもロックされることを注意する必要がある。

ただし、書き込みトランザクションが終了していない場合であっても、読み込みは可能である。

モデルの更新

モデル更新の方法は複数ある。

プライマリキーを設定している場合は、プライマリキーによる更新を行うことができる。

この時、主キー（id: 1）がすでに存在していれば単に更新処理が走る。主キーが存在しない場合は create と同等の処理が実行される。また、主キーと更新したい値のサブセットを引数にすることで差分更新を行うことができる。

ただし、主キーを定義していないモデルオブジェクトを更新する場合には update: の引数に .modified, .all を渡すことができない。また、.modified, .allを使った多重（コンフリクトが発生するような）書き込みの結果には注意が必要。

この場合、２つの更新が同時に発生するためコンフリクトが発生する。これらの書き込みがマージされた結果として得られる結果は、以下のどちらかとなる。

しかしupdate: .modifiedとした場合は、挙動が変わる。

この場合の書き込みがマージされた結果は以下のようになる

.all は完全置き換え、.modified は差分置き換えであることを注意する必要がある。

モデルの削除

書き込みトランザクションの中で以下を実行する。

モデルの変更通知

Realmのオブジェクトインスタンスは自動的に更新される。つまり、オブジェクトのプロパティを変更すると、同じオブジェクトを参照している他のインスタンスに、その変更が即座に反映される。Realmオブジェクトの更新通知を購読することで、対象のRealmオブジェクトに変更があった場合に通知を取得できる。

モデル間のリレーション

1:N, N:1

双方向リレーション
一般的にモデル同士のリレーションはリンクされてる側からインスタンスを参照することはできるが、逆方向からは辿ることができない。RealmではLinkingObjectsを用いることで、双方向リレーションを形成することができる。LinkingObjectsは特定のプロパティ（ここではPersonモデルのdogsプロパティ）から与えられたオブジェクトにリンクされているすべてのオブジェクトを取得することができる。

Appendix

JSONによるRecord作成

Realm は直接JSONをサポートしていないが、JSONSerialization の出力を用いでオブジェクトを生成することができる。JSON内にネストされてるオブジェクトや配列は、自動的にリレーションにマッピングされることに注意する必要がある。

この方法でオブジェクトを生成するときには、いくつかの注意点が存在する。

オブジェクトのプロパティ名とJSONのキー名が一致して、型が同じである必要があります。
floatプロパティは、floatをバックにしたNSNumbersで初期化する必要があります。
DateプロパティとDataプロパティは文字列から自動的に推論することはできませんが、Realm().create(_:value:update:)に渡す前に適切な型に変換しなければなりません。
必須プロパティに JSON NULL (すなわち NSNull) が与えられた場合、例外がスローされます。
insert 時に必須のプロパティが与えられない場合は、例外がスローされます。
Realmは、Objectで定義されていないJSON内のプロパティを無視します。

モデルオブジェクト更新時の設定

Realm では Realm に書き込まれたか否かで、更新方法が変わる場合がある。

アンマネージドオブジェクト

Realm に書き込まれる前のオブジェクト（ realm.write クロージャーの外でプロパティを変更できる）

マネージドオブジェクト

Realm に書き込まれた後のオブジェクト（realm.write クロージャーの外でプロパティを変更できない）

一般的には、このように分離して処理を変更するべきであるが、以下のようにすることもできる。

[cv:issue_marketplace_engineer]