Realm + SwiftUI

Realm は SwiftUI を公式サポートしていないのでいろいろ対応が必要になりますが、その一つがデータ更新時にビューの再レンダリングに対応していないことが挙げられます。

また、データ削除でクラッシュするRealm でレコードを削除するとクラッシュする問題もあるので、こちらにも目を通しておいて下さい。

再レンダリングの方法

以下は再レンダリングを実行するためのテンプレートである。頻繁に使うので覚えておいたほうが良い。

1
import Combine
2
import SwiftUI
3
import RealmSwift
4

5
let realm = try! Realm()
6

7
class RealmCoopResult: Object {
8
    let goldenEggs = RealmOptional<Int>()
9
    let powerEggs = RealmOptional<Int>()
10

11
    init(goldenEggs: Int?, powerEggs: Int?) {
12
        self.goldenEggs.value = goldenEggs
13
        self.powerEggs.value = powerEggs
14
    }
15
}
16

17
class Tkgstrator: ObservableObject {
18
    private var token: NotificationToken?
19

20
    // 最初の一回しか呼ばれない
21
    let results: RealmSwift.Results<RealmCoopResult> = realm.objects(RealmCoopResult.self)
22

23
    init() {
24
        // 最初の一回しか呼ばれない
25
        token = results.observe { [self] _ in
26
            // データ変更が起こったときに実行される
27
            objectWillChange.send()
28
        }
29
    }
30
}

このコードの場合objectWillChange.send()で強制再レンダリングがかかるので変数は@Published属性を付けなくても良いことに注意。

::: warning Realm インスタンスの呼び出し方

今回のテンプレートではlet realm = try! Realm()で呼び出しているが、この書き方だとマイグレーションが必要なときなどに必ずクラッシュしてしまう。

より柔軟な書き方については別の記事で解説予定。

:::

あと、データの反映を全てのビューで受け取れるように@EnvironmentObjectを設定する必要がある。

1
@main
2
struct RealmRelationApp: App {
3

4
    var body: some Scene {
5
        WindowGroup {
6
            ContentView()
7
                .environmentObject(Tkgstrator()) // 追加
8
        }
9
    }
10
}

このようにルートビューに@EnviromentObjectを読み込むように設定する。これで、全てのビューでTkgstratorクラスのデータにアクセスできる。

1
import SwiftUI
2

3
struct ContentView: View {
4
    @EnvironmentObject var data: Tkgstrator // EnvironmentObjectを利用することを明記
5

6
    var body: some View {
7
        NavigationView {
8
            Form {
9
                NavigationLink(destination: resultLists, label: { Text("RESULTS") })
10
                NavigationLink(destination: settingMenu, label: { Text("SETTING") })
11
            }
12
        }
13
    }
14

15
    var resultLists: some View {
16
        Form {
17
            Button(action: { addData(num: 5) }, label: { Text("ADD DATA") })
18
            ForEach(data.results, id:\.self) { result in
19
                HStack {
20
                    Text("\(result.goldenEggs.value ?? 0)")
21
                    Spacer()
22
                    Text("\(result.powerEggs.value ?? 0)")
23
                }
24
            }
25
        }
26
    }
27

28
    var settingMenu: some View {
29
        Form {
30
            HStack {
31
                Text("RESULTS NUM")
32
                Spacer()
33
                Text("\(data.results.count)")
34
            }
35
            Button(action: { addData(num: 5) }, label: { Text("ADD DATA") })
36
            Button(action: { deleteAll() }, label: { Text("DELETE ALL") })
37
        }
38
    }
39

40
    private func addData(num: Int = 100) {
41
        autoreleasepool {
42
            realm.beginWrite()
43
            for _ in 0 ..< num {
44
                realm.create(RealmCoopResult.self, value: RealmCoopResult(goldenEggs: Int.random(in: 69 ..< 200), powerEggs: Int.random(in: 3000 ..< 5000)))
45
            }
46
            try? realm.commitWrite()
47
        }
48
    }
49

50
    private func deleteAll() {
51
        autoreleasepool {
52
            realm.beginWrite()
53
            realm.deleteAll()
54
            try? realm.commitWrite()
55
        }
56
    }
57
}

