Core Data with CloudKit (一) —— 基础

这是系列文章的篇，该Core Data with CloudKit系列主要介绍了如何使用CoreData同步CloudKit的三种数据库类型：私有数据库、公共数据库、共享数据库。如果想获得更好的阅读体验，可以直接访问我的个人博客 www.fatbobman.com^[1]

在WWDC 2019上，苹果为Core Data
带了一项重大的更新——引入了NSPersistentCloudKitContainer
。这意味着无需编写大量代码，使用Core Data with CloudKit
可以让用户在他所有的苹果设备上无缝访问应用程序中的数据。

Core Data
为开发具有结构化数据的应用程序提供了强大的对象图管理功能。CloudKit允许用户在登录其iCloud账户的每台设备上访问他们的数据，同时提供一个始终可用的备份服务。Core Data with CloudKit
则结合了本地持久化+云备份和网络分发的优点。

2020年、2021年，苹果持续对Core Data with CloudKit
进行了强化，在初仅支持私有数据库同步的基础上，添加了公有数据库同步以及共享数据库同步的功能。

我将通过几篇博文介绍Core Data with CloudKit
的用法、调试技巧、控制台设置并尝试更深入地研究其同步机制。

Core Data with CloudKit的局限性

•只能运行在苹果的生态不同于其他的跨平台解决方案，Core Data with CloudKit
只能运行于苹果生态中，并且只能为苹果生态的用户提供服务。•测试门槛较高需要有一个Apple Developer Program^[2]账号才能在开发过程中访问CloudKit
服务和开发团队的CKContainer
。另外，在模拟器上的运行效果也远没有在真机上可靠。

Core Data with CloudKit的优点

•几乎免费开发者基本上不需要为网络服务再额外支付费用。私有数据库保存在用户个人的iCloud空间中，公共数据库的容量会随着应用程序使用者的增加而自动提高，高可增加到1 PB 存储、10 TB 数据库存储，以及每天 200 TB 流量。之所以说几乎免费，毕竟苹果会扣取15-30%的app收益。•安全一方面苹果通过沙盒容器、数据库区隔、加密字段、鉴权等多种技术手段保证了用户的数据安全。另一方面，鉴于苹果长期以来在用户中树立的隐私捍卫者的形象，使用Core Dat with CloudKit
可以让用户对你的应用程序增加更多的信任。事实上，正是在WWDC2019年看到这个功能后，我才有了开发【健康笔记】^[3]的原动力——既保证数据隐私又能长久的保存数据。•集成度高、用户感知好鉴权、分发等都是无感的。用户不需要进行任何额外的登录便可享受全部的功能。

Core Data

Core Data
诞生于2005年，它的前身EOF
在1994年便已经获得的不少用户的认可。经过了多年的演进，Core Data
已经发展的相当成熟。作为对象图和持久化框架，几乎每个教程都会告诉你，不要把它当作数据库，也不要把它当作ORM
。

Core Data
的功能包括但不限于：管理序列化版本、管理对象生命周期、对象图管理、SQL隔离、处理变更、持久化数据、数据内存优化以及数据查询等。

Core Data
提供的功能繁多，但对于初学者并不十分友好，拥有陡峭的学习曲线。近几年苹果也注意到了这个问题，通过添加PersistentContainer
极大的降低了Stack
创建的难度；SwiftUI
及Core Data模版
的出现让初学者也可以较轻松地在项目中使用其强大的功能了。

CloudKit

在苹果推出iCloud
之后的几年中，开发者都无法将自己的应用程序同iCloud
结合起来。这个问题直到2014年苹果推出了CloudKit
框架后才得到解决。

CloudKit
是数据库、文件存储、用户认证系统的集合服务，提供了在应用程序和iCloud容器
之间的移动数据接口。用户可以在多个设备上访问保存在iCloud
上的数据。

CloudKit
的数据类型、内在逻辑和Core Data
有很大的不同，需要做一些妥协或处理才能将两者的数据对象进行转换。事实上，当CloudKit
一经推出，开发者就强烈希望两者之间能够进行便捷的转换。在推出Core Data with CloudKit
之前，已经有第三方的开发者提供了将Core Data
或其他数据的对象（比如realm
）同步到CloudKit
的解决方案，这些方案中的大多数目前仍在提供支持。

依赖于之前推出的持久化历史追踪^[4]功能，苹果终于在2019年提供了自己的解决方案Core Data with CloudKit
。

Core Data对象 vs CloudKit对象

两个框架都有各自的基础对象类型，相互之间并不能被一一对应。在此仅对本文涉及的一些基础对象类型做简单的介绍和比较：

