SwiftDataについて

SwiftDataはSwiftのために作られた、パワフルで表現豊かな永続性のあるフレームワークです。Swiftコードから直接得たデータをモデル化したり、SwiftDataをモデルに活用したりSwiftUIに統合したりする方法について解説します。

リソース

関連ビデオ

WWDC23

ダウンロード

♪ ♪

どうも Ben TrumbullですみなさんにSwiftDataをご紹介します

SwiftDataはデータモデルと管理のためのパワフルなフレームワークで現代のSwiftアプリを向上させます SwiftUI同様外部ファイル形式がなくコードだけに集中しシームレスなAPI体験の作成に新しいマクロシステムを使用しています

SwiftDataはシームレスな API体験のために Swift language macrosによる表現性に頼りますまたSwiftUIと自然的に統合し CloudKitやWidgetsなどの機能ともうまく作動しますここでは@Model macroとSwiftコードからのデータを直接モデルにできる機能についてお話しします SwiftDataでのデータのfetchと修正についてご紹介し SwiftDataとシームレスに動くほかのフレームワークの概要をみなさんに説明して締めくくりたいと思いますまずは@Modelからです @Modelは新しいSwift macroで Swif codeからのmodel schemaを定義します SwiftData schemaは普通のSwift codeですが必要ならmetadataでpropertiesにアノテーションをつけることができますこのschemaでSwiftDataはモデルにパワフルな機能性を足すことができます Classに@Modelを飾るだけで schema生成されます SwiftDataのモデルはアプリのschemaの源で持続性のある体験を可能にします classの格納型プロパティを永続型プロパティに変えるのですモデルに@Modelを足せば可能性が広がります SwiftDataは値型プロパティを属性としてすぐ使えるようネイティブに適合しますこれらのプロパティはstringやint floatのようなbasic value typesを含みますまたstructsやenumsのような complex value typesや collectionsのような codable typesも含みます SwiftDataはreference typesを relationshipsとしてモデル化し relationshipsと数々のmodel typesで model types間にリレーションシップを作ることもできます @Modelはすべての格納型プロパティをあなたの型で変換しますプロパティのmetadataで SwiftDataがどうschemaを作るかに影響します @Attributeで一意性制約を追加できます @Relationshipで inversesの選択をコントロールし delete propagation rulesを特定しますこれらはモデル間のリレーションシップのビヘイビアを変えます Transient macroでSwiftDataに特定のプロパティを含まないよう指定できますこれは以前のTripの例です格納型プロパティにmetadataを足して SwiftDataの schema generationを調整します

nameに@Attributeを足し一意であるべきと定義しまたbucket listを@Relationshipで装飾しこのtripが削除されれば関連するすべてのbucket listを削除するようSwiftDataに指示します SwiftData modelingについては「Model your schema with SwiftData」をご覧くださいではあなたのmodel typesと operationを動かす 2つのkey objectsをどのように使うかお話ししましょう SwiftDataのModelContainerと ModelContextです Model containerはmodel typesの持続的バックエンドを提供しますデフォルト設定のままschemaを指定するか configurationsとmigration optionsでカスタマイズできます保存したいmodel typesのリストを指定するだけで model containerを作成できますさらにカスタマイズしたいなら configurationでURLや CloudKitやgroup container identifiers migration optionsを変えます Containerが用意できmodel contextsでデータをfetchしsaveしますまたcontainerの設定にSwiftUIのviewと scene modifiersを使ってviewの環境で自動的に依存を確立します Model contextsはmodelsへの変化を観察し実行するactionsを提供しますアップデートを探知しデータをfetchし変更をsaveしそれらの変更を元に戻すインターフェイスなのです SwiftUIではたいてい model containerを作った後 viewの環境から modelContextを得るものです View階層の外でmodel containerに shared main actor bound contextを与えるよう指示しますそれか単にそのmodel containerに新しいcontextsを例示することもできます Contextが手に入ればdataをfetchできます SwiftDataはpredicateや fetch descriptotのような新しいSwift native typesからメリットを得られ