OBservableObject の書き方

さて、ここまででRealmSwift.Resultsを常に最新のものをとってくることができた。

::: tip 初期化は一回しか行われていないが…

resultsへの代入は一回しか行われていないので値が更新されないように思うかもしれないが、realmのインスタンスの内部状態は常に最新のものに更新されるので（計算プロパティのようなものと思えば良い）、resultsのプロパティを参照すれば常に最新のデータが取得できる。

:::

データベースを運用していく上では単に全てのリザルトだけでなくさまざまなデータを計算してその結果を返してほしいのだが、それをどうやってコーディングすればいいかを考える。

例えば、それぞれの平均を求めたいとしよう。Realm には平均を返すaverage(ofProperty: String)というものがあるのでこれを利用する。

1
// 正しく動かないコード
2
class Tkgstrator: ObservableObject {
3
    private var token: NotificationToken?
4

5
    let results: RealmSwift.Results<RealmCoopResult> = realm.objects(RealmCoopResult.self)
6
    let avgGoldenEggs: Double?
7
    let avgPowerEggs: Double?
8

9
    init() {
10
        avgGoldenEggs = results.average(ofProperty: "goldenEggs") // この時点で値が決まっている
11
        avgPowerEggs = results.average(ofProperty: "powerEggs") // この時点で値が決まっている
12

13
        token = results.observe { [self] _ in
14
            objectWillChange.send()
15
        }
16
    }
17
}

一見すると上のコードで動作しそうな気がするが、これは正しく動かない。というのも、avgGoldenEggsというのはDouble?型の変数であり、realmのインスタンスの内部状態に依存しないためだ。つまり、イニシャライザでプロパティに代入した瞬間に値が決まってしまい、objectWillChange.send()が呼ばれてもデータが更新されない。

1
// 正しく動かないコード
2
class Tkgstrator: ObservableObject {
3
    private var token: NotificationToken?
4

5
    let results: RealmSwift.Results<RealmCoopResult> = realm.objects(RealmCoopResult.self)
6
    @Published var avgGoldenEggs: Double?
7
    @Published var avgPowerEggs: Double?
8

9
    init() {
10
        avgGoldenEggs = results.average(ofProperty: "goldenEggs") // この時点で値が決まっている
11
        avgPowerEggs = results.average(ofProperty: "powerEggs") // この時点で値が決まっている
12

13
        token = results.observe { [self] _ in
14
            objectWillChange.send()
15
        }
16
    }
17
}

それは@Publishedをつけても同様のことがいえる。そもそも、@Published自体が「そのプロパティのデータが更新されたときにビューを再レンダリングする」という効果しか持たないので、objectWillChange.send()を使うのであれば不要である。

これも、何回実行しても最初のイニシャライザで設定した値から変わらないのでやはり再レンダリングはできない。

読み込み時に計算するコード

1
// 正しく動作するコード
2
class Tkgstrator: ObservableObject {
3
    private var token: NotificationToken?
4

5
    let results: RealmSwift.Results<RealmCoopResult> = realm.objects(RealmCoopResult.self)
6
    var avgGoldenEggs: Double? {
7
        results.average(ofProperty: "goldenEggs")
8
    }
9
    var avgPowerEggs: Double? {
10
        results.average(ofProperty: "powerEggs")
11
    }
12

13
    init() {
14
        token = results.observe { [self] _ in
15
            objectWillChange.send()
16
        }
17
    }
18
}

そのためには、例えば変数を計算プロパティにするという方法が考えられる。これはresultsは常に最新のデータを取得するので呼び出すごとに結果が変わり、そのためデータを追加すれば正しくビューの再レンダリングがかかり平均のデータも更新される。

データを毎回代入するコード

