RealmSwift

RealmSwift が10.10.0にアップデートされて大幅な変更が入っていました。

RealmSwift 10.10.0

新規機能

全てのプロパティが同一の方法で宣言できる
プライマリキーの設定が簡単になった
リストも簡単に宣言できる
RawRepresentableが@Persistedに対応している型であれば Enum も保存できる
Map.merge()が実装され、辞書形式ペアを他のMapやDictionaryに変換できるようになった
Map.asKeyValueSequence()が実装され、辞書形式の配列を返すようになった

バグ修正

より多くの Enum オブジェクトをサポート
RealmProperty<AnyRealmValue?>を宣言するとエラーを返す問題
KVOを経由してRLMDictionary/MapのInvalidatedの通知が正しく設定されない問題

使い方

全てのプロパティを@Persistedで宣言できるのはとても便利。もっと早くコレに対応すべきだったのでは。

旧コード

1
// Legacy
2
class User: Object {
3
    @objc dynamic var id: Int = 0       // Int
4
    let age = RealmOptional<Int>() = 0  // RealmOptional<Int>
5
    let age = RealmProperty<Int?>() = 0 // RealmProperty<Int?>
6

7
    // Primary Key
8
    override static func primaryKey() -> String? {
9
        return "id"
10
    }
11
}

新コード

1
// Modern
2
class User: Object {
3
    @Persisted var id: Int = 0      // Int
4
    @Persisted var age: Int? = 0    // Int?
5

6
    // Primary Key
7
    @Persisted(primaryKey: true) userId: Int = 0
8
    @Persisted(indexed: true) point: Int = 0
9
    // Enum
10
    @Persisted var userType: UserType = .standard
11
}
12

13
enum UserType: Int, PersitableEnum {
14
    case standard   = 0
15
    case unlimited  = 1
16
}

LinkingObjects

LinkingObjectsはちょっと書き方が変わっていました。ドキュメントも古いままなのでわからなかったのですが、テストコードを読んでようやく意味を理解。

1
class User: Object{
2
    @Persisted var cats: List<Cat> = List<Cat>()
3

4
    override init() {
5
        super.init()
6
        self.cats.append(Cat(name: "Mike"))
7
    }
8
}
9

10
class Cat: Object {
11
    @Persisted var name: String = ""
12

13
    // Legacy
14
    let owner = LinkingObjects(fromType: User.self, property: "cats")
15

16
    // Modern
17
    @Persisted(originProperty: "cats") var owner: LinkingObjects<User>
18

19
    // Convenience
20
    convenience init(name: String) {
21
        self.init()
22
        self.name = name
23
    }
24
}

::: warning イニシャライザ

引数を取るイニシャライザを定義した場合、convenienceとself.init()を書かないと実行時にエラーが発生します。

:::

LinkingObjectをたどるためには、

1
let owner = cat.owner.first!
2
guard let owner = cat.owner.first else { return }

のようにしてアクセスすれば良い。しかし、バックリンクは一つしかないはずなのに何故firstが必要なのかがわからない。

1
LinkingObjects<User> <0x7f9da952a1a0> (
2
  [0] User {
3
    id = 27;
4
    age = 43;
5
    cats = List<Cat> <0x600001d9d290> (
6
      [0] Cat {
7
        age = 1;
8
        name = Mike;
9
      }
10
    );
11
    userType = 0;
12
  }
13
)

ちなみにLinkingObject自体は参照すると上のようなデータを持っていたので、やはり[0]番目にアクセスするにはfirstとつけなければいけないようだ。

疑問点

以下のプロパティは使い方がいまいちわからなかった。

1
@Persisted(wrappedValue: 100) var id: Int
2
@Persisted var id: Int = 100

この二つ、ほとんど同じように感じますし、実際に実行するとどちらも初期値 100 で初期化されています。

注意点

単にクラスを定義するだけなら以下のように書けます。

1
class User: Object {
2
    @Persisted(primaryKey: true) var id: Int = 0
3
    @Persisted var age: Int? = 0
4

5
    // Override
6
    override init() {
7
        self.id = Int.random(in: Range(0 ... 100))
8
        self.age = Int.random(in: Range(0 ... 100))
9
    }
10
}

イニシャライザをoverrideしなければいけないことだけ忘れないように。

