SwiftDataのカスタムデータストアを試してみた

Nagoya.swiftの時間余ったら枠で登壇

Transcript

1. SwiftDataのカスタムデータス トアを試してみた いますえ X: @1mash0_
2. SwiftDataのカスタムデータストアって？ • WWDC2024で発表されたSwiftDataの新機能 • SwiftDataはデフォルトだとCore Dataを利用して永続化が行われる • 新しいDataStoreプロトコルを利用することで独自の永続化レイヤを実装することが 可能 ◦ JSONファイルからWebサービス、データベースエンジンまで、さまざまな種類の永続化に 対応 ◦ SwiftUIおよびSwiftDataのモデリングコードを変更する必要がない https://developer.apple.com/jp/xcode/swiftdata/
3. カスタムデータストアの実装に必要なもの • DataStore • DataStoreConfiguration • DataStoreSnapshot
4. DataStore protocol DataStore : AnyObject iOS 18.0+ | iPadOS 18.0+ | Mac Catalyst 18.0+ | macOS 15.0+ … An interface that enables SwiftData to read and write model data without knowledge of the underlying storage mechanism. SwiftData が、基盤となるストレージの仕組みを知らなくてもモデルデータの読み書きを可能にする インターフェース。（ChatGPT 訳）
5. DataStoreConfiguration protocol DataStoreConfiguration : Hashable iOS 18.0+ | iPadOS 18.0+ | Mac Catalyst 18.0+ | macOS 15.0+ …
6. DataStoreSnapshot protocol DataStoreSnapshot : Decodable, Encodable, Sendable iOS 18.0+ | iPadOS 18.0+ | Mac Catalyst 18.0+ | macOS 15.0+ …
7. DefaultSnapshot struct DefaultSnapshot iOS 18.0+ | iPadOS 18.0+ | Mac Catalyst 18.0+ | macOS 15.0+ … DataStoreSnapshotの具象型 DataStoreSnapshotを指定する場面で、余程のことじゃなければこれを使えばいい気が する
8. データストアをJSONファイルに変えてみる 「Create a custom data store with SwiftData」でもJSONファイルを例にしている • final class JSONStore: DataStore { … } • final class JSONStoreConfiguration: DataStoreConfiguration { … } • DataStoreSnapshotはDefaultSnapshotを使ってる
9. JSONStore • typealias Snapshot = DefaultSnapshot ◦ @Modelを付与したクラスではなく、DataStoreSnapshotに準拠した具体型を指定する必 要がある • func fetch<T>(_ request: DataStoreFetchRequest<T>) throws -> DataStoreFetchResult<T, DefaultSnapshot> where T : PersistentModel { … } ◦ データストアからデータを取得する処理 • func save(_ request: DataStoreSaveChangesRequest<DefaultSnapshot>) throws -> DataStoreSaveChangesResult<DefaultSnapshot> { … } ◦ データストアにデータを書き込む処理 ◦ insert, update, deleteした時に呼ばれる
10. JSONStoreConfiguration • typealias Store = JSONStore ◦ DataStoreに準拠している具体型を指定する（今回だと JSONStore） • ModelContainerのconfigurationに渡すことでデータストアを指定する ◦ つまり渡すDataStoreConfigurationを変えることで今までのメモリや .storeファイルの保 存先だけでなく、データストアを切り替えることができる
11. デモ
12. 結果 SwiftData APIを使ってJSONファイルの読み書きはできた けど > JSONファイルからWebサービス、データベースエンジンまで、さまざまな種類の永続 化に対応 パッと思いつくのはFirebaseだけど...
13. 結果 func fetch<T>(_ request: DataStoreFetchRequest<T>) throws -> DataStoreFetchResult<T, DefaultSnapshot> where T : PersistentModel • データを取得するメソッドがasyncじゃない • 取得したデータを戻り値に渡す必要がある ということなのでほぼ無理そう...
14. 余談 DispatchSemaphore An object that controls access to a resource across multiple execution contexts through use of a traditional counting semaphore. 複数の実行コンテキスト間で、従来型のカウントセマフォ を使ってリソースへのアクセスを制御する オブジェクト。（ChatGPT 訳） これを使って非同期処理の完了を同期的に待つことで外部のデータベースをデータストアとして扱い たい
15. 余談 • サーバー ◦ APIサーバーはHummingbirdを使ってローカルに構築 ◦ データベースSQLiteを使用 • アプリ ◦ 基本的なコードはJSONファイルの時に試したものを流用 ◦ 外部DB用のDataStore、DataStoreConfigurationを追加 ◦ ModelContainerには外部DB用のDataStoreConfigurationを渡す
16. デモ②
17. 余談 一見良さそうに見えるけど、呼び出しがメインスレッド API側で遅延処理を入れるとアプリ側のUIが固まってしまう 実際に使うのは無理そう （@Queryじゃなくて@Stateで持って、Task.detachedで明示的にfetchを呼んで...みた いなことをすればいけそうだけど）
18. 感想 • JSONファイルだったりの同期処理なら使える • 必須メソッドがasyncじゃないのが厳しい • モデルが同一ならDataStoreConfigurationを差し替えるだけで済むのは嬉しい • こんな使い方あるよ～とかあったら知りたい
19. ご清聴ありがとうございました