Core Dataの新機能

Core Dataの新機能

Core Dataの改善によって、アプリのデータ永続性を改善させましょう。複合属性を使用して、より直感的なデータモデルを作成する方法について学びましょう。また、大幅な変更を伴うスキーマの移行方法、負荷のかかる移行のタイミングを遅らせたり、およびユーザーのデバイスに対する負荷を避ける方法も紹介します。このセッションを最大限に活用するためには、Core Dataで異なるデータ型を扱う方法と、軽量マイグレーションの基本を理解していることが望ましいです。

関連する章
- 0:00 - Intro
- 0:56 - Composite attributes
- 6:31 - Stage your migrations
- 18:23 - Defer your migrations
- 22:33 - Wrap-up
リソース
関連ビデオ

WWDC22
- Core Dataスキーマを進化させる
♪ ♪
David：「Core Dataの新機能」へようこそ私 David Stitesは Core Dataチームのエンジニアですこのセッションではアプリ内の Core Dataデータモデルをより迅速かつ簡単に設計クエリ更新および移行する際に役立つ Core Dataの新技術を学びます
まずアプリのモデルで構造化データを整理する優れた新方法である複合属性についてお話しします次に軽量なマイグレーションを使用するために最も複雑なモデルマイグレーションを段階的なものに変える方法をお伝えします最後にアプリの応答性を保つためにモデルの移行を延期する方法についてお話しします複合属性は新しいタイプの属性です
複合属性によって単一の属性内に複雑なカスタムデータ型のカプセル化が可能になります
各複合属性は String Float Int Dataなどすでにお馴染みの組み込みCore Data型の属性で構成されます
複合属性は最上位の複合属性がさらに複合属性を含むように互いに入れ子にすることができます
Xcode Core Dataモデルエディタはモデルの複合属性の定義と管理を容易にするため更新されました
複合属性は耐久性のあるカスタムデータ型を作成するために変換可能な型属性を使用するための説得力のある代替手段です属性の値を変換するコードを書く必要はありません変換可能な属性とは異なり複合属性は複合属性の名前空間付きキーパスで構成されたNSPredicatesを持つ NSFetchRequestsを許可します
複合属性はフラット化された属性の拡張をカプセル化するために使用することができ保守性と可読性の向上につながります
複合属性はアプリのパフォーマンス向上にも使用できますデータモデルがあるエンティティを取得することでほかのエンティティへの関連アクセスが生じるように構成されている場合その関連をコンポジット属性を使用してリファクタリングすることができます複合属性を最初のエンティティに埋め込むことによりリレーションシップを越えたオブジェクトの不具合を防ぐことができます
複合属性クラスは NSComposite AttributeDescription です NSCompositeAttribute Descriptionの属性タイプは NSCompositeAttributeTypeです
NSComposite AttributeDescriptionクラスは NSAttributeDescriptionまたはほかの入れ子になった NSCompositeAttribute Descriptionの配列要素を含みます
要素配列は NSRelationship Descriptionのようなほかのタイプのプロパティ記述を含むことはできません無効な要素を設定しようとするとNSInvalid ArgumentExceptionが発生します
複合属性の実装方法についてコードを使って説明します
この基本的なデータモデルを航空機のエンティティで考えてみましょう多くの属性を有し中でもcolors属性は変形可能なタイプですそのタイプのトランスフォーマーは航空機のprimary secondary tertiaryの色を記述する文字列を格納し解析します
このエンティティを改良するために colors属性を colorSchemeという複合属性に置き換えて航空機の塗装色を保存します
colorSchemeは次の要素を持つ複合属性です primary secondary tertiaryはそれぞれString属性です
Xcodeで飛行時間を記録するために使用しているアプリのプロジェクトを開きます
このアプリのデータモデルには先ほど説明した Aircraftエンティティとその他のエンティティがいくつか設定されています
変換を始めるために Core Dataモデルエディタで colorSchemeという新しい複合属性を追加します
そのコンポジット内にprimary secondary tertiaryの 3つの文字列属性を追加しています
Aircraftエンティティに composite属性を追加しその属性のタイプを colorSchemeに設定します
モデル内の作業は完了したのでコードを更新する番です
Aircraftの実装では @NSManaged var colorSchemeという新しいプロパティを追加していますコード全体でこの複合属性を使用しているため属性名をキーとして辞書記法で値にアクセスしています primar secondary tertiaryという文字列のキーを使用して航空機の colorScheme属性を設定しています
同様に、NSFetchRequestを NSPredicateで構成すると複合属性の要素は名前空間付きキーパスを介してアクセスされます
ここではcolorScheme.primaryでその属性をフィルタリングしています
アプリケーションが進化するにつれてデータモデル変更を要する可能性があります
データモデルを更新するにはその変更を基礎となるストレージスキーマに具体化する必要があります
モデルにnumPassengers属性が追加された場合対応するストレージを更新する必要があります
スキーマの変更を行うプロセスをマイグレーションと呼びます
マイグレーション後変更は基礎となるストレージに完全に反映されます
Core Dataにはアプリケーションのデータストレージを最新データモデルに保つためのマイグレーションツールセットが組み込まれていますこれらのツールを総称して「軽量マイグレーション」と呼びます
軽量なマイグレーションについては WWDC 2022の「Evolve your app's schema」をご覧ください
データモデルへの複合的な変更が軽量マイグレーションの能力を超えることもありますこの問題の解決策は段階的な移行です
段階的移行用のAPIはいくつかの目標を念頭に置いて設計されています軽量のスキーマ変更に適合しない複雑なデータモデルの移行を支援し移行と移行インフラストラクチャに関連する数千行のコードを削除する可能性があるためアプリケーションを簡素化できますまた移行プロセス中にアプリが実行状態をコントロールできるためさまざまな他のタスクを実行する機会を提供します
このAPIを使用するにはいくつかステップを踏む必要がありますまずモデルの変更が軽量マイグレーションでサポートできない規模であることを判断します軽量マイグレーションに合っていないモデル変更を軽量マイグレーションで実行できる程度のモデル変更の規模に分解します新しい段階的移行の API を使用した NSManagedObjectModelの Core Dataへの完全な順序付けについて説明します Core Dataがイベントループを実行し未処理の各モデルを直列順序で繰り返し処理しストアをマイグレーションしますマイグレーション中の特定の時点で実行制御があなたのアプリケーションに与えられ移行に関連する必要なタスクが実行されます
軽量マイグレーションで対応できるモデル変更かを判断するにはいくつかの選択肢があります最初の選択肢はスキーマの変更を手作業で確認し各変更が軽量移行の対象であることを確認するものです
2つ目の選択肢は新しいモデルと軽量マイグレーションオプションである NSMigratePersistentStores AutomaticallyOption および NSInferMappingModel AutomaticallyOptionをtrueに設定して永続ストアを開くことです変更が軽量マイグレーションの対象でない場合は NSPersistentStore Incompatible VersionHashErrorが発生します
最後の選択肢はNSMappingModel. inferredMappingModel (forSourceModel:destinationModel:)を使用することですこのメソッドは、もしCore Dataが実行できる場合、推論モデルを返します。そうでない場合はnilを返します
Aircraftモデルを再度考慮すると新属性である flightDataを有しておりバイナリ形式でデータを保存します
仮にこのモデルを非正規化しすべてのフライトデータを独自のエンティティタイプに分離する必要があり同時に既存のデータとそれが生成された航空機との関係を保持する場合を考えますこれは非常に複雑なモデルチェンジであり軽量マイグレーションの対象になりません段階的マイグレーションを使用するにはこれらの変更を分解する必要があります軽量でない変更を分解する場合目標は軽量マイグレーションの対象外のマイグレーションタスクを軽量マイグレーションの対象となる最小限の一連のマイグレーションに変換することです
複雑な変更を実現するために導入された各モデルは軽量マイグレーションの能力で対応可能なレベルで 1つ以上のオペレーションを持つことになりますその結果各モデルが軽量マイグレーション可能ですが複雑なマイグレーションと同等の結果をする一連のマイグレーションとなります
元のモデルにModelV1というラベルを付けました
このモデル移行はModelV2と ModelV3という2つの新しいモデルバージョンを導入することで分解できます
ModelV2ではAircraftエンティティは新作成のFlightDataエンティティのコレクションであるflightParameters リレーションシップを獲得します FlightData エンティティはバイナリ型の属性データと Aircraft との関係を持ちます既存データを保持するため移行ステージでデータを Aircraftエンティティから新しいFlightDataエンティティにコピーしてAircraftに関連付けます
最終的なモデルは ModelV2から作られたModelV3です ModelV3では Aircraftエンティティから古いflightData属性が削除されモデルの非正規化に成功し既存のデータはすべて保持されます説明した各ステップは軽量マイグレーションの能力の範囲内です
モデルの全体的な順序を記述するために Core Dataフレームワークレベルのサポートは以下のクラスで構成されます NSStagedMigrationManager NSCustomMigrationStage NSLightweightMigrationStage および NSManagedObject ModelReferenceです
NSStagedMigrationManager クラスは NSCustomMigrationStageとあなたが記述したNSLightweight MigrationStageの補足の合計順序をカプセル化します段階的移行マネージャーは移行イベントループも管理し NSPersistentContainerを介して移行ストアへのアクセスも提供しますマネージャーをストアオプションに追加する際は NSPersistentStoreStaged MigrationManagerOptionKeyを使います
移行ステージはモデルのバージョン間の移行の基礎を形成します
段階的移行を採用する場合 NSCustomMigrationStageまたは NSLightweight MigrationStageを使用して各モデルのバージョンを Core Dataに記述します NSLightweight MigrationStageクラスは分解を必要とせず軽量マイグレーションが可能な一連のモデルを記述しますこれはおそらくあなたのモデルの大部分を占めるでしょうこれらの軽量な移行ステージはコアデータに記述された― モデルの総順序を補足するために使用されますすべての軽量モデルのバージョンは 1つ以上の NSLightweightMigrationStageで表現する必要があります
作成したモデルの各分解バージョンは NSCustomMigrationStag を使って表現されソースおよびデスティネーションモデルリファレンスを含みます
NSCustomMigrationStageは移行ステージの直前と直後に実行されるオプションのハンドラを提供しますこれらのハンドラーは移行処理中にカスタムコードを実行する機能を提供します
段階的移行はNSManagedObjectModel Reference クラスを使用しますこのクラスは NSManagedObject Modelの実行計画を表します移行中 Core Dataがこの実行を果たします NSManagedObjectModel Referenceは柔軟性がありさまざまな方法で作成ができます
すべての NSManagedObject ModelReferenceを初期化する必要がありますこれによりモデルが不注意に変更されていないことを確認しますチェックサムの取得には NSManagedObjectModel .versionChecksumメソッドを使います
あるいは Xcode のビルドログの「Compile data model」からバージョンチェックサムを取得することもできます「version checksum」という文字列を検索するのです
バージョン管理されたモデルの場合チェックサムは NSManagedObjectModelバンドルの VersionInfo.plistでも利用可能です
例に戻って段階的移行を使い始めるために 3つのモデルそれぞれにモデル参照を作成することから始めます私はモデル名とバンドルリファレンスを受け取るイニシャライザを使用していますがほかの選択肢もあります
次のステップは必要な移行段階を説明することです最初のステージでは flightData属性が追加されただけなので属性の追加は軽量な変更であるため軽量なステージで表すことができます
しかし、次の段階はカスタムステージになりますモデルの変更が2つのモデルのバージョンに分解されたため既存のデータを保持するためにカスタムコードを実行する必要がありますカスタム移行ステージはModelV2と ModelV3で初期化されます
willMigrateHandlerでは flightDataが nilでないエンティティ行をフェッチしています汎用 NSManagedObjectおよび NSFetchRequestResult型は Aircraft管理オブジェクトのサブクラス代わりに使われています移行中にAircraftクラスが期待通りに存在しない可能性があるためです
フェッチされた AircraftエンティティごとにデータはFlightDataの新しいインスタンスにコピーされ 2つのエンティティは関連付けられ永続化されますこの移行ステージの実行が終了するとストアのスキーマは最新のモデルに更新され既存のデータは保持されます
段階的移行を完了するため軽量な移行ステージとカスタム移行ステージを持つNSStaged MigrationManagerを作成します
NSStagedMigrationManagerは NSPersistentStore Staged MigrationManagerOptionKeyを持つ NSPersistentStoreDescription オプションに追加されます
そのあと永続ストアがロードされて移行プロセスが開始しストアスキーマに影響を与えます以上です Core Dataは自動的に必要なステージを適用しストアスキーマを移行します
軽量移行の中にはアプリケーションがフォアグラウンドで提供できないような追加のランタイムを必要とするものがあります
軽量移行でユーザーデータを変換するプロセスは即座に完了するものではありません例えばあるカラムから別のカラムへまたはあるテーブルから別のテーブルへデータをコピーするような移行であれば時間がかかるかもしれません
特に起動時に移行が行われる場合じれったいようなユーザーエクスペリエンスにつながる可能性があります
移行延期はこの問題の解決に役立ちますこのAPIを使えば軽量移行中に行われる作業の一部を延期し延期した作業を後日完了させることができます軽量移行中エンティティにインデックスを更新したりテーブルコピーを実行したあとに列を削除したりするなどクリーンアップが必要なマイグレーション変換がある場合このテーブル変換はテーブル変換を実行するためのリソースが利用可能と判断されるまで延期することができます軽量マイグレーションは依然として同期的で正常に行われますスキーマのクリーンアップだけが延期されますアプリケーションは通常通り最新のスキーマを使用します Deferredマイグレーションを選択する際は NSPersistentStoreDeferred LightweightMigrationOptionKeyをストアオプションでtrueに設定します
DeferredマイグレーションAPIは macOS Big Surと SurとiOS 14までさかのぼりランタイム互換性があります
Deferredマイグレーションは SQLiteストアタイプでのみ利用可能です
Deferredマイグレーションが有用な例をいくつか挙げてみますエンティティからの属性やリレーションシップの削除エンティティ階層が存在しなくなったリレーションシップの変更リレーションシップを順序付きから非順序付きに変更する
延期した移行タスクを終了するには永続ストアのメタデータを確認します NSPersistentStore DeferredLight weightMigrationOptionKeyが含まれている場合は完了すべきマイグレーション作業が遅延していることを示しています Deferredマイグレーションは NSPersistentStoreCoordinator.finishDeferredLightweightMigrationを呼び出すと処理できます
アプリケーションで軽量マイグレーションを延期するにはコーディネータに永続ストアを追加する際にストアオプションで NSPersistentStoreDeferredLightweight MigrationOptionKeyをTrueに設定します
Deferredマイグレーションを終了する適切なタイミングになるとストアのメタデータをチェックすることで保留中の延期作業の有無を確認できます NSPersistentStoreDeferred LightweightMigrationOptionKeyが true設定の場合はfinishDeferred LightweightMigration()を呼び出します
Deferredマイグレーションのタスクをスケジュールするには Background Tasks APIの使用を検討してください BGProcessingTaskは長時間のデータ更新やアプリケーションのメンテナンスなど時間のかかる操作のためのものですタスクの実行に最適な時間をシステムが判断しますしかし一般的に処理タスクはデバイスがアイドル状態の時にのみ実行されユーザーがデバイスを使い始めるとバックグラウンド処理タスクは終了します
Deferredおよび段階的移行は組み合わせることができます時間を要するような複雑な移行がある場合は両APIの機能を利用するステージの設計を検討してください例のモデルに戻ると ModelV3で flightData属性を削除する場合これは良いDeferredマイグレーションの候補になるかもしれません
Core Dataには 3つの素晴らしい新技術がありますコンポジット属性を使用してネスト可能で構造化された方法でカスタムデータ型をカプセル化しモデルの変更を分解して段階的移行を使用し複雑なモデル移行を実行し Deferredマイグレーションを使用して一部の移行作業を遅延させることでアプリケーションのパフォーマンスを向上させます 3つのテクノロジーはすべて調和して機能しアプリケーションを改善します
私たちのチームは皆さんがこの新技術をどのように使用するか楽しみですご視聴ありがとうございます引き続き WWDCをお楽しみください ♪ ♪

