SwiftDataの新機能

SwiftDataの新機能

SwiftDataを利用すると、表現力に優れた宣言型のAPIによって、アプリのデータを簡単に永続化できます。このセッションでは、複合的な一意性制約、#indexによるクエリの高速化、Xcodeプレビューでのクエリ、豊富な述語表現など、SwiftDataの改善点について解説します。これらのさまざまな機能を使用してより充実したモデルを表現し、アプリのパフォーマンスを向上させたいデベロッパの方は、ぜひご参加ください。SwiftDataでカスタムデータストアを構築する方法や履歴に関するAPIを使用する方法については、「Create a custom data store with SwiftData（SwiftDataを使用したカスタムデータストアの作成）」と「Track model changes with SwiftData history（SwiftDataの履歴機能によるモデル変更のトラッキング）」をご視聴ください。

関連する章
- 0:00 - Introduction
- 0:57 - Adopt SwiftData
- 2:11 - Customize the schema
- 2:43 - #Unique macro
- 3:37 - History API
- 4:29 - Tailor a model container
- 5:39 - Custom data stores
- 6:41 - Xcode previews
- 9:20 - Customize queries
- 10:18 - #Expression macro
- 11:56 - #Index macro
リソース
関連ビデオ

WWDC24
- SwiftDataの履歴機能によるモデル変更のトラッキング
- SwiftDataを使用したカスタムデータストアの作成
WWDC23
- SwiftDataについて
こんにちは Rishi Vermaです SwiftDataチームでエンジニアをしています本日はSwiftDataの新機能について説明します
SwiftDataは iOS 17で導入されましたこのフレームワークにより Appleのすべてのプラットフォームで Swiftにおけるアプリデータのモデル化と永続化が可能になりますマクロなど Swift言語の最新機能を活用して高速で効率的かつ安全なコードを記述できますこのビデオでは SwiftDataフレームワークの概要を簡単に復習してから新機能を掘り下げていきますまず新しいスキーママクロを使ってモデルの重複を避ける方法を紹介し次にモデルコンテナを設定して構成するための新しい方法を説明します
最後に複雑なフィルタを使ってクエリを最適化する方法と新しいマクロでパフォーマンスを向上させる方法を説明します
まず SwiftDataについて簡単に説明します SwiftDataはアプリのモデルレイヤを簡単に構築しアプリの起動間でそれを永続化できるフレームワークです
このフレームワークは永続化だけでなくスキーマのモデル化と移行グラフ管理 CloudKitとの同期など多数の機能を提供します SwiftDataをアプリに導入するのがいかに簡単かを説明するために私とチームが開発しているアプリ Tripsを紹介します TripsはSwiftUIで書かれたアプリで旅行について検討したことなど様々な記録をすべて残せます
このアプリのモデルで SwiftDataを使用するにはフレームワークをインポートし各モデルに@Modelマクロを追加するだけですこれがSwiftDataの強力な機能です
アプリの定義では WindowGroupの modelContainerモディファイアが Tripモデルのビュー階層全体に通知します
これが設定されるとビューは静的データを削除し代わりに@Queryを使ってビューを構成しますこれによりモデルコンテナから Tripモデルを取得しTripsの配列を返しますこれで完了です！アプリは私が作成した旅行をすべて永続化し SwiftUIビューに完璧にフィットします最初のステップは@Modelマクロを追加することでしたがこれはスキーマのカスタマイズ方法の始まりに過ぎません
@Modelマクロは強力で永続化の経験に役立ちます永続化可能なすべてのクラスにこのマクロを付けるだけで Tripクラスと関連モデルの保存プロパティが永続化されます
さらに @Attributesや @Relationshipsのマクロを使ってスキーマをカスタマイズしたり保存プロパティを @Transientと指定してデータの永続化を回避することもできます
今年は新しいスキーママクロが導入され永続モデルに対する複合制約を構築できるようになりました
新しい#Uniqueマクロを使用してモデルのプロパティのどの組み合わせがモデルデータ内で一意でなければならないのかを SwiftDataに指示できます 2つのモデルインスタンスが同じ一意の値を共有する場合 SwiftDataは既存モデルと競合した際にアップサートを実行します
例えば Tripsアプリでは #Uniqueマクロを使って旅行の名前開始日終了日が一意であることを保証していますこれでこのアプリは同じ名前の複数の旅行を持つことができますが開始日と終了日が異なる場合に限りますこれによりデータの重複を避けることがとても簡単になりますなぜなら SwiftDataはより多くの情報に基づいて実際にどのモデルが重複しているかを判断し代わりにデータの更新を実行するからです
#Uniqueプロパティで@Modelが重複していないことを確認できるためこれらのプロパティはこのモデルの識別子にもなります @Attributeマクロを使って preserveValueOnDeletionをこれらのプロパティに指定することもできますこれにより SwiftDataで履歴APIを使う際にこれらの識別値を利用できます
SwiftDataの履歴機能を使うと挿入更新削除されたモデルを時間の経過とともにアプリで把握できますモデルが削除されると保存するように指定された値はトゥームストーン値として履歴情報に保持されこれらの変更を処理するために必要な情報がアプリに提供されますまたこれをサポートするよう構築されたカスタムデータストアとシームレスに連携します詳細はこちらのビデオ「Track model changes with SwiftData history」をご覧くださいモデルコンテナをカスタマイズするとデータの場所とアプリ全体でのデータの使い方をアプリで微調整できます
modelContainerモディファイアは SwiftDataを使う最も簡単な方法です永続化するモデルの型を指定するだけで SwiftDataがコンテナを用意します modelContainerモディファイアでコンテナの一部のプロパティをカスタマイズすることもできます
例えばディスクではなくメモリにデータを保存したり自動保存を有効または無効にしたり元に戻す／やり直しのオンとオフを切り替えたりできます
modelContainerをさらにカスタマイズしてディスク上の保存先の変更などを行うには独自のmodelContainer インスタンスを別に構築します Tripsアプリでこれを試してみましょう modelContainerモディファイアでコンテナを構築する代わりに containerプロパティを使って独自のコンテナを作成します
このプロパティのクロージャでモデルの構成を作成してスキーマを渡しますここでディスク上のデータの URLもカスタマイズします次に ModelContainerイニシャライザにこの構成を渡して結果を返します
iOS 18のSwiftDataでは完全カスタムのデータストアを使って modelContainerをさらにカスタマイズできますデフォルトのデータストアは SwiftDataの全機能をサポートする堅牢な永続性バックエンドを提供しますがここでは独自のデータストアを作成しますこれにより独自の実装でコンテナ全体のデータを永続化します
例えば Tripsアプリでは JSONファイルで構成された独自のカスタムドキュメント形式を実装しましたこれをアプリで使用するためにはモデルの構成をカスタムデータストアで指定した構成に入れ替えるだけですこの例では JSONStoreConfigurationです
カスタムデータストアではデータの永続化形式を問わず @Modelや@Queryマクロなどの使い慣れたSwiftData APIを使うことができますデータストアに機能を段階的に取り入れることもできるためすぐに使い始めることができます詳細についてはこちらのビデオ「Create a custom data store with SwiftData」をご覧ください
Xcodeのプレビュー用にカスタムコンテナを作成することもできますプレビューは SwiftUIでのアプリ開発において最適なツールであり SwiftDataと非常に相性がいいです
Tripsアプリのすべてのビューで優れたプレビューを作成したいと思いますまずプレビュー特性を使います
そのために SampleDataという新しい構造体を作成し PreviewModifierに準拠させますこの構造体には実装する必要のある 2つの関数があります 1つはプレビュー用の共有コンテキストを設定するためのものでもう1つは共有コンテキストをビューに適用するためのものです Tripsのプレビューでは ModelContainerをsampleDataの共有コンテキストとして用意しますプレビューではディスクに何も保存する必要がないのでデータをメモリにのみ保存する ModelConfigurationを作成し ModelContainerを設定します
次に先ほど作成したメソッドを呼び出しますこれは様々なサンプル旅行を作成しモデルコンテナに保存します旅行は名前と日付が一意であるためこのコードではデータの重複排除は不要です SwiftDataが行ってくれます
最後にコンテナを返します次に sampleDataを使用するビューにこのmodelContainerを追加するメソッドを実装する必要がありますそのためには modelContainerモディファイアを使用してこのコンテナを適用するだけです
最後に PreviewTraitに拡張機能を追加しますこれでこのsampleDataに簡単にアクセスできますこれにより新しい静的プロパティ sampleData()が作成され SampleData()構造体がモディファイアとして適用されます
これで任意のSwiftUIビューのプレビュー宣言時に traitsパラメータで .sampleDataを使用できますこれによりメモリ内のモデルコンテナが作成され sampleDataが読み込まれ SwiftUIビューで使えるようにプレビューが変更されます
優れたサンプルデータを用意すれば SwiftDataクエリを使ってアプリのどのビューでも簡単に作業できますただし一部のアプリのビューはモデルが渡されることに依存しているためクエリが含まれていない可能性がありますこの場合も @Previewableマクロで素晴らしいプレビューを作成できます
例えばTripsでは BucketListItemViewは1つの旅行をパラメータとして受け取ります sampleDataを使用すると bucketListItemViewは sampleDataを含むモデルコンテナを持ちますがまだそのデータのクエリを実行していません
今は @Previewableマクロを使用しプレビュー宣言内で直接クエリを作成できますこれにより提供される旅行の配列を BucketListItemViewに渡すことができ sampleDataを使ったプレビューを作成できます
最後に SwiftData向けに最適化された強力なクエリの作成方法を紹介しますクエリはソートやフィルタリングを簡単に行えるモデルの配列で SwiftUIビューを駆動し ModelContainerに加えられた変更に自動的に反応します #Predicateはフィルタリングを容易にしデータクエリの実行時に評価できます大規模なメモリ内データセットを使う場合とは対照的です Tripsでフィルタを使う方法をいくつか説明します Tripsアプリに検索バーを追加する場合 searchTextでクエリのフィルタリングや取得用の述語を構築できます
述語の構築は簡単です指定されたsearchTextを取得し旅行名にそのテキストが含まれているか確認しますただしテキストは旅行名以外に適用される場合があります
そこで複合述語を構築して旅行のdestinationプロパティも確認しますこれで複合述語は完成しましたが述語では他にも様々なことを行えます
iOS 18で導入された Foundationの新しい #Expressionマクロを使うと複雑な述語を簡単に構築できます
Expressionは trueやfalseを生成しない参照値を許可し代わりに任意の型を許可します
Expressionではモデルのプロパティを使って複雑な評価を表すことができます述語内に組み込むとクエリの結果をさらにカスタマイズできます
Tripsアプリでクエリを作成してまだ訪れていない場所がある進行中の旅行を取得しましょうこれらは isInPlanプロパティがまだfalseである旅行の BucketListItemでモデル化されますまず述語を構築します
この述語で旅行が継続中であることを指定しますつまり現在の日付は開始日と終了日の間です
ただし旅行のBucketListItemの少なくとも1つでisInPlanプロパティが falseであることを指定する必要があります述語だけではこれを表現できませんなぜなら計画外のBucketListItemの数をカウントするプロパティがないからですそこでこのロジックを述語に組み込む式を作ります
この式はまだ計画していない BucketListItemの数をカウントしますこれはBucketListItemの配列を受け取りフィルタ条件を満たす項目の数を返します
これで指定された旅行の BucketListItemを使って述語の一部としてこの式を評価できますさらにこの述語では式の結果が 0より大きいかどうかをチェックできます Expressionを使うと述語マクロがクエリを記述するためのより強力で優れたツールとなりアプリに必要なデータを効果的に取得できます実はクエリのパフォーマンスを向上させるもう1つの方法があります新しいスキーママクロ #Indexを使う方法です #Indexはモデルに1つのインデックスまたは複合インデックスを作成する機能を追加しますインデックスは本の目次のような追加のメタデータを表しますこのメタデータはSwiftDataが生成してコンテナに保存しますこのメタデータを使うと指定されたキーパスに対するクエリが高速で効率的になります
このメリットを得るにはどのプロパティにSwiftDataがインデックスを作成するかを宣言しますクエリの並べ替えやフィルタリングで最も頻繁に使用するプロパティについて考えます
Tripsアプリの場合旅行のクエリで名前開始日終了日のプロパティを使ったフィルタリングや並べ替えが頻繁に行われますこのクエリを高速にするには #Indexマクロを追加し名前開始日終了日のキーパスとこれら3つの複合インデックスを指定します旅行の詳細な検討内容のような大規模データセットの場合この方法でフィルタリングと並べ替えが大幅に高速になります述語マクロを使うことで SwiftUIでのクエリの使い勝手が向上し Expressionを使うことでより強力になります #Indexマクロを使うとアプリ内でクエリのパフォーマンスを一層向上させることができます
SwiftDataのパワーを使ってアプリのモデルレイヤを構築しましょう #Unique制約をスキーマに追加してモデルの重複回避を容易にしましょう新しい#Indexマクロを追加してクエリを高速化し
新しい履歴APIでアプリのモデルに対する変更を追跡できますカスタムデータストアを使うと独自のドキュメント形式または永続性バックエンドにより SwiftDataのパワーを活用できます
ご視聴ありがとうございました皆さんが作り上げる素晴らしいアプリを楽しみにしています

