SwiftDataを使用したカスタムデータストアの作成

SwiftDataを使用したカスタムデータストアの作成

SwiftDataが提供する表現力に優れた宣言型のモデリングAPIの力を、デベロッパ各自の永続性バックエンドと組み合わせましょう。カスタムデータストアの構築方法と、アプリに永続性機能を段階的に追加していく方法を説明します。このセッションの内容を最大限に活用するには、WWDC23の「Meet SwiftData（SwiftDataについて）」と「Model your schema with SwiftData（SwiftDataでスキーマをモデル化）」を併せて視聴されることをお勧めします。

関連する章
- 0:00 - Introduction
- 1:21 - Overview
- 4:50 - Meet DataStore
- 7:42 - Example store
リソース
関連ビデオ

WWDC24
- SwiftDataの履歴機能によるモデル変更のトラッキング
皆さんこんにちは LuvenaですここではSwiftDataにおけるカスタムデータストアについて説明しますこれはデベロッパの永続性バックエンドで SwiftDataを使用する手法の1つですカスタムデータストアは SwiftDataの新機能でありこれにより任意のドキュメントやファイル形式永続性バックエンドを必要に応じて使用できますまた既存のSwiftDataコードとの互換性もあります
こちらはSampleTripsアプリの実装ですがここでストアの型を変更するには ModelConfigurationを JSONStoreConfigurationに置き換えるだけですこのビデオの後半で実際の実装をお見せしますこの1か所を置き換えるだけで別のストアの型を使用することが ModelContainerで認識されます SampleTripsアプリのモデルやビューのコードに変更を加える必要はありません
このビデオではまず SwiftDataにおけるストアの役割を紹介しストアとModelContextや ModelContainerとのやり取りについて説明しますまた新しいDataStore プロトコルを使用してストアを構築する方法を説明します最後にカスタムデータストアの実装に関する基本事項を確認し永続性を実現するために JSONファイルを使用する例を紹介します大まかに言うとストアは永続性モデルを支えるために必要なすべてのデータの取得と保存を担うものです SwiftDataにおけるカスタムデータストアの機能について説明するため SampleTripsというアプリを使ってどのように永続性が実現されるかを確認します SampleTripsはSwiftUIとSwiftDataの相乗効果を活かして構築されています標準的なアプリは主に3つの部分で構成されます SwiftUIはユーザーインターフェイスを提供します通常はリストやラベルなどのビューですそこにModelContextのモデルからのデータが表示されます ModelContextは ModelContainerにあるストアを使ってデータを読み書きしますこのビデオでは SwiftDataにおいてストアが果たす役割に焦点を当てて説明します SampleTripsでは ModelContextを使用してビューを実現し旅行情報を表示します ModelContextではビューの旅行1件ごとに永続性モデルのｲンスタンスを作成しますまたこれらの旅行のそれぞれに対応する永続識別子がありモデルを一意に識別できます ModelContextではユーザーによる変更がトラッキングされ必要に応じてストアに保存することができますたとえばロサンゼルスへの旅行をキャンセルして東京への旅行を追加した場合これらの変更はModelContextによってトラッキングされます新しい東京のモデルがモデルのコンテキストに挿入される際一時的なPersistentIdentifierで識別されます ModelContextは保存する際ストアに対してロサンゼルスの旅行を削除し新しい東京への旅行を挿入するよう通知しますストアは東京のモデルに対して永続的な永続識別子「Trip-5」を割り当てそれまでの一時的な識別子「Trip-t1」にマッピングしますこのプロセスを「リマッピング」と呼びます
その後ストアは東京旅行に対する更新済みの永続識別子を応答としてModelContextに返します
ModelContextが状態の更新を終えると UIでビューを更新して旅行のレンダリングができます変更の永続化は ModelContextとストアの連携によって SwiftDataの永続性モデルがサポートされることを示す一例です両者は取得や保存などの操作が定義された一連のリクエストとレスポンスを使用してやり取りしますストアの役割はモデルの値を永続させるための実装を提供することですこのやり取りではモデルを送信可能でコード表現可能な形にした DataStoreSnapshotを利用します
SampleTripsアプリではビューは永続性モデルを使用して ModelContextとやり取りしますただし ModelContextがストアとやり取りする必要がある場合はスナップショットを作成してモデルの現在の状態を保持しますスナップショットはその時点でモデルに存在する値を格納する送信可能でコード表現可能なコンテナです永続性モデルと同様それぞれが永続識別子で識別されます
ストアはそれらのスナップショットを使用しその値をストレージに適用しますその逆も同様です ModelContextによってストアからデータが読み取られるとストアは一連のスナップショットを作成しますこれはコンテキストで求められている永続性モデルと一致します
ModelContextはスナップショットごとに永続性モデルを作成しますこのモデルをビューやクエリそしてコンテキストが実行するその他の処理に使用しますストアはSwiftDataで重要な役割を果たしそれによりModelContextはどのような保存形式でもモデルのデータの読み取み／書き込みができます新しいDataStoreプロトコルとその実現方法をご説明します
ストアには3つの重要な要素がありますストアについて記述した設定モデルの値をModelContextとやり取りするためのスナップショット ModelContainerが管理できるストアの実装ですこれらの各要素はそれぞれ異なる 3つのプロトコルに準拠しています DataStoreConfigurationと DataStoreSnapshot DataStoreです SwiftDataのデフォルトのストアでは次の3つの型が独自に実装されています ModelConfiguration DefaultSnapshot DefaultStoreです DefaultStoreは移行や履歴のトラッキング CloudKitの同期など SwiftDataに備わる充実した機能をすべてサポートしていますパフォーマンスとスケーラビリティに関するプラットフォームのベストプラクティスが組み込まれており永続性モデルに最適なデフォルトの選択肢となっています
DataStoreプロトコルでは保存取得キャッシュなど ModelContextがストアを使用するために SwiftDataに必要な機能がすべて定義されていますそのほかのプロトコルではオプションのデータストア機能が定義されておりストアに対して行われた変更をすべて記述するための新しいHistoryプロトコルなどがあります
ModelContextは DataStoreプロトコルからのリクエストとレスポンスを使用してストアとやり取りしますたとえばストアからデータを取得する場合 ModelContextはストアに対してストアが取得すべきデータが記述された FetchDescriptorを含む DataStoreFetchRequestを送信します
ストアはモデルの値を取得するとモデルごとにスナップショットを作成し DataStoreFetchResultに格納して返送します
ModelContextはスナップショットごとに永続性モデルを作成します
ModelContextのモデルが変更され saveが呼び出された場合も同様の処理が行われます ModelContextは変更されたすべてのモデルのスナップショットを含む DataStoreSaveChangesRequestを作成しそのリクエストをストアに送信します
ストアはスナップショットをストレージに適用し DataStoreSaveChangesResultを作成して ModelContextに返送します最終的にストアは「Trip-t1」など新しく挿入されたモデルに対応するリマッピングされた識別子のマップを提供しますこれをもとに ModelContextは挿入された旅行の永続識別子を「Trip-5」に更新します
最後に ModelContextはストアからの保存結果を処理し状態を更新して挿入された旅行に対して新しい永続的な永続識別子を割り当てます
ここまでDataStoreの仕組みを説明してきましたここで実際の実装の様子を見てみましょう SampleTripsアプリで JSONファイルを使用してモデルを永続化するストアを実装します本題に入る前に説明しておきたいことが2つありますこのストアは「アーカイブストア」ですつまり読み込みまたは書き込みの際ファイル全体が読み込まれますさらに Foundationで用意されている JSONコーダを使用しデータをスナップショットの配列としてファイルに保存します
ストアを作成する最初の手順は設定とストアの型を宣言することですこれはDataStoreConfiguration および DataStoreプロトコルに準拠するものです
これらの型では関連付けられた型を使用して相互に参照します Configurationでは Storeの型として JSONStoreを設定しこのストアでは Configurationに JSONStoreConfigurationを設定します
また JSONStoreでは ModelContextとのやり取りに使用するスナップショットの型を宣言しますここで DefaultSnapshotを使用するのはモデルデータのエンコーディングやデコーディングをカスタマイズする必要がないためですこれで DataStoreをModelContextで使用するために必要な 2つのメソッド fetchとsaveの実装を始めることができます ModelContextが DataStoreFetchRequestを送信したらストア内にあるデータを読み込み DataStoreFetchResultをインスタンス化する必要があります DefaultSnapshotはコード化できるため JSONDecoderを使用して Configurationで提供されているファイルのURLからストアのデータを読み込むことができます次に DataStoreFetchResultをインスタンス化しファイルから取得したスナップショットを設定して返します現時点ではこの実装では FetchDescriptorにある述語やソートコンパレータは処理されません述語やソートコンパレータの変換は複雑なプロセスになる可能性がありますここではその代わりに ModelContextを使用します
リクエストに述語またはソートコンパレータが含まれている場合は preferInMemoryFilterおよび preferInMemorySortのエラーをスローしますこの場合はこれで問題ありませんメモリに読み込むことができる小規模なデータセットだからですこれでクエリとソートに対応できる十分な機能を持つ fetchを実装できました fetchが実装できたらスナップショットをJSONファイルに書き出す saveを実装できます saveの実装では挿入更新削除の 3種類の変更を考慮しこれらに対応したいと思います saveのリクエストで受信したスナップショットの処理を開始する前にまずファイルの現在の内容を読み取る必要がありますこれについては私が定義したreadという別のメソッドで処理しますすべてのスナップショットを辞書にまとめ永続識別子をキーとしますこの辞書を作業用のコピーとして新しいJSONファイルを作成し最終的にディスクに書き込みます
saveのリクエスト内の挿入されたモデルのスナップショットを処理しますこの処理には挿入された各スナップショットの識別子の割り当てとリマッピングが含まれますこれについてもう少し詳しく説明します先に説明したようにモデルがストアに挿入されるときには各モデルには一時的な識別子が含まれておりそこにはストアが関連付けられていませんこの挿入された各スナップショットについて新しい永続的な永続識別子を作成します次に新しい永続識別子を使ってスナップショットのコピーを作成しますこの新しい永続識別子は remappedIdentifiers辞書内の一時的な識別子にマッピングされ後でsaveの結果で ModelContextに返されます最後に挿入されたスナップショットを最初にファイルから読み込んだスナップショットに追加します
挿入されたスナップショットを処理した後更新の処理を行うためにファイルからのスナップショットを saveのリクエスト内のスナップショットに置き換えます最後にファイルから読み込んだスナップショットから削除済みのスナップショットを削除しますこれで snapshotsByIdentifier辞書のデータの更新が完了しましたこれを元のファイルに書き込みます
JSONEncoderを使用して複数あるスナップショットの作業用コピーをディスク上の 1つのJSONファイルに書き込みます最後に saveの結果とともに DataStoreSaveChangesResultを返します DataStoreSaveChangesResultには更新するコンテキストの remappedPersistentIdentifiersが含まれます
カスタムデータストアが完成したので SampleTripsに導入できますアプリの定義でストアの型を変更できますそれには ModelConfigurationを JSONStoreConfigurationに置き換えるだけですこの1か所を置き換えるだけで別のストア型を使用することが ModelContainerで認識されます SampleTripsアプリのモデルやビューのコードを変更する必要はありません
DataStoreを使用することにより SwiftDataで任意の保存形式や永続性バックエンドのデータの読み書きができます
これにより必要に応じて任意のドキュメントデータベースクラウドストレージに SwiftUIや永続性モデルを活用できるとともに ModelContextがフィルタやソートの機能を提供するためシンプルにストアを実装することができ複雑さが軽減されます
SwiftDataでのカスタムストアの導入は DataStoreConfigurationを変更するだけで簡単です新しいDataStoreプロトコルが導入されたことにより任意の永続性バックエンドのサポートを実装できますこれにより SwiftDataの新たな可能性が広がります「What's New in SwiftData」ではインデックスや一意制約などの新機能を紹介していますまた「Track model changes with SwiftData History」ではストアの履歴を確認する方法を紹介していますのでぜひご覧ください
ご視聴ありがとうございました皆さんの成果に期待しています