RealmSwift.Listを定義するとちょっとだけややこしくなります。

1
class User: Object {
2
    @Persisted(primaryKey: true) var id: Int = 0
3
    @Persisted var age: Int? = 0
4
    @Persisted var cats: List<Cat>
5

6
    override init() {
7
        self.id = Int.random(in: Range(0 ... 100))
8
        self.age = Int.random(in: Range(0 ... 100))
9
        self.cats.append(Cat(name: "Mike"))
10
    }
11
}
12

13
class Cat: Object {
14
    @Persisted var name: String = ""
15

16
    override init(name: String) {
17
        self.name = name
18
    }
19
}

こうすると初期化されていないcatsに値を代入しようとしているとエラーが出ます。

1
class User: Object {
2
    @Persisted(primaryKey: true) var id: Int = 0
3
    @Persisted var age: Int? = 0
4
    @Persisted var cats: List<Cat>
5

6
    override init() {
7
        super.init()    // Required
8
        self.id = Int.random(in: Range(0 ... 100))
9
        self.age = Int.random(in: Range(0 ... 100))
10
        self.cats.append(Cat(name: "Mike"))
11
    }
12
}
13

14
class Cat: Object {
15
    @Persisted var name: String = ""
16

17
    override init(name: String) {
18
        self.name = name
19
    }
20
}

この場合はイニシャライザ内でsuper.init()を実行しなければいけません。

マイグレーションのタイミング

データベースのマイグレーションおよびスキームバージョンのアップデートは起動時に行われるべきです。

ただし、いくつかの注意点があります。

1
import SwiftUI
2
import Realm
3
import RealmSwift
4

5
// グローバル変数で定義してはいけない
6
let realm = try! Realm()
7

8
@main
9
struct RealmSwiftDemoApp: SwiftUI.App {
10
    @UIApplicationDelegateAdaptor(AppDelegate.self) var appDelegate
11

12
    var body: some Scene {
13
        WindowGroup {
14
            ContentView()
15
        }
16
    }
17
}
18

19
class AppDelegate: NSObject, UIApplicationDelegate {
20
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil) -> Bool {
21

22
        #if DEBUG
23
        let config = Realm.Configuration(schemaVersion: 1, deleteRealmIfMigrationNeeded: true)
24
        Realm.Configuration.defaultConfiguration = config
25
        #else
26
        let config = Realm.Configuration(schemaVersion: 1)
27
        Realm.Configuration.defaultConfiguration = config
28
        #endif
29
        return true
30
    }
31
}

このようにlet realm = try! Realm()をグローバルで宣言すると、どこからでも利用できて便利なのですがRealm.Configurationでスキームバージョンを上げるよりも前に初期化されてしまうのでクラッシュします。

というよりも、realmのインスタンスはグローバルにすべきではありません。

何故なら、こうするとありとあらゆるファイルからデータベースの更新が可能になってしまい、コードの追加等で意図しないタイミングでデータベースが更新されてしまうからです。

なので、データベースを更新する専用のクラスをつくるほうが無難です。

データベース更新用のクラス

1
import Foundation
2
import RealmSwift
3

4
final class RealmManager {
5
    private static let realm = try! Realm()
6

7
    class Objects {
8
        static var users: RealmSwift.Results<User> {
9
            return realm.objects(User.self)
10
        }
11
    }
12
}

というわけで以下のようなクラスをつくってみた。

SwiftUI から削除するとクラッシュする問題

1
    @State var users = RealmManager.Objects.users
2

3
    var body: some View {
4
        Form {
5
            ForEach(users) { user in
6
                Text("\(user.id)")
7
            }
8
            .onDelete(perform: delete)
9
        }
10
    }
11

12
    private func delete(offsets: IndexSet) {
13
        guard let realm = try? Realm() else { return }
14
        if let index = offsets.first {
15
            try? realm.write {
16
                realm.delete(users[index])
17
            }
18
        }
19
    }

で、例えばこんなコードを書いてみます。

::: tip Realm のインスタンス

本来はrealmをdelete()内で宣言したくなかったのですが、わかりやすくするために書きました。

:::

1
libc++abi.dylib: terminating with uncaught exception of type NSException
2
*** Terminating app due to uncaught exception 'RLMException', reason: 'Index 8 is out of bounds (must be less than 7).'
3
terminating with uncaught exception of type NSException