1:32 - SampleTrips models decorated with @Model

// Trip Models decorated with @Model
import Foundation
import SwiftData

@Model
class Trip {
    var name: String
    var destination: String
    var startDate: Date
    var endDate: Date
    
    var bucketList: [BucketListItem] = [BucketListItem]()
    var livingAccommodation: LivingAccommodation?
}

@Model
class BucketListItem {...}

@Model
class LivingAccommodation {...}

1:43 - SampleTrips using modelContainer scene modifier

// Trip App using modelContainer Scene modifier
import SwiftUI
import SwiftData

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

1:53 - SampleTrips using @Query

// Trip App using @Query
import SwiftUI
import SwiftData

struct ContentView: View {
    @Query
    var trips: [Trip]
    var body: some View {
        NavigationSplitView {
            List(selection: $selection) {
                ForEach(trips) { trip in
                    TripListItem(trip: trip)
                }
            }
        }
    }
}

2:16 - SampleTrips models decorated with @Model

// Trip Models decorated with @Model
import Foundation
import SwiftData

@Model
class Trip {
    var name: String
    var destination: String
    var startDate: Date
    var endDate: Date

    var bucketList: [BucketListItem] = [BucketListItem]()
    var livingAccommodation: LivingAccommodation?
}

@Model
class BucketListItem {...}