enum PaintColor: String, CaseIterable, Identifiable {
    case none, white, blue, orange, red, gray, green, gold, yellow, black
    var id: Self { self }
}

extension Aircraft {

    @nonobjc public class func fetchRequest() -> NSFetchRequest<Aircraft> {
        return NSFetchRequest<Aircraft>(entityName: "Aircraft")
    }

    @NSManaged public var aircraftCategory: String?
    @NSManaged public var aircraftClass: String?
    @NSManaged public var aircraftType: String?
    @NSManaged public var colorScheme: [String: Any]?
    @NSManaged public var photo: Data?
    @NSManaged public var tailNumber: String?
    @NSManaged public var logEntries: NSSet?

}

5:53 - Setting a composite attribute

private func addAircraft() {
    viewContext.performAndWait {
        let newAircraft = Aircraft(context: viewContext)
        
        newAircraft.tailNumber = tailNumber
        newAircraft.aircraftType = aircraftType
        newAircraft.aircraftClass = aircraftClass
        newAircraft.aircraftCategory = aircraftCategory
        
        newAircraft.colorScheme = [
            "primary": primaryColor.rawValue,
            "secondary": secondaryColor.rawValue,
            "tertiary": tertiaryColor.rawValue
        ]
        
        do {
            try viewContext.save()
        } catch {
            // ...
        }
    }
}

