SwiftDataへの移行

あなたのアプリでSwiftDataを使い始める方法を模索しましょう。既存のCore Dataオブジェクトモデルからモデルクラスを生成するためにXcodeを使用する方法、以前の実装と一緒にSwiftDataを使用する方法、あるいは既存のソリューションを完全に置き換える方法を紹介します。このセッションを見る前に、"Meet SwiftData "を確認してください。

リソース

関連ビデオ

WWDC23

ダウンロード

♪ ♪

あなたのCore Dataアプリを Core Dataと共存できる Swiftネイティブの永続化フレームワークのSwiftDataに移行する方法を共有できることを嬉しく思います Core DataからSwiftDataへの完全な移行の準備ができているかまたはSwiftDataを段階的に採用し Core Dataと共存したいのかどうかに関わらず Core Dataアプリに SwiftDataを採用する方法の一般的な使用例を取り上げます最初にマネージドオブジェクトモデルエディタアシスタントを使用して SwiftDataモデルクラスを生成する方法を説明しますそれから既存のCore Data アプリケーションに SwiftDataを採用する流れを示します最後にSwiftDataへの完全な移行があなたのアプリにとって実現可能な解決策ではない場合のために Core DataとSwiftDataの共存について紹介しますまずモデル・クラスを生成する方法の流れを説明します SwiftDataではスキーマを設定するためにコードでモデルを定義するかたちになりますこれを行う1つの簡単な方法は SwiftDataモデルを生成するために Core Dataのマネージドオブジェクトモデルを使用することですではこの移行方法について説明します私はここでSampleTripsというユーザーの今後の旅行の旅程を計画に役立つCore Data アプリケーションを作成しましたこれがモデルファイルで私のデータとその構成に関する情報が含まれています私はTrip宿泊施設バケツリストのエンティティを持っており各トリップには対応する生活宿泊施設と希望する旅行のアクティビティを表すバケットリストの項目が構成されていますここからこの同じ情報をキャプチャする SwiftDataクラスを生成します Core Dataのマネージドオブジェクトモデルは SwiftDataクラスを作成するために必要ではありませんが既存のCore Dataモデルを持っている場合すでに既存のモデルで持っている情報に基づいて SwiftDataクラスを生成するためにそれを使用することができますそのためにマネージドオブジェクトモデルエディタアシスタントを使いますモデルファイルを選択した後メニューバーに移動し Editorを選択し Create SwiftData Codeをクリックしますこれでファイルを生成できるようになりましたゼロからSwiftDataモデルを作成は新しいSwiftアプリを作成する場合のこのアシスタントは必須ではありませんこれが作成されたファイルです Swiftの型は Modelに準拠して Trip の名前目的地開始日と終了日他のエンティティである宿泊施設とバケツリストとの関係である属性を含む変数としてエンティティの情報を取得しますそれでは、SwiftDataの完全な採用プロセスをお見せしましょうアプリケーションを完全に SwiftDataに移行する場合 Core Dataスタックを完全にSwiftDataスタックに置き換えることになりますこれでデータを永続化するコードがより見やすくなりいくつかの機能を暗黙的に管理できるようになりますしかしこの移行を行う前に既存のCore Data モデルの設計がどのような構造になっているかを検討する必要があります Core Data モデルの設計はエンティティやそのプロパティリレーションシップを含むスキーマを参照します Core Data モデルの設計が SwiftDataでもサポートされていることを確認する必要がありますこれはCore Dataで定義された各々のエンティティに対して SwiftDataのエンティティ名とプロパティが完全に一致するモデルタイプが必要であることを意味しますすべての機能がSwiftDataでサポートされていることを確認するためにモデルを徹底的にテストしてください Core Dataアプリからの完全な SwiftData採用プロセスの特徴をもう少し詳しく説明しましょう私はすでにモデルをキャプチャのために Swiftの型を生成しましたこれらのファイルを準備できたら以前使用していたCore Dataの管理オブジェクトモデルファイルを削除し代わりにこれらのSwiftファイルを通してモデルを管理することができますさらに以前Core Dataスタックのセットアップに役立った Persistenceファイルを削除することもできますこれでSwiftDataスタック用の modelContainerを設定できるようになりました modelContainerはグループ内の全てのウィンドウが同じ永続コンテナにアクセスするように構成されることを保証するmodifierですこのコンテナをTripsAppに追加することでコンテナとコンテキストの両方をセットアップすることができます ModelContextはアプリのインスタンスの変更を追跡するために使用されますこの環境プロパティを使ってどのシーンやビューからも読み取ることができます私のSwiftDataのSampleTrips用の永続的なスタックはセットアップされましたがいくつかの変更が必要ですまず最初にオブジェクトの生成がどのように行われるかを示します以前はコアデータで新しいトリップを作成する場合この手順で行ってました Tripのインスタンスを作成しその属性を設定する前に管理オブジェクトコンテキストを渡します SwiftDataではこのコードの行で Tripの新しいインスタンスを作成することができ比較的読みやすくなっていますこの新しいトリップを手に入れたらそれをモデル・コンテキストに入力し確実に永続化します私のトリップが永続化されたのでそれを保存する方法と将来そのトリップに加える変更を検討したいです SwiftData には暗黙の保存機能があり UI ライフサイクルイベントと可能であればコンテキストが変更された後のタイマーで保存をトリガーしますしたがってCore Dataの明示的な保存を削除しコンテキストが変更されたときに暗黙的な保存に頼ってデータを永続化することができますでは私がどのようにデータを取得するのかを説明します Core Dataのようにフェッチリクエストを使う代わりに Queryでトリップの配列をラップして今後のトリップの全リストをフェッチすることができるのですこれによってトリップオブジェクト SwiftDataコンテナから取得できますまたクエリのソート順も定義しています旅行開始日の順で並べ替えたいです旅行開始日を前方順に並べ替え最も近い旅行が一番上に来るようにしましょうクエリはPredicateを含む必要があるユースケースとなります Core DataアプリをSwiftDataに完全に移行する方法がわかったところで Core DataとSwiftDataを共存させたい場合について説明しましょう完全な移行は必ずその場合 SwiftDataへの部分的な変換を検討することができます Core Dataスタックと SwiftDataスタックという 2つに分離された永続的なスタックが同じ永続的なストアに接続している状態ですつまり SwiftDataのコードを追加するために既存のCore Dataのコードを完全に書き直す必要がないということですアプリへSwiftDataを採用するときにすでにCore Dataがいくつかのデータを持っているか SwiftDataに完全に移行することができない他の制約に直面しているかにかかわらずより柔軟性を提供しますこのように両方のスタックを同じストアに接続するように設定することができます永続ストアをロードする前に container descriptionに永続ストアURLを設定し両方のスタックが同じ URL に書き込まれるようにする必要がありますさらに永続的な履歴追跡をオンにする必要があります一方SwiftDataは自動的に永続的な履歴追跡をオンにします Core Dataは例外です永続的な履歴を設定することなく同じアプリケーションにCore Dataと SwiftDataの両方が、共存しているときに永続的なストアを開こうとするとストアは読み込み専用モードになりますあなたのユースケースにとって共存が最良の選択肢となるシナリオがいくつかあります一つの選択肢は既存クライアントと後方互換性を確保することです SwiftDataはiOS 17と macOS Sonomaでしか利用できないからです現在のCore Dataアプリケーションは SwiftDataへの完全な切り替えで影響を受ける可能性がありますあるいはSwiftDataへの完全な変換を困難にするリソースの制約に直面するかもしれませんこのような場合には次のようなものを組み込むのが理にかなっています SwiftDataを使用して新しい開発を行うかアプリの一部だけ SwiftDataに変換することで部分的に SwiftDataを使用することができます Core DataとSwiftDataを共存させるためにこの移行を行う前に考慮すべきいくつかの要件があります最初に既存のNSManagedObject ベースのエンティティサブクラスか SwiftData 名前空間にしてクラスを衝突しないように注意しますつまり2つのクラスが同じものと呼ばれることはなく少なくともどちらか一方を変更する必要ですクラス名を変更してもエンティティ名は変わらないことに注意してくださいここでは前と同じ SampleTripsプロジェクトをつかいますが今回はCore Dataと SwiftDataを共存させたいのですこの2つのクラス名がややこしいです SwiftDataとCore Dataの両方の名前を区別するために Core Dataトリップクラス名を CDTripに変更しましたこれはModel Editorでも可能です Core Dataを保持する必要があります SwiftDataのスキーマを同期させ SwiftData スキーマの新しい部分はマネージドオブジェクトモデルとして実体化されなければならず 2つのスキーマが分岐することはありませんつまりプロパティとリレーションシップはまったく同じ方法でモデルに追加されなければならないのですこれはエンティティのバージョン・ハッシュの一致化のためですハッシュの不一致はマイグレーションを引き起こし必要な情報を削除してしまうかもしれないからです最後に共存を取り入れる際にはスキーマのバージョンを把握しておく必要があります SwiftDataモデルの複数のバージョンを扱うとき SwiftDataが違いを評価できるよう変更が正しく表現されていることを確認する必要がありますこれにはいくつかの方法がありますバージョン管理されたスキーマの使い方を理解するため「Model your schema with SwiftData」をチェックしてください UIKitまたはAppKitに依存する Swiftアプリのために SwiftDataを使用する実行可能なオプションがまだあります最初のアプローチは共存ソリューションです UIKitのコードをCore Dataにバインドでき SwiftDataと並行して動作することができます代わりにSwiftDataクラスを Swiftクラスとして扱い代わりにUIKitコードでSwiftコードをラップもできます私からは以上です！さあ柔軟なマイグレーションを体験してみましょう Core DataアプリをSwiftDataに完全移行か段階的に移行しますその間にSwiftDataについてより深く知るためにこれらの他のクールな講演をチェックしてください参加してくれてありがとう！何を作ってくれるのか楽しみ！ ♪ ♪

