[Realm] macOS/iOS プロジェクトでの RealmSwift セットアップ

環境＆対象

SwiftPackage 設定

Swift Package Manager 経由で プロジェクトに追加するのが簡単です。

RealmSwift の github は、こちら

上記で、使用開始できますが、Realm 側が提供する Privacy Manifest を使用するためには、以下の追加設定が必要です。

Realm が提供する Privacy Manifest は、こちらで確認することができます。
(使用は必須ではありませんが、該当部分含めアプリ分を自分で作成することが必要になります)

モデル定義

せっかくなので(?)、モデルを作って 保存するところまで作ってみます。

Fighter という名前で以下の属性値を持つ要素を作成します。
・id(UUID, unique)
・name(String)
・hitPoint(Int)

Realm で上記モデルを定義すると以下のようになります。

import Foundation
import RealmSwift

class Fighter: Object {
    @Persisted(primaryKey: true) var id: UUID
    @Persisted var name: String = ""
    @Persisted var hitPoint: Int = 100
}

詳細は、Realm のドキュメントを確認する必要がありますが、ざっくり説明は以下です。

・RealmSwift を使うために、import する必要がある
・Realm に保存するためのオブジェクトは、Object を継承する必要がある
・オブジェクトとして保存するプロパティは、@Persisted をつける必要がある
・あとから キーとして検索するプロパティは、primaryKey を指定しておくと良い

保存してみる

アプリを作って、要素を作成・保存しようとすると いろいろな UI を作らなければいけないので、UnitTest を使って試してみます。

先ほど定義した Fighter を 生成し、Realm に保存するコードは以下です。

//
//  RealmNotificationCheckTests.swift
//
//  Created by : Tomoaki Yagishita on 2024/09/11
//  © 2024  SmallDeskSoftware
//

import XCTest
import RealmSwift
@testable import RealmNotificationCheck

final class RealmNotificationCheckTests: XCTestCase {
    @MainActor
    func test_create() async throws {
        let fighter = Fighter()
        fighter.name = "R01"

        let realm = try! await Realm()
        try realm.write {
            realm.add(fighter)
        }

        print(realm.configuration.fileURL ?? "noFile")
    }
}

最後の print 文は、デフォルトで作成された Realm ファイルの位置を表示しています。

自環境では、以下のような位置でした。

file:///Users/＜ユーザー名＞/Library/Containers/＜アプリID＞/Data/Library/Application%20Support/default.realm

RealmStudio で確認

Realm には、RealmStudio というツールが用意されていて、Realm の保存ファイルを開いて確認/編集することができます。

RealmStudio のページは こちら

使用している OS 向けの RealmStudio をダウンロードして用意してください。

自分がプロジェクトに指定したバージョンに対応する RealmStudio 使用することが必要です。

アプリを立ち上げて、先ほどの print 文で表示されたファイルを開くと、要素が保存されていることが確認できます。
(途中でいろいろと許諾を聞いてきますので、適切に回答してください)

RealmStudio で開くことで、要素が生成されて保存されていることが確認できます。

まとめ

Realm を使ったプロジェクトセットアップを確認しました。

説明は以上です。
不明な点やおかしな点ありましたら、こちらまで。

SwiftUI おすすめ本

SwiftUI を理解するには、以下の本がおすすめです。

SwiftUI 徹底入門

＃ SwiftUI は、毎年大きく改善されていますので、少し古くなってしまいましたが、いまでも 定番本です。

Swift学習におすすめの本

詳解Swift

Swift の学習には、詳解 Swift という書籍が、おすすめです。

著者は、Swift の初期から書籍を出していますし、Swift の前に主力言語だった Objective-C という言語についても同様の書籍を出しています。

最新版を購入するのがおすすめです。

現時点では、上記の Swift 5 に対応した第５版が最新版です。

関連記事:

[SwiftUI][Realm] SwiftUI と Realm で TODOアプリを作る [SwiftUI][Realm][Xcode12] Realm を使ったアプリの開発方法（その1 : 要素作成） [SwiftUI][CoreData] SwiftUI と MVVM で始める CoreData 入門 (その１４：CoreData を Realm と入れ替え) [Swift][Realm] Realm に Swift の enum を保存する方法