【Swift】Realm + RxSwift でデータの更新を通知する

今回は RxSwift で Realm のデータ(Object) の更新を通知する方法を簡単に紹介します👷‍♀️

それではやっていく

データの変更を通知するための Observable を返すメソッドは下記のようになります。Realm Object のインスタンスメソッド observe でデータの変更を受信できるようになります。またここで取得したデータは、Observable が破棄されたタイミングで監視をやめる必要があるので、Disposables.create のブロック内で token.invalidate() を呼び出します。

    func observeProfile() -> Observable<RealmAccount> {
        let account = getAccount() // RealmからRealmAccount データを取得する
        return Observable<RealmAccount>.create {observer -> Disposable in
            let token = account.observe { result in
                if case .change(let object, _) = result, let newAccount = object as? RealmAccount {
                    observer.onNext(newAccount)
                    observer.onCompleted()
                }
            }
            return Disposables.create {
                token.invalidate()
            }
        }
    }

今回は observe の引数 result が .change だった場合にイベントを通知するようにしていますが、この他にも delete、error などのタイプがあります。また、コメントの通り error が呼ばれた後は再度コールバックが呼ばれないので、注意が必要です。現在は、バックグランドで Realm を開いた場合にもに error になるそうです。

public enum ObjectChange<T> where T : RealmSwift.Object {

    /**
     If an error occurs, notification blocks are called one time with a `.error`
     result and an `NSError` containing details about the error. Currently the
     only errors which can occur are when opening the Realm on a background
     worker thread to calculate the change set. The callback will never be
     called again after `.error` is delivered.
     */
    case error(_: NSError)

    /**
     One or more of the properties of the object have been changed.
     */
    case change(T, [RealmSwift.PropertyChange])

    /// The object has been deleted from the Realm.
    case deleted
}