Core Data 新功能

Core Data 新功能

通过 Core Data 的改进提高 App 数据的持久性。了解如何使用复合属性来创建更直观的数据模型。我们还将向你展示如何通过破坏性变化来迁移模式、何时推迟密集迁移以及如何避免个人设备上的开销。为了充分理解本期视频，你要熟悉如何处理 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 新功能” 我是 Core Data 团队的工程师 David Stites 在本次讲座中你将了解到 Core Data 中的新技术这些技术将帮助你更快更容易地设计查询更新和迁移 App 中的 Core Data 数据模型
我将首先介绍复合属性一种在你的 App 模型中整理结构化数据不错的新方法然后再谈谈如何 “分段式”的复杂模型迁移以便你可以使用轻量级迁移最后我将介绍如何延迟你的模型迁移以保持 App 的响应速度复合属性是一种新的属性类型
复合属性允许在单一属性中封装复杂和自定义的数据类型
每个复合属性都是由你已经熟悉的内置 Core Data 类型的属性组成的如 String、Float、Int 和 Data
复合属性可以相互嵌套因此顶级的复合属性可以包含额外的复合属性
Xcode Core Data 模型编辑器已经更新以便于定义和管理你的模型的复合属性
复合属性是使用 transformable 类型属性是创建持久的自定义数据类型的出色的替代方案不需要编写转换属性值的代码与 transformable 属性不同复合属性允许带有 NSPredicate 的 NSFetchRequest 它是用复合属性的命名空间的键路径配置的
复合属性可以用来封装大量的扁平化属性使代码更容易阅读、更易维护
复合属性可以用来提高 App 的性能如果你的数据模型的组成方式使获取一个实体总会导致访问与另一个实体的关系你可以使用复合属性来重构这种关系在第一个实体中嵌入复合属性的效果是它可以防止跨关系对象中出现失效
复合属性类是 NSCompositeAttributeDescription NSCompositeAttributeDescription 的属性类型是 NSCompositeAttributeType
NSCompositeAttributeDescription 类包含一个 elements 数组该数组由 NSAttributeDescription 类属性或其他嵌套的 NSCompositeAttributeDescription 类属性组成
elements 数组不能包含其他类型的属性描述如 NSRelationshipDescription 试图设置无效的 elements 会导致 NSInvalidArgumentException 异常
我将用一个演示向你描述如何采用复合属性
想象一个带有 Aircraft 实体的基本数据模型它有许多属性包括一个 transformable 类型的颜色属性该类型的转换器会存储并解析一个格式化的字符串描述 aircraft 的原色、次色和第三色
我将改进这个实体将颜色属性替换为一个复合属性 colorScheme 来存储 aircraft 的颜色
colorScheme 是包含 elements 的复合属性 primary、secondary 和 tertiary 这些都是 String 属性
在 Xcode 中我会打开一个项目一个用来跟踪飞行时间的 App
该 App 的数据模型配置了我刚才谈到的 Aircraft 实体及其他几个实体
为了开始转换在 Core Data 模型编辑器中我会添加一个名为 colorScheme 的新复合属性
在这个复合属性中我将添加三个 string 属性 primary、secondary 和 tertiary
在 Aircraft 实体中我会添加复合属性并将该属性的类型设置为 colorScheme
模型中的工作已经完成是时候更新代码了
在我的 Aircraft 实例中我会添加一个新的属性 @NSManaged var colorScheme 其类型是一个带有 String 键值和 Any 对象的字典因为我在代码中使用了这个复合属性所以我会使用字典表示法来访问值使用属性名作为键值在这里我通过使用 String 键值 primary、secondary 和 tertiary 来设置 aircraft 的 colorScheme 属性
同样当我用 NSPredicate 配置 NSFetchRequest 时复合属性的元素是通过命名空间的键路径访问的
这里 colorScheme.primary 被用来筛选该属性
随着 App 的发展可能需要改变数据模型
更新数据模型需要在底层存储模式中实现这些变化
如果将 numPassengers 属性新增至模型中则必须更新相应的存储
执行表结构变化的过程被称为迁移
迁移之后这些变化会全部反映在底层存储中
Core Data 有内置的迁移工具集帮助 App 的数据存储与当前的数据模型保持同步这些工具被统称为“轻量级迁移”
要了解更多关于轻量级迁移的信息请观看 WWDC 2022 中的 “Core Data 模式进化”
有时数据模型的综合变化超过了轻量级迁移的能力解决这个问题的方法是分段迁移
分段迁移 API 的设计有几个目标：帮助你迁移那些有无法适用轻量级模式变化的复杂数据模型有可能通过移除与迁移和迁移基础架构相关的大量代码来简化你的 App 以及为你的 App 提供在迁移过程中通过执行各种任务以获得执行控制的机会
要使用这个 API 你需要采取以下几个步骤：确定你的模型变化何时不符合轻量级迁移所支持的操作将不符合要求的模型变化分解为轻量级迁移所支持的一系列符合要求的模型变化使用新的分阶段迁移 API 向 Core Data 描述 NSManagedObjectModel 的全序关系让 Core Data 执行事件循环以串行顺序迭代每个未处理的模型完成存储迁移在迁移过程中的某些时刻执行控制让你的 App 可以执行任何与该迁移相关的必要任务
要确定你的模型何时有不符合要求的轻量级变化你有几个选择第一个选择是手动审查模式变化确保每个变化都符合轻量级迁移的条件
第二个选择是尝试设置新的模型和轻量级迁移选项 NSMigratePersistentStores AutomaticallyOption 和 NSInferMappingModelAutomaticallyOption 为 true 打开持久性存储如果这些变化不符合轻量级要求你会收到 NSPersistentStore IncompatibleVersionHashError
最后一个选择是使用 NSMappingModel.inferredMappingModel (forSourceModel:destinationModel:) 如果 Core Data 能够创建推断模型这个方法就会返回该模型否则它将返回 nil
再思考一下 Aircraft 模型它有一个新的属性 flightData 它以二进制格式存储数据
假设需要让这个模型非规范化并将所有的飞行数据分离到它自己的实体类型中同时还要保留所有的现有数据以及生成数据的 aircraft 的关系这是一个非常复杂的模型变化而且它本身不符合轻量级迁移的要求这些变化需要被分解以使用分阶段迁移在分解非轻量级变化时目标是将不符合轻量级迁移的迁移任务转化为符合轻量级迁移的最小系列的迁移
引入的每个模型都会有一个或多个操作这些操作都在轻量级迁移的能力范围内组成了不符合要求的变化结果是一系列的迁移其中每个模型都可进行轻量级迁移总体结果等同于不符合要求的迁移
回到这个例子我把原始模型标注为 ModelV1
这个模型迁移将通过引入两个新的模型版本 ModelV2 和 ModelV3 进行分解
在 ModelV2 中 Aircraft 实体获得了一个 flightParameters 关系它是一个新创建的 FlightData 实体的集合 FlightData 实体有二进制类型的属性数据和与 Aircraft 的关系为了保留现有的数据迁移阶段将把 Aircraft 实体的数据复制到新的 FlightData 实体中并把它们与 Aircraft 联系起来
我们的最终模型是由 ModelV2 创建的 ModelV3 在 ModelV3 中旧的 flightData 属性将被从 Aircraft 实体中删除该模型被成功地去规范化所有的现有数据被保留下来所描述的每个步骤都在轻量级迁移的能力范围内
为了描述模型的 total ordering Core Data 框架级别的支持应由以下类组成： NSStagedMigrationManager、 NSCustomMigrationStage、 NSLightweightMigrationStage 和 NSManagedObjectModelReference
NSStagedMigrationManager 类封装了由你描述的 NSCustomMigrationStage 和附属 NSLightweightMigrationStage 的全序关系分阶段迁移管理器还管理迁移事件循环并通过 NSPersistentContainer 提供对迁移存储空间的访问使用 NSPersistentStoreStagedMigrationManagerOptionKey 密钥该管理器被添加到存储选项中
迁移阶段构成了模型在不同版本之间迁移的基础
当你采用分阶段迁移时你将使用 NSCustomMigrationStage 或 NSLightweightMigrationStage 向 Core Data 描述每个模型版本 NSLightweightMigrationStage 类描述了一系列不需要分解的、符合轻量级迁移条件的模型你的大多数模型可能都属于此类这些轻量级迁移阶段被用于补充向 Core Data 描述的模型的全序关系所有的轻量级模型版本必须在一个或多个 NSLightweightMigrationStage 中表示
你创建的模型的各个分解版本将用一个 NSCustomMigrationStage 表示并包含源模型引用和目标模型引用
NSCustomMigrationStage 提供了可选的处理程序这些处理程序会在迁移阶段之前和之后立即运行这些处理程序让你可以在迁移过程中运行自定义代码
分阶段迁移使用了 NSManagedObjectModelReference 类这个类代表了 NSManagedObjectModel 的承诺在迁移过程中 Core Data 将履行这个承诺 NSManagedObjectModelReference 是灵活的可以以多种不同的方式创建
每个 NSManagedObjectModelReference 都需要用一个版本校验和来初始化这是为了验证模型没有在无意中更改该校验和可以通过 NSManagedObjectModel.versionChecksum 方法获得
另外你也可以从 Xcode 构建日志中的 “Compile data model” 中检索到版本校验搜索字符串“version checksum”
对于不同版本的模型校验和也可以在 NSManagedObjectModel 包中的 VersionInfo.plist 找到
回到例子中为了开始使用分阶段迁移首先我会为全部三个模型创建模型引用我使用的是接受模型名称和捆绑引用的初始化器不过也有其他选择
下一步是描述所需的迁移阶段由于第一阶段只添加了 flightData 属性它可以用一个轻量级阶段来表示因为添加属性是一个轻量级变化
下一个阶段是一个自定义阶段因为模型变化会被分解为两个模型版本我们需要运行自定义代码来保留现有数据自定义迁移阶段是用 ModelV2 和 ModelV3 初始化的
在 willMigrateHandler 中代码获取了 flightData 不为 nil 的实体行通用的 NSManagedObject 和 NSFetchRequestResult 类型取代了 Aircraft 托管对象子类因为在迁移过程中 Aircraft 类有可能不会像预期一样存在
对于每个被提取的 Aircraft 实体数据会被复制到一个新的 FlightData 实例中并且这两个实体会被关联并持久化在迁移阶段的执行结束后存储模式会被更新为最新的模型并且现有的数据会被保留下来
为了完成分阶段迁移我创建了一个带有轻量级迁移阶段和自定义迁移阶段的 NSStagedMigrationManager
NSStagedMigrationManager 被添加到 NSPersistentStoreDescription 选项中密钥为 NSPersistentStoreStagedMigrationManagerOptionKey
然后加载持久性存储以开始迁移过程并影响存储模式这样就好了 Core Data 会自动应用所需的阶段并迁移存储模式
一些轻量级迁移需要额外的运行时间你的 App 可能无法在前台提供
在轻量级迁移过程中转换用户数据的过程不是瞬间完成的例如如果迁移涉及将数据从一列复制到另一列或从一个表复制到另一个表这可能需要一些时间
这会导致令人沮丧的用户体验特别是如果迁移在运行时进行
延迟迁移可以帮助你解决这个问题这个 API 让你可以推迟轻量级迁移过程中的一些工作并能够在之后完成推迟的工作在轻量级迁移过程中如果一个实体有需要清理的迁移转换比如更新索引或在执行表复制后删除一个列这个表的转换可以被推迟直到你认为资源可用于执行表的转换轻量级迁移仍然同步并且正常进行只有模式的清理被推迟了你的 App 将正常使用最新的模式要选择延迟迁移请将存储选项中的 NSPersistentStoreDeferredLightweightMigrationOptionKey 设置为 true
延迟迁移 API 的运行时兼容性可以一直追溯到 macOS Big Sur 和 iOS 14
延迟迁移仅适用于 SQLite 存储类型
延迟迁移可能有用的一些例子包括：从实体中删除属性或关系改变实体层次结构不再存在的关系以及将关系从有序变为无序
为了完成延迟迁移任务请检查持久性存储元数据如果其包含密钥 NSPersistentStoreDeferredLightweightMigrationOptionKey 则代表有延迟迁移工作需要完成延迟迁移可以通过调用 NSPersistentStoreCoordinator.finishDeferredLightweightMigration 来处理
要推迟你的 App 中的任何轻量级迁移在向协调器添加持久性存储时在你的存储选项中设置 NSPersistentStoreDeferredLightweightMigrationOptionKey 为 true
到了完成延迟迁移的好时机你可以通过检查存储的元数据来查看是否有挂起的延迟工作如果 NSPersistentStoreDeferredLightweightMigrationOptionKey 被设置为 true 则调用 finishDeferredLightweightMigration()
为了安排你的延迟迁移任务考虑使用 Background Tasks API BGProcessingTask 是为了耗时的操作如长时间的数据更新和 App 维护系统会决定运行你的任务的最佳时间一般来说处理任务只在设备空闲时运行当用户开始使用设备时任何后台处理任务都会终止
延迟迁移和分阶段迁移可以结合使用如果你有一组既复杂又耗时的迁移可以考虑设计一些阶段来利用这两种 API 的能力回到示例模型在 ModelV3 中我们删除了 flightData 属性它就很适合延迟迁移
Core Data 中有三个出色的新技术使用复合属性以一种可嵌套的、结构化的方式封装你的自定义数据类型；通过分解你的模型变化使用分阶段迁移来执行复杂的模型迁移；以及通过使用延迟迁移推迟一些迁移工作来提高你的 App 性能这三种技术可以协同工作以改进你的 App
我们团队非常高兴听到你如何利用这些新技术感谢你的观看愿你享受 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