4:37 - Creating a ModelContainer in SwiftUI

@main
struct TripsApp: App {
    var body: some Scene {
        WindowGroup {
            ContentView()
        }
        .modelContainer(
            for: [Trip.self, BucketListItem.self, LivingAccommodation.self]
        )
    }
}

4:57 - Object creation in Core Data

@Environment(\.managedObjectContext) private var viewContext

let newTrip = Trip(context: viewContext)
newTrip.name = name
newTrip.destination = destination
newTrip.startDate = startDate
newTrip.endDate = endDate

5:30 - Object creation in SwiftData

@Environment(\.modelContext) private var modelContext

let trip = Trip(
    name: name, 
    destination: destination, 
    startDate: startDate, 
    endDate: endDate
)

modelContext.insert(object: trip)

6:16 - Fetch with Query in SwiftData

@Query(sort: \.startDate, order: .forward)

var trips: [Trip]

7:30 - Setting store path and enabling persistent history tracking in Core Data

let url = URL(fileURLWithPath: "/path/to/Trips.store")

if let description = container.persistentStoreDescriptions.first {
    description.url = url
    description.setOption(true as NSNumber, forKey: NSPersistentHistoryTrackingKey)
}

9:11 - Ensuring Core Data and SwiftData class names are unique

class CDTrip: NSManagedObject {
    // ...
}


@Model final class Trip {
    // ...
}

特定のトピックをお探しの場合は、上にトピックを入力すると、関連するトピックにすばやく移動できます。

SwiftDataへの移行

関連する章

リソース

関連ビデオ

WWDC23