// Implement a JSON store

@available(swift 5.9) @available(macOS 15, iOS 18, tvOS 18, watchOS 11, visionOS 2, *)
final class JSONStoreConfiguration: DataStoreConfiguration {
    typealias StoreType = JSONStore
  
    var name: String
    var schema: Schema?
    var fileURL: URL

    init(name: String, schema: Schema? = nil, fileURL: URL) {
        self.name = name
        self.schema = schema
        self.fileURL = fileURL
    }

    static func == (lhs: JSONStoreConfiguration, rhs: JSONStoreConfiguration) -> Bool {
        return lhs.name == rhs.name
    }

    func hash(into hasher: inout Hasher) {
        hasher.combine(name)
    }
}

@available(swift 5.9) @available(macOS 15, iOS 18, tvOS 18, watchOS 11, visionOS 2, *)
final class JSONStore: DataStore {
    typealias Configuration = JSONStoreConfiguration
    typealias Snapshot = DefaultSnapshot

    var configuration: JSONStoreConfiguration
    var name: String
    var schema: Schema
    var identifier: String

    init(_ configuration: JSONStoreConfiguration, migrationPlan: (any SchemaMigrationPlan.Type)?) throws {
        self.configuration = configuration
        self.name = configuration.name
        self.schema = configuration.schema!
        self.identifier = configuration.fileURL.lastPathComponent
    }