6:11 - Fetching a composite attribute

private func findAircraft(with color: String) {
    viewContext.performAndWait {
        let fetchRequest = Aircraft.fetchRequest()
        fetchRequest.predicate = NSPredicate(format: "colorScheme.primary == %@", color)
        
        do {
            var fetchedResults: [Aircraft]
            fetchedResults = try viewContext.fetch(fetchRequest)
            
            // ...
        } catch {
            // Handle any errors that may occur
        }
    }
}

16:00 - Creating managed object model references for staged migration

let v1ModelChecksum = "kk8XL4OkE7gYLFHTrH6W+EhTw8w14uq1klkVRPiuiAk="
let v1ModelReference = NSManagedObjectModelReference(
    modelName: "modelV1"
    in: NSBundle.mainBundle
    versionChecksum: v1ModelChecksum
)

let v2ModelChecksum = "PA0Gbxs46liWKg7/aZMCBtu9vVIF6MlskbhhjrCd7ms="
let v2ModelReference = NSManagedObjectModelReference(
    modelName: "modelV2"                          
    in: NSBundle.mainBundle                                                 
    versionChecksum: v2ModelChecksum
)

let v3ModelChecksum = "iWKg7bxs46g7liWkk8XL4OkE7gYL/FHTrH6WF23Jhhs="
let v3ModelReference = NSManagedObjectModelReference(
    modelName: "modelV3"
    in: NSBundle.mainBundle
    versionChecksum: v3ModelChecksum
)