•NSPersistentContainer vs CKContainerNSPersistentContainer
通过处理托管对象模型（NSManagedObjectModel
），对持久性协调器（NSPersistentStoreCoordinator
）和托管对象上下文（NSManagedObjectContext
）进行统一的创建和管理。开发者通过代码创建其的实例。CKContainer
则和应用程序的沙盒逻辑类似，在其中可以保存结构化数据、文件等多种资源。每个使用CloudKit
的应用程序应有一个属于自己的CKContainer
（通过配置，一个应用程序可以对应多个CKContainer
，一个CKContainer
 也可以服务于多个应用程序）。开发者通常不会在代码中直接创建新的CKConttainer
，一般通过iCoud控制台
或在Xcode Target
的Signing&Capabilities
中创建。•NSPersistentStore vs CKDatabase/CkRecordZoneNSPersistentStore
是所有 Core Data
 持久存储的抽象基类，支持四种持久化的类型（SQLite
、Binary
、XML
 和 In-Memory
）。在一个NSPersistentContainer
中，通过声明多个的NSPersistentStoreDescription
，可以持有多个NSPersistentStore实例
（可以是不同的类型）。NSPersistentStore
没有用户鉴权的概念，但可以设置只读或读写两种模式。由于Core Data with CloudKit
需要持久化历史追踪^[5]的支持，因此只能同步将SQLite
作为存储类型的NSPersistentStore
，在设备上，该NSPersistentStore的实例
将指向一个SQLite数据库文件
。在CloudKit
上，结构化的数据存储只有一种类型，但采用了两个维度对数据进行了区分。从用户鉴权角度，CKDatabase
分别提供了三种形式的数据库：私有数据库、公有数据库、共享数据库。应用程序的使用者（已经登录了iCloud
账号）只能访问自己的私有数据库，该数据库的数据保存在用户个人的iCloud
空间中，其他人都不可以对其数据进行操作。在公共数据库中保存的数据可以被任何授权过的应用程序调用，即使app的使用者没有登录iCloud
账户，应用程序仍然可以读取其中的内容。应用程序的使用者，可以将部分数据共享给其他的同一个app
的使用者，共享的数据将被放置在共享数据库中，共享者可以设置其他用户对于数据的读写权限。数据在CKDatabase
中也不是以零散的方式放置在一起的，它们被放置在指定的RecoreZone
中。我们可以在私有数据库中创建任意多的Zone
（公共数据库和共享数据库只支持默认Zone
）。当CKContainer
被创建后，每种数据库中都会默认生成一个名为_defaultZone
的CKRecoreZone
。因此，当我们保存数据到CloudKit数据库时，不仅需要指明数据库（私有、公有、共享）类型，同时也需要标明具体的zoneID
（当保存到_defaultZone
时无需标记）。•NSManagedObjectModel vs SchemaNSManagedObjectModel
是托管对象模型，标示着Core Data
对应的数据实体（Enities）。绝大多数情况下，开发者都是使用Xcode
的Data Model Editor
来对其进行的定义，定义会被保存在xcdatamodeled
文件中，其中包含了实体属性、关系、索引、约束、校验、配置等等信息。当在应用程序中启用CloudKit
后，将在CKContainer
创建一个Schema
。Schema
中包括记录类型（Record Type
）、记录类型类型之间可能存在的关系、索引以及用户权限。除了直接在iCloud
控制台创建Schema
的内容外，也可以通过在代码中创建CKRecord
，让CloudKit
自动为我们创建或更新Schema
中对应的内容。Schema
中有权限的设定（Security Roles
），可以分别为world
、icloud
以及creator
设定不同的读写权限。•Entities vs Record *尽管我们通常会强调Core Data
不是数据库，但实体（Enitities
）与数据库中的表非常相似。我们在实体中描述对象，包括其名称、属性和关系。终将其描述成NSEntityDescription
并汇总到NSManagedObjectModel
中。在CloudKit
中用Record *
描述数据对象的名称、属性。Enitiy
中有大量的信息可以配置，但Record *
只能对应描述其中的一部分。由于两方无法一一对应，因此在设计Core Data with CloudKit
的数据对象时要遵守相关规定（具体规定将在下一篇文章中探讨）。•Managed Object vs CKRecord托管对象（Managed Object
）是表示持久存储记录的模型对象。托管对象是NSManagedObject
或其子类的实例。托管对象在托管对象上下文（NSManagedObjectContext
）中注册。在任何给定的上下文中，托管对象多有一个实例对应于持久存储中的给定记录。在CloudKit
上，每条记录被称作为CKRecord
。我们不需要关心Managed Object
的ID
（NSMangedObjectID
）的创建过程，Core Data
将为我们处理一切，但对于CKRecord
，多数情况下，我们需要在代码中明确为每条记录设定CKRecordIdentifier
。作为CKRecord
的标识，CKRecordIdentifier
被用于确定该CKRecord
在数据库的位置。如果数据保存在自定义的CKRecordZone
，我们也需要在CKRecord.ID
中指明。•CKSubscriptionCloudKit
是云端服务，它要同一iCloud
账户的不同设备（私有数据库）或者使用不同iCloud
账号的设备（公共数据库）的数据变化做出相应的反馈。开发者通过CloudKit
在iCloud
上创建CKSubscription
,当CKContainer
中的数据发生变化时，云端服务器会检查该变化是否满足某个CKSubscription
的触发条件，在条件满足时，对订阅的设备发送远程提醒（Remote Notification
）。这就是当我们在Xcode Target
的Signing&Capabilities
中添加上CloudKit
功能时，会Xcode
自动添加Remote Notification
的原因。在实际使用中，需要通过CKSubscription
的三个子类完成不同的订阅任务：CKQuerySubscription
，当某个CKRecord
满足设定的NSPercidate
时推送Notification
。CKDatabaseSubscription
，订阅并跟踪数据库（CKDatabase
）中记录的创建、修改和删除。该订阅只能用于私有数据库和共享数据库中自定义的CKRecordZone
，并只会通知订阅的创建者
。在以后的文章中，我们可以看到Core Data with CloudKit
是如何在私有库中使用该订阅的。CKRecordZoneNotification
，当用户、或者在某些情况下，CloudKit
修改该区域（CKRecordZone
）的记录时，记录区的订阅就会执行，例如，当记录中某个字段的值发生变化时。对于iCloud
服务器推送的远程通知，应用程序需要在Application Delegate
中做出响应。多数情况下，远程提醒
可以采用静默通知
的形式，为此开发者需要在的应用程序中启用Backgroud Modes
的Remote notifications
。