    func save(_ request: DataStoreSaveChangesRequest<DefaultSnapshot>) throws -> DataStoreSaveChangesResult<DefaultSnapshot> {
        var remappedIdentifiers = [PersistentIdentifier: PersistentIdentifier]()
        var serializedTrips = try self.read()

        for snapshot in request.inserted {
            let permanentIdentifier = try PersistentIdentifier.identifier(for: identifier, 
                                                                          entityName: snapshot.persistentIdentifier.entityName,
                                                                          primaryKey: UUID())
            let permanentSnapshot = snapshot.copy(persistentIdentifier: permanentIdentifier)
            serializedTrips[permanentIdentifier] = permanentSnapshot
            remappedIdentifiers[snapshot.persistentIdentifier] = permanentIdentifier
        }

        for snapshot in request.updated {
            serializedTrips[snapshot.persistentIdentifier] = snapshot
        }

        for snapshot in request.deleted {
            serializedTrips[snapshot.persistentIdentifier] = nil
        }
      
        try self.write(serializedTrips)
        return DataStoreSaveChangesResult<DefaultSnapshot>(for: self.identifier,
                                                           remappedPersistentIdentifiers: remappedIdentifiers,
                                                           deletedIdentifiers: request.deleted.map({ $0.persistentIdentifier }))
    }