@Model
class LivingAccommodation {...}

3:08 - Add unique constraints to avoid duplication

// Add unique constraints to avoid duplication
import SwiftData

@Model 
class Trip {
    #Unique<Trip>([\.name, \.startDate, \.endDate])
    
    var name: String
    var destination: String
    var startDate: Date
    var endDate: Date
    
    var bucketList: [BucketListItem] = [BucketListItem]()
    var livingAccommodation: LivingAccommodation?
}

3:36 - Add .preserveValueOnDeletion to capture unique columns

// Add .preserveValueOnDeletion to capture unique columns
import SwiftData

@Model 
class Trip {
    #Unique<Trip>([\.name, \.startDate, \.endDate])
    
    @Attribute(.preserveValueOnDeletion)
    var name: String
    var destination: String

    @Attribute(.preserveValueOnDeletion)
    var startDate: Date

    @Attribute(.preserveValueOnDeletion)
    var endDate: Date
    
    var bucketList: [BucketListItem] = [BucketListItem]()
    var livingAccommodation: LivingAccommodation?
}

4:35 - SampleTrips using modelContainer scene modifier

// Trip App using modelContainer Scene modifier
import SwiftUI
import SwiftData

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

4:52 - Customize a model container in the app

// Customize a model container in the app
import SwiftUI
import SwiftData