iOS 17では predicateがnative Swift typesと働き厳密に型指定されたconstructionに Swift macrosを使用しますこれは型チェックされた NSPredicateの現代的な取り替えものです AutocompleteのようにXcodeのサポートで predicatesを実行するのも簡単ですこれはSample Tripアプリの predicatesを作る例の一つですまずニューヨークが行き先のトリップをすべて指定できます Queryをbirthdayだけに狭めることもでき過去の旅行ではなく将来のトリップだけに興味があると指定することもできますどのトリップをfetchするか決まったら FetchDescriptor typeを使って ModelContextにそれらのトリップを fetchするよう指示します FetchDescriptorと共に働く Swift SortDescriptorには native Swift typesと keypathsサポートが足されますそのSortDescriptorを使って fetchされたトリップをどのように整理したいか指示します FetchDescriptorはSwiftData queriesにさまざまな形で答えられます Predicatesとsortingに加え関連するものをあらかじめfetchさせたり結果を限定したり保存されていない変更を除外するなどできますまたSwiftDataは ModelContextに作業させることでデータの作成や削除そして変更が簡単になりますほかのSwift classes同様 model objectsを作ったあと contectに挿し込み change trackingやpersistenceなど SwiftData機能を使えます Persistent objectsの削除は ModelContextに削除の印付けを指示するのと同様に簡単ですまたこのような未実行の変更を ModelContextにpersistent containerへ保存とコミットを指示し保存することができます Model objectsの property valuesを変えるのは property settersを普通に使うように簡単です Model macroが格納型プロパティを変更し ModelContextが自動的に変更を記録する手助けをし次の保存作業に含めます SwiftData containersとcontexts 及びその作業については「Dive Deeper into SwiftData」をご覧ください SwiftDataはSwiftUIを念頭にデザインされ一緒に使うのは簡単です SwiftUIはSwiftDataを使い始めるのに最も簡単な方法です SwiftData containerの設定であれデータのfetchであれ viewのアップデートであれこれらのフレームワークに直接統合してAPIsを作成します SwiftUI sceneとview modifiersは SwiftDataアプリを最も簡単に作成できる方法です SwiftUIでデータの保存を設定できオプションの変更やundoや autosavingを可能にできます SwiftUIはその環境内で model contextを広く使うことができます設定が済めば @Query property wrapperで簡単に始められますわずか一行のコードでデータベースに保存されたものを呼び出しフィルターできます SwiftDataはObservable機能を modeled propertiesに使用できます SwiftUIはobserved propertiesを自動的に更新します SwiftUIとSwiftDataは一緒になって魅力のあるパワフルなアプリ作成の助けとなりますこれらのフレームワークを一緒に使うことについては「Build an app with SwiftData」をご覧ください

SwiftDataはデータ管理のパワフルで新しい解決策で Swiftの機能をサポートするようデザインされていますあなたのコードだけに集中するため Swiftの新しいMacro systemを使用します @modelを使ってschemaを設定し model containerで persistence experienceを設定します簡単にpersistenceにundoやredo iCloud synchronizationにウィジェット開発などが行えます SwiftUIのシームレスな統合を利用して SwiftDataをアプリに今すぐ取り込みましょうみなさんが何を作るか楽しみですありがとうございました ♪ ♪

1:27 - Adding @Model to Trip

import SwiftData

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

2:46 - Providing options for @Attribute and @Relationship

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

3:43 - Initialize a ModelContainer

// Initialize with only a schema
let container = try ModelContainer([Trip.self, LivingAccommodation.self])

// Initialize with configurations
let container = try ModelContainer(
    for: [Trip.self, LivingAccommodation.self],
    configurations: ModelConfiguration(url: URL("path"))
)

3:58 - Creating a model container in SwiftUI

import SwiftUI

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

4:20 - Accessing the environment's ModelContext

import SwiftUI

struct ContextView : View {
    @Environment(\.modelContext) private var context
}

5:13 - Building a predicate

let today = Date()
let tripPredicate = #Predicate<Trip> { 
    $0.destination == "New York" &&
    $0.name.contains("birthday") &&
    $0.startDate > today
}

5:32 - Fetching with a FetchDescriptor

let descriptor = FetchDescriptor<Trip>(predicate: tripPredicate)

let trips = try context.fetch(descriptor)

5:46 - Fetching with fetch and sort descriptors

let descriptor = FetchDescriptor<Trip>(
    sortBy: SortDescriptor(\Trip.name),
    predicate: tripPredicate
)

let trips = try context.fetch(descriptor)

6:15 - Working with a ModelContext

var myTrip = Trip(name: "Birthday Trip", destination: "New York")

// Insert a new trip
context.insert(myTrip)

// Delete an existing trip
context.delete(myTrip)

// Manually save changes to the context
try context.save()

7:38 - Using @Query in SwiftUI

import SwiftUI

struct ContentView: View  {
    @Query(sort: \.startDate, order: .reverse) var trips: [Trip]
    @Environment(\.modelContext) var modelContext
    
    var body: some View {
       NavigationStack() {
          List {
             ForEach(trips) { trip in 
                 // ...
             }
          }
       }
    }
}

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

SwiftDataについて

関連する章

リソース

関連ビデオ

WWDC23