このコードを実装すると、リストからデータを削除したときにクラッシュしてしまいます。というのも、データベースから削除されたにも関わらず、SwiftUI がForEachですでに削除されているインデックスにアクセスしようとしてしまうためです。

ObservableObject を利用した回避法

要するに直接 Realm のデータRealmSwift.Resultsを削除しようとしたためにエラーが発生してしまうのでRealmSwift.ResultsをArrayに変換して、SwiftUI 側ではArrayを使ってListを表示するようにします。

1
class UserModel: ObservableObject {
2
    private var token: NotificationToken?
3
    private var users: RealmSwift.Results<User> = RealmManager.Objects.users
4
    @Published var usersModel: [User] = []
5

6
    init() {
7
        // RealmSwift.Results<User>が更新されるとこのクロージャが実行される
8
        // そしてuserModelの配列がアップデートされる
9
        token = users.observe { [weak self] _ in
10
            self?.usersModel = Array(self!.users)
11
        }
12
    }
13
}

という感じで、データベースが更新されるとその通知を受け取ってからArrayを更新します。あとは SwiftUI がArrayを参照してリストを表示するようにすれば良いので、

1
struct ContentView: View {
2
    @ObservedObject var userModel = UserModel()
3

4
    var body: some View {
5
        Form {
6
            ForEach(userModel.usersModel) { user in
7
                Text("\(user.id)")
8
            }
9
            .onDelete(perform: delete)
10
        }
11
    }
12

13
    private func delete(offsets: IndexSet) {
14
        guard let realm = try? Realm() else { return }
15
        // 削除されたArrayから、削除されるRealmSwiftl.Results<User>を計算する
16
        if let index = offsets.first, let user = realm.objects(User.self).filter("id=%@", userModel.usersModel[index].id).first {
17
            try? realm.write {
18
                realm.delete(user)
19
            }
20
        }
21
    }
22
}

とすれば良いことになります。

ObservableObject を利用しない回避法

また、ObserverdObjectを使わない場合は以下のように書けます。

1
struct ContentView: View {
2
    @State var users: [User] = Array(RealmManager.Objects.users)
3

4
    var body: some View {
5
        Form {
6
            ForEach(users) { user in
7
                Text("\(user.id)")
8
            }
9
            .onDelete(perform: delete)
10
        }
11
    }
12

13
    private func delete(offsets: IndexSet) {
14
        guard let realm = try? Realm() else { return }
15
        if let index = offsets.first {
16
            try? realm.write {
17
                // ここの判定は曖昧なのでより厳密にしても良いかも
18
                // データベースから削除
19
                realm.delete(users[index])
20
            }
21
            // SwiftUIのリストから削除
22
            users.remove(atOffsets: offsets)
23
        }
24
    }
25
}

Frozen Objects を利用した回避法

1
struct ContentView: View {
2
    @State private(set) var users: RealmSwift.Results<User> = RealmManager.Objects.users
3
    @State private(set) var freezedUsers: RealmSwift.Results<User> = RealmManager.Objects.users
4

5
    var body: some View {
6
        Form {
7
            ForEach(users) { user in
8
                Text("\(user.id)")
9
            }
10
            .onDelete(perform: delete)
11
        }
12
    }
13

14
    private func delete(offsets: IndexSet) {
15
        guard let realm = try? Realm() else { return }
16
        if let index = offsets.first {
17
            try? realm.write {
18
                // ここの判定は曖昧なのでより厳密にしても良いかも
19
                // データベースから削除
20
                realm.delete(freezedUsers[index])
21
            }
22
            // freezeでコピー
23
            users = freezedUsers.freeze()
24
        }
25
    }
26
}

同じものを複数用意するというのが少々ダサいです。

個人的にはループのところで、

1
var body: some View {
2
    Form {
3
        ForEach(users.freeze()) { user in
4
            Text("\(user.id)")
5
        }
6
        .onDelete(perform: delete)
7
    }
8
}

ができたら便利だと思うのですが、これをやると削除しても SwiftUI がリストをアップデートしてくれませんでした、残念。

なんとアップデートでできるようになっていました。 RealmCocoa が SwiftUI に正式対応してるっぽい

RealmCocoaがまたアップデートしてるんだが