@main
struct TripsApp: App {   
    var body: some Scene {
        WindowGroup {
            ContentView()
        }
        .modelContainer(for: Trip.self,
                        inMemory: true,
                        isAutosaveEnabled: true,
                        isUndoEnabled: true)
   }
}

5:13 - Add a model container to the app

// Add a model container to the app
import SwiftUI
import SwiftData

@main
struct TripsApp: App {
    var container: ModelContainer = {
        do {
            let configuration = ModelConfiguration(schema: Schema([Trip.self]), url: fileURL)
            return try ModelContainer(for: Trip.self, configurations: configuration)
        }
        catch { ... }
    }()
    
   var body: some Scene {
        WindowGroup {
            ContentView()
        }
        .modelContainer(container)
   }
}

5:59 - Use your own custom data store

// Use your own custom data store
import SwiftUI
import SwiftData

@main
struct TripsApp: App {
    var container: ModelContainer = {
        do {
            let configuration = JSONStoreConfiguration(schema: Schema([Trip.self]), url: jsonFileURL)
            return try ModelContainer(for: Trip.self, configurations: configuration)
        }
        catch { ... }
    }()
    
   var body: some Scene {
        WindowGroup {
            ContentView()
        }
        .modelContainer(container)
   }
}

6:58 - Make preview data using traits