16:19 - Creating migration stages for staged migration

let lightweightStage = NSLightweightMigrationStage([v1ModelChecksum])
lightweightStage.label = "V1 to V2: Add flightData attribute"

let customStage = NSCustomMigrationStage(
    migratingFrom: v2ModelReference,
    to: v3ModelReference
)

customStage.label = "V2 to V3: Denormalize model with FlightData entity"

16:54 - willMigrationHandler and didMigrationHandler of NSCustomMigrationStage

customStage.willMigrateHandler = { migrationManager, currentStage in
    guard let container = migrationManager.container else {
        return
    }

    let context = container.newBackgroundContext()
    try context.performAndWait {
        let fetchRequest = NSFetchRequest<NSFetchRequestResult>(entityName: "Aircraft")
        fetchRequest.predicate = NSPredicate(format: "flightData != nil")
            
        do {
           var fetchedResults: [NSManagedObject]
           fetchedResults = try viewContext.fetch(fetchRequest)
           
           for airplane in fetchedResults {
                let fdEntity = NSEntityDescription.insertNewObject(
                    forEntityName: "FlightData,
                    into: context
                )
             
                let flightData = airplane.value(forKey: "flightData")
                fdEntity.setValue(flightData, forKey: “data”)
                fdEntity.setValue(airplane, forKey: "aircraft")
                airplane.setValue(nil, forKey: "flightData")
            }
            try context.save()
        } catch {
            // Handle any errors that may occur
        }
    }
}