1
// 正しく動くコード
2
class Tkgstrator: ObservableObject {
3
    private var token: NotificationToken?
4

5
    let results: RealmSwift.Results<RealmCoopResult> = realm.objects(RealmCoopResult.self)
6
    var avgGoldenEggs: Double?
7
    var avgPowerEggs: Double?
8

9
    init() {
10
        token = results.observe { [self] _ in
11
            avgGoldenEggs = results.average(ofProperty: "goldenEggs")
12
            avgPowerEggs = results.average(ofProperty: "powerEggs")
13
            objectWillChange.send()
14
        }
15
    }
16
}

このようにデータベース更新時に毎回代入し直すようなコードでも正しく動作する。

データを毎回代入するコード

objectWillChange.send()を使わず、@Publishedを利用する方法でも良い。

が、何度も@Publishedを書くことになるので、個人的には一回だけobjectWillChange.send()を使うほうが楽そうな気はする。

1
// 正しく動くコード
2
class Tkgstrator: ObservableObject {
3
    private var token: NotificationToken?
4

5
    @Published var results: RealmSwift.Results<RealmCoopResult> = realm.objects(RealmCoopResult.self)
6
    @Published var avgGoldenEggs: Double?
7
    @Published var avgPowerEggs: Double?
8

9
    init() {
10
        token = results.observe { [self] _ in
11
            avgGoldenEggs = results.average(ofProperty: "goldenEggs")
12
            avgPowerEggs = results.average(ofProperty: "powerEggs")
13
        }
14
    }
15
}

現時点でオススメのコード

計算内容が重い場合

1
class Tkgstrator: ObservableObject {
2
    private var token: NotificationToken?
3

4
    let results: RealmSwift.Results<RealmCoopResult> = realm.objects(RealmCoopResult.self)
5
    var avgGoldenEggs: Double?
6
    var avgPowerEggs: Double?
7

8
    init() {
9

10
        token = results.observe { [self] _ in
11
            avgGoldenEggs = results.average(ofProperty: "goldenEggs")
12
            avgPowerEggs = results.average(ofProperty: "powerEggs")
13
            objectWillChange.send()
14
        }
15
    }
16
}

このコードの注意すべき点はデータベースに何らかの変更があったときに、毎回クロージャ内の計算が実行されてしまうということである。

つまり、100 件のデータ書き込みを 1 件ずつ行っていると毎回計算処理が発生して非常にパフォーマンスがよろしくない。

1
realm.beginWrite()
2
for result in results {
3
    // データ書き込み（実際には書き込まれていない）
4
}
5
try? realm.commitWrite() // ここで全件書き込み

のように 100 件同時書き込みをするようにコーディングすること。こうすれば 100 件データが追加されたあとでしか計算処理が発生しない。

計算内容が軽い場合

1
// 正しく動作するコード
2
class Tkgstrator: ObservableObject {
3
    private var token: NotificationToken?
4

5
    let results: RealmSwift.Results<RealmCoopResult> = realm.objects(RealmCoopResult.self)
6
    var avgGoldenEggs: Double? {
7
        results.average(ofProperty: "goldenEggs")
8
    }
9
    var avgPowerEggs: Double? {
10
        results.average(ofProperty: "powerEggs")
11
    }
12

13
    init() {
14
        // メモリリークを防ぐために弱参照を用いる
15
        token = results.observe { [weak self] _ in
16
            self?.objectWillChange.send()
17
        }
18
    }
19
}

現時点ではこのコードが一番オススメかなあという気がしている。なんといっても、イニシャライザが非常に簡単にかけることが大きい。

スパゲッティコードになることを防ぎやすく、わかりやすさでは一番の気がしている。

::: warning 注意点

ただし、どちらの場合もイニシャライザやクロージャ内や計算プロパティ内に重い処理を書いているとアプリがフリーズしたような状態になってしまうので、それを防ぐためにはDispatchQueueを使ってメインスレッド以外で実行する必要が出てくる。

このとき、全部の計算プロパティをいちいち別スレッドで実行するのもめんどくさいので、重い処理が多いときは前者の書き方のほうが良いかもしれない。

:::

というわけで、SwiftUI と Realm の組み合わせの仕方について学びました。

これを使ってアプリ開発を勧めていきたいと思いました、まる。

記事は以上。