// Make preview data using traits

struct SampleData: PreviewModifier {
    static func makeSharedContext() throws -> ModelContainer {
        let config = ModelConfiguration(isStoredInMemoryOnly: true)
        let container = try ModelContainer(for: Trip.self, configurations: config)
        Trip.makeSampleTrips(in: container)
        return container
    }
    
    func body(content: Content, context: ModelContainer) -> some View {
        content.modelContainer(context)
    }
}

extension PreviewTrait where T == Preview.ViewTraits {
    @MainActor static var sampleData: Self = .modifier(SampleData())
}

8:15 - Use sample data in a preview

// Use sample data in a preview

import SwiftUI
import SwiftData

struct ContentView: View {
    @Query
    var trips: [Trip]

    var body: some View {
        ...
    }
}

#Preview(traits: .sampleData) {
    ContentView()
}

8:50 - Create a preview query using @Previewable

// Create a preview query using @Previewable

import SwiftUI
import SwiftData

#Preview(traits: .sampleData) {
    @Previewable @Query var trips: [Trip]
    BucketListItemView(trip: trips.first)
}

9:55 - Create a predicate to find a Trip based on search text

// Create a Predicate to find a Trip based on Search Text

let predicate = #Predicate<Trip> {
    searchText.isEmpty ? true : $0.name.localizedStandardContains(searchText)
}

10:06 - Create a Compound Predicate to find a Trip based on Search Text

// Create a Compound Predicate to find a Trip based on Search Text

let predicate = #Predicate<Trip> {
    searchText.isEmpty ? true :
    $0.name.localizedStandardContains(searchText) ||
    $0.destination.localizedStandardContains(searchText)
}

10:46 - Build a predicate to find Trips with BucketListItems that are not in the plan

// Build a predicate to find Trips with BucketListItems that are not in the plan

let unplannedItemsExpression = #Expression<[BucketListItem], Int> { items in
    items.filter {
        !$0.isInPlan
    }.count
}

let today = Date.now
let tripsWithUnplannedItems = #Predicate<Trip>{ trip
    // The current date falls within the trip
    (trip.startDate ..< trip.endDate).contains(today) &&

    // The trip has at least one BucketListItem
    // where 'isInPlan' is false
    unplannedItemsExpression.evaluate(trip.bucketList) > 0
}

12:41 - Add Index for commonly used KeyPaths or combination of KeyPaths

// Add Index for commonly used KeyPaths or combination of KeyPaths
import SwiftData

@Model 
class Trip {
    #Unique<Trip>([\.name, \.startDate, \.endDate
    #Index<Trip>([\.name], [\.startDate], [\.endDate], [\.name, \.startDate, \.endDate])

    var name: String
    var destination: String
    var startDate: Date
    var endDate: Date
    
    var bucketList: [BucketListItem] = [BucketListItem
    var livingAccommodation: LivingAccommodation
}

関連する章

リソース

関連ビデオ

WWDC24

WWDC23