17:41 - Loading the persistent stores with an NSStagedMigrationManager

let migrationStages = [lightweightStage, customStage]
let migrationManager = NSStagedMigrationManager(migrationStages)

let persistentContainer = NSPersistentContainer(
    path: "/path/to/store.sqlite",
    managedObjectModel: myModel
)

var storeDescription = persistentContainer?.persistentStoreDescriptions.first

storeDescription?.setOption(
    migrationManager,
    forKey: NSPersistentStoreStagedMigrationManagerOptionKey
)

persistentContainer?.loadPersistentStores { storeDescription, error in
    if let error = error {
        // Handle any errors that may occur
    }
}

21:01 - Adding a persistent store with NSPersistentStoreDeferredLightweightMigrationOptionKey option

let options = [
    NSPersistentStoreDeferredLightweightMigrationOptionKey: true,
    NSMigratePersistentStoresAutomaticallyOption: true,
    NSInferMappingModelAutomaticallyOption: true
]

let store = try coordinator.addPersistentStore(
    ofType: NSSQLiteStoreType,
    configurationName: nil,
    at: storeURL,
    options: options
)

21:17 - Executing deferred migrations

// After using BGProcessingTask to run migration work   
let metadata = coordinator.metadata(for: store)
if (metadata[NSPersistentStoreDeferredLightweightMigrationOptionKey] == true) {
    coordinator.finishDeferredLightweightMigration()
}

関連する章

リソース

関連ビデオ

WWDC22