    func fetch<T>(_ request: DataStoreFetchRequest<T>) throws -> DataStoreFetchResult<T, DefaultSnapshot> where T : PersistentModel {
        if request.descriptor.predicate != nil {
            throw DataStoreError.preferInMemoryFilter
        } else if request.descriptor.sortBy.count > 0 {
            throw DataStoreError.preferInMemorySort
        }

        let objs = try self.read()
        let snapshots = objs.values.map({ $0 })
        return DataStoreFetchResult(descriptor: request.descriptor, fetchedSnapshots: snapshots, relatedSnapshots: objs)
    }

    func read() throws -> [PersistentIdentifier: DefaultSnapshot] {
        if FileManager.default.fileExists(atPath: configuration.fileURL.path(percentEncoded: false)) {
            let decoder = JSONDecoder()
            decoder.dateDecodingStrategy = .iso8601

            let trips = try decoder.decode([DefaultSnapshot].self, from: try Data(contentsOf: configuration.fileURL))
            var result = [PersistentIdentifier: DefaultSnapshot]()
            trips.forEach { s in
                result[s.persistentIdentifier] = s
            }
            return result
        } else {
            return [:]
        }
    }

    func write(_ trips: [PersistentIdentifier: DefaultSnapshot]) throws {
        let encoder = JSONEncoder()
        encoder.dateEncodingStrategy = .iso8601
        encoder.outputFormatting = [.prettyPrinted, .sortedKeys]
        let jsonData = try encoder.encode(trips.values.map({ $0 }))
        try jsonData.write(to: configuration.fileURL)
    }
}

関連する章

リソース

関連ビデオ

WWDC24