Core Data with CloudKit 的实现猜想

结合上面介绍的基础知识，让我们尝试推测一下Core Data with CloudKit
的实现过程。

以私有数据库同步为例：

•初始化：1.创建CKContainer
2.根据NSManagedObjectModel
配置Schema
3.在私有数据库中创建ID为com.apple.coredata.cloudkit.zone
的CKRecordZone
4.在私有数据库上创建CKDatabaseSubscription
•数据导出（将本地Core Data
数据导出到云端）1.NSPersistentCloudKitContainer
创建后台任务响应持久化历史跟踪
的NSPersistentStoreRemoteChange
通知2.根据NSPersistentStoreRemoteChange
的transaction
，将Core Data
的操作转换成CloudKit
的操作。比如对于新增数据，将NSManagedObject
实例转换成CKRecord
实例。3.通过CloudKit
将转换后的CKRecord
或其他CloudKit操作
传递给iCloud
服务器•服务器端1.按顺序处理从远端设备提交的CloudKit操作数据
2.根据初始化创建的CKDatabaseSubscription
检查该操作是否导致私有数据库的com.apple.coredata.cloudkit.zone
中的数据发生变化3.对所有创建CKDatabaseSubscription
订阅的设备（同一iCloud
账户）分发远程通知•数据导入（将远程数据同步到本地）1.NSPersistentCloudKitContainer
创建的后台任务响应云端的静默推送
2.向云端发送刷新操作要求并附上上次操作的令牌
3.云端根据每个设备的令牌
，为其返回自上次刷新后数据库发生的变化4.将远端数据转换成本地数据（删除、更新、添加等）5.由于视图上下文
的automaticallyMergesChangesFromParen
属性设置为真，本地数据的变化将自动在视图上下文
中体现出来

上述步骤中省略了所有技术难点及细节，仅描述了大概的流程。

总结

本文中，我们简单介绍了关于Core Data
、CloudKit
以及Core Data with CloudKit
的一点基础知识。在下一篇文章中我们将探讨如何使用Core Data with CloudKit
实现本地数据库和私有数据库的同步。

PS：介绍如何使用NSPersistentContainer的文章并不少，但同其他Core Data的功能一样，用好并不容易。在两年多的使用中，我便碰到不少问题。借着今年打算在【健康笔记3】^[6]中实现共享数据库
功能的机会，我近较系统地重新学习了Core Data with CloudKit
并对其知识点进行了梳理。希望通过这个系列博文能让更多的开发者了解并使用Core Data with Cloudkit
功能。

来源 https://www.modb.pro/db/109750