CloudKit 中的新功能

CloudKit 中的新功能

CloudKit 为您的 app 提供安全、方便且可靠的云数据库，它也正在不断完善。探索如何在 async/await 功能和便利 API 添加支持下理顺您的线程。我们还将展示如何通过分享整个数据记录区来鼓励 app 使用者之间进行协作，探索如何采用加密值等 CloudKit 功能，并帮助保护 app 内的敏感数据。为了充分了解本节内容，我们建议您熟悉 CloudKit 及其容器操作，并基本了解记录和数据类型。

资源
相关视频

WWDC23
- 隐私保护的新功能
WWDC22
- 利用“信息”提升协作体验
Tech Talks
- 充分利用 CloudKit 共享
WWDC21
下载

尼哈尔：大家好欢迎来到《CloudKit的新功能》我的名字是尼哈尔夏尔马我是CloudKit团队的一名工程师我的同事倩稍后会加入我首先我们将重点介绍利用Swift并行性对CloudKit API进行的一些更改然后倩将带我们了解如何在记录上使用加密字段
最后我们将深入研究一项新功能可让你轻松共享记录区域
首先我们有CloudKit 和Swift并行性作为背景介绍 CloudKit是一个框架可让你的app 访问iCloud上的数据库这在API中公开为CKContainer 你可以通过它访问多个CKDatabase
每个容器都有一个公共数据库所有用户都可以在其中读取和写入记录如果设备有一个已登录的iCloud账户那么你的app还可以访问包含该用户数据的私人数据库如果你的app支持共享那么共享给当前iCloud用户的数据将在共享的CKDatabase中对你的app可用在针对CloudKit编写代码时 API有两个方面首先 CKContainer和CKDatabase上可用的函数此API对CloudKit的新用户很有用旨在提供较低的进入门槛该框架不会为你提供所有可用的配置而是选择一种默认行为该行为最适合用户交互的UI app 接下来是操作API 它被公开为一组 NSOperation子类这个API提供了许多作为CKContainer 或CKDatabase函数不可用的功能
这包括在到服务器的单次往返中发送和接收一批项目通过从服务器增量获取大型结果集来分页从过去的某个时间点向服务器请求数据库和记录区域更改最后将不同的操作组合在一起这允许将它们作为一个单元进行记录并允许你通知系统你的操作跨工作量大小许多开发人员在编写生产质量的代码时最终会使用此API 利用新的Swift并行性功能 CloudKit进行了多项改进首先我将介绍如何在使用CloudKit API的同时使用新的Swift async/await功能然后我将讨论有助于澄清每项回调和每操作回调之间区别的新API 以及CloudKit 如何利用Swift.Result类型来澄清参数对这些回调的作用最后我将介绍我们对容器和数据库函数功能所做的改进这些改进有助于带来一些以前只能通过操作API 获得的功能和可配置性
CloudKit API 为容器和数据库上的函数引入async变体你可以使用async函数来改进处理并行性的代码它有助于使错误处理更加自然并简化代码中的可视化控制流程有关async函数的更多详细信息请参阅《在Swift中认识async/await》课程我们来看个例子
此代码片段取自 PrivateDatabase代码示范这是Apple最近发布到GitHub的几个特定于CloudKit的代码示范之一你可以使用它们这个特定的函数想要从服务器中删除一条记录并在完成后通知调用者
请注意这里有许多可选的条件和条件展开当你第一次尝试理解这个函数时控制流并不是很明显
现在让我们将其与使用CloudKit的async函数的代码进行比较在这里可选和展开已经被消除控制流是线性的更容易遵循
我很高兴地说我们在GitHub存储库上的每个代码示范都有更新这些更新示范了如何通过类似的重构代码来使用Swift并行性
让我们来谈谈每个项目的回调例如这里有一个 CKFetchRecordsOperation 向服务器发送四个CKRecord.ID 以理想地获得四个CKRecord内容此操作可以采用三种不同方式
在第一种情况下操作成功没有错误你的记录已成功从服务器获取
第二种可能是你遇到了操作范围内的错误这是导致整个操作失败的错误例如设备可能缺少网络连接在这种情况下整个操作将失败并显示错误代码 networkUnavailable
这是第三种可能在这种情况下你的操作已成功往返于服务器服务器已成功返回三个请求的CKRecords 同时出现一个错误表示第四个请求的记录不存在在这个例子中每个项目的错误是unknownItem 它被绑定到每个操作的错误 partialFailure中那么这在代码中是如何处理的呢？在顶部 CKFetchRecordsOperation 声明了它的 perRecordCompletionBlock 和每个操作完成块并在底部的每个操作完成块示范实现
请注意这两个回调之间的重叠从之前的缺失记录示范来看该代码预计会出现两次每项错误一次是每项回调中的顶级unknownItem错误另一次是每操作回调中的 partialFailure错误类似地对于成功获取的记录它也期望每个项目在两个地方获得成功首先作为每个项目回调的顶级参数再一次包装在操作回调成功结果的 recordsByRecordID字典中
通过利用Swift.Result类型 CloudKit替换了这两个回调使API更加清晰
请注意新的基于结果的回调中块参数的顶层分离 perRecordResultBlock有一个ID 标识 CloudKit正在回调的项目它有每个项目的结果结果现在是强类型的因此你知道你得到的要么是成功获取的CKRecord内容要么是每个项目的错误
同样的操作范围的完成块也已更新为操作范围的结果块该结果块不再重复每个项目结果块已报告的任何成功或失败
所以 CloudKit现在正式分清了他们的顾虑一个块专门用于每个项目的报告另一个专门用于每个操作的报告
回到我们缺少的记录示范期望是三次对每项结果块的调用成功获取CKRecord内容一次对每个项目结果块的调用带有一个unknownItem错误一次对每操作结果块的调用没有错误因为操作整体上是成功的 CloudKit的一项新改进是在各处显示单独的每项和每操作回调以前只有突出显示的操作具有显示每项错误的每项回调
我很高兴地宣布所有CKOperations 现在都公开了每个项目的回调这些回调会在适当的时候传回每个项目的错误现在让我们来看看我们对容器和数据库API所做的一些增强和扩展增强的形式是CKContainer 和CKDatabase上的新函数
这些新函数一起使大量CKOperation API 可用作CKContainer 和CKDatabase上的函数重要的是这不是操作API的一对一映射相反我们利用默认参数和Swift.Result类型来制作一个易于使用功能强大且可与async/await 配合使用的API 也就是说每个新函数都会公开两次一次是使用completionHandler 另一次是作为async函数有了这个增强的API 容器和数据库上的函数现在支持OperationAPI中的一些功能例如批处理多个项目对大型数据集进行分页以及获取更改你还可以将函数调用组合在一起进行日志记录并通知系统有关组合工作负载的大小
现在还可以配置函数调用例如设置超时那么这是怎么做到的呢？
这里同样是我们之前看到的 GitHubPrivateDatabase代码示范使用async函数删除记录
让我们看看如何更新此代码来利用项目批处理我将更改此函数的行为以自动地删除两条记录通过利用数据库上增强的函数API
注意关注点的分离突出显示的区域在功能范围内执行它们启动函数并捕获抛出的任何函数范围的错误
如果函数成功完成这个突出显示的区域将检查每个项目的成功或失败我们在GitHub上的代码示范存储库中提供了涵盖所有这些功能的类似示范本次课程的注释有包含到这些存储库的连结我们希望它们对你有所帮助接着我想把它交给倩她会带我们了解加密字段谢谢尼哈尔我是倩我将谈论 CloudKit中的一项新功能可以非常容易地保护用户的数据隐私为此我将首先概述CloudKit如何保护你的用户数据然后我将介绍新的数据加密功能最后介绍用户账户加密的一些先决条件在Apple 隐私是我们所有产品的核心价值观之一作为支持许多Apple app 和服务的框架 CloudKit一直在不断创新隐私技术为存储和与CloudKit同步的数据提供保护首先让我回顾一下CloudKit 是如何保护你的用户数据 CloudKit的方法包括两种主要的数据保护方法基于账户的保护和加密保护
使用CloudKit存储的任何数据默认情况下都受到基于账户的身份验证保护这包括你的CloudKit支持的app 和所有Apple CloudKit支持的app 在存储和检索时 CloudKit使用安全令牌来强制只有授权用户才能访问他们的数据而不是Apple或任何第三方
提醒一下基于账户的保护只覆盖私有和共享数据库中的数据在这些数据库中数据属于或共享给特定的iCloud账户访问共享数据需要身份验证但是在公共数据库中所有用户都可以访问数据因此在默认情况下基于账户的数据保护并不适用
现在我们来看看另一种数据保护技术加密保护 CloudKit为存储在Apple app 和服务中的敏感数据以及以CKAsset形式存储的所有用户数据提供加密保护这些数据在发送到 CloudKit服务器进行存储前会在本地进行预处理和加密并在检索时在本地解密
此加密功能使用存储在 iCloud钥匙圈中的密钥材料该密钥材料属于设备上登入的iCloud账户同时兼容 CloudKit的共享功能确保只有CKShare上的用户才能解密相关的加密字段
加密保护在基于账户的保护之上增加了另一层因为即使未经授权的一方以某种方式绕过授权他们也无法解密检索到的数据
应该对用户敏感或私有的数据使用加密保护 Apple的许多CloudKit 支持的app都利用了此功能例如照片和笔记
到目前为止 CloudKit对用户非资产数据的保护默认提供基于账户的保护 CloudKit现在提供加密保护除了让你免于所有密钥派生、管理和加密/解密过程这将帮助你构建具有比以往任何时候都更强大的隐私承诺的 CloudKit支持的app
让我们看看新的API 怎么帮助你做到这一点你可以在CKRecords上的新属性 encryptedValues中添加任何密钥值以进行加密还可以在相同的属性中获取解密后的原始值
我将介绍encryptedValuesAPI 如何使你能够通过 CloudKit服务器同步加密数据这里有两台设备和一台CloudKit服务器如果设置了 encryptedValues密钥值对 CloudKit会自动将本地 CKModifyRecordsOperation中的记录值加密到服务器在另一台设备上从服务器检索记录后可以调用相同的API CloudKit将自动打开密钥值对
你只需要最少的代码就可以实现这个过程在第一台设备上使用encryptedValues API 可以设置记录上的密钥值对在本例中密钥是 “encryptedStringField” 值是一个字符串对象之后你可以调用 CKModifyRecordsOperation 将新记录保存到服务器里
在第二个设备上你可以调用 CKFetchRecordsOperation 来检索加密记录并且通过使用相同的 encryptedValues属性取回字符串就是这样一个简单的属性为你处理所有加密和解密过程并且你可以加密几乎所有的 CKRecord值类型除了CKReference 因为它们需要对服务器可见请注意由于CKAssets字段如前面提到的在默认情况下已经采用了加密它们不能设置为encryptedValue
你可以通过进入 CloudKit数据库模式来可视化加密字段就像常规字段一样有一个CloudKit控制台课程《认识CloudKit控制台》向你演示了对控制台所做的其他更改你可以随时查看在控制台中所有加密字段都将显示在记录值数据类型的下拉列表中
它们将有前缀“加密” 例如 “加密双倍”、“加密时间戳” 以帮助你将它们与未加密的区别开来你还可以直接通过CloudKit控制台管理加密字段无需任何代码更改例如你可以将一个新的加密字段添加到开发数据库架构中的新纪录类型中
接下来涉及加密操作的账户的先决条件与私有和共享数据库中的其他操作一样它们需要一个有效的登录账户你需要在初始化逻辑中通过使用completionHandler 和CKContaineraccountStatus 来检查当前账户的状态
提醒一下私有和共享数据库中的操作状态必须是“可用”
任何其他状态都将导致 “CKErrorNotAuthenticated” 包括今年引入的新状态临时不可用以表示账户已登入但尚未准备好你可以在“设置”app中指导用户验证他们的凭据
如果你的用户账户不是在“可用”状态你应该监听 CKAccountChanged通知该通知在账户更改时发布以便在状态准备就绪时收到通知
这就是你该知道的关于使用CloudKit 加密数据的全部内容它将保护你用户的数据并节省你实施自己的自定义解决方案的所有时间和精力现在让我出色的同事尼哈尔来谈谈区域共享谢谢倩我们来聊聊CloudKit分享
CloudKit是你安全注重隐私的iCloud云端数据库可帮助你在所有用户的设备上存储和同步用户数据 iOS 10和macOS Sierra 引入了CloudKit共享这是一种与其他iCloud用户安全共享数据的方式在深入探讨共享方面的新功能之前让我们仔细看看 CloudKit共享是如何运作的
提醒一下 CloudKit共享是通过创建 CKShare对象来启动的该对象将共享的数据与共享相关的详细信息分开来例如与谁共享数据这些共享参与者拥有什么权限等等在后台 CloudKit还为参与者建立了对共享数据的加密访问并要求对所有请求进行基于账户的身份验证
现在你可以通过两种主要方式在app中添加共享支持你可以使用系统提供的 UI进行共享管理快速上手在iOS上通过 UICloudSharingController提供在macOS上通过NSSharingService 提供或者你还可以构建自己的自定义UI 让用户使用这些框架操作与共享设置进行交互
就像我之前提到的 CKShares 将共享的内容与共享的对象分开今天我们将专注于这个等式的前半部分更具体地说看看几种不同的数据建模方式以及它们如何影响你利用CloudKit共享API的方式
让我们从一个利用现有CloudKit 共享功能的示范开始 iCloud Drive文件夹共享建立在CloudKit之上让我们看看如何在自己的app中构建类似的东西因此这里的数据模型代表一个文件系统层次结构因此你将从“文件”和“文件夹” 类型的记录开始并且你希望让用户能够轻松地共享任何文件夹记录以及包含在其中的所有记录文件或文件夹
在CloudKit中表示这种层次关系并利用它进行共享的方法是使用CKRecord.parent 从子记录到父记录的引用
这使得CloudKit 将结果层次结构视为单个可共享单元因此你需要继续在此处添加这些引用这非常重要也是CloudKit中父引用的特殊之处请注意如果你不打算支持共享就不需要使用父引用你自己架构中的任何普通 CKReference字段就足够了
通过该设置现在只需初始化 CKShare即可支持文件夹共享并将文件夹记录作为CKShare的根记录
使用文件夹作为根记录意味着 CloudKit将自动共享所有记录这些记录是最终指向该文件夹记录基于父引用的层次结构的一部分这也意味着以后从该层次结构中添加或删除的记录将分别自动共享或取消共享那么这个简单的文件夹共享模型是如何在代码中设置的呢？
继续我们的示范这里有两个文件记录以及文件夹记录要在私有数据库的自定义区域中共享
首先在指向文件夹记录的两个文件记录上设置父引用然后保存文件记录请注意最好尽早保存父引用以便在共享文件夹时最小化需要修改的记录数量
然后通过以我们的文件夹初始化作为根记录的CKShare 并将CKShare与文件夹记录一起保存到私有数据库中从而共享所有三个记录请注意由于父引用先前已保存到服务器所以在共享时只需要修改根文件夹记录
就这样你的app现在正在共享文件夹记录及其下面的记录 CloudKit可以支持同一区域内的多个CKShare 只要它们的记录层次结构不重叠
现在假设我们不是分层的文件夹共享模型而是在你的区域中有代表一些不同类型的记录并且它们之间没有逻辑层次结构
换句话说该区域被视为记录桶你希望快速开始共享其中的所有记录
理想情况下你只需能够将整个记录区域标记为 “共享” 而无需操作其中的任何记录
现在通过区域共享你就可以做到这一点让我们用代码来建立它
你需要做的就是使用新的 CKShare初始化程序该初始化程序接受私有数据库中现有区域的记录区域ID 一旦保存了这个新的区域范围共享记录服务器上该区域中存在的所有记录都会自动共享共享新纪录或取消共享记录只需从该区域中添加或删除这些记录即可通过删除区域范围的共享记录可以随时取消共享整个记录区域让我们更深入地研究一下这些新的区域共享记录
为了方便起见区域范围的共享记录始终具有一个众所周知的记录名称 CKRecordNameZoneWideShare 它可以与区域ID一起使用以创建完整的共享记录ID
使用区域共享的区域不需要在该区域中的记录之间设置任何父引用
请注意由于区域共享只允许每个区域有一个共享记录因此这种共享方式不能与同一区域内的分层共享共存因此你可以在一个区域中有一个或多个分层共享或者只有单个区域范围的共享记录
你可以在任何非默认记录区域中保存区域范围的共享这些区域也被标记为一个新的区域功能 CKRecordZoneCapability ZoneWideSharing
CKShare记录创建之后的所有现有CloudKit 共享机制都保持不变并且完全支持区域范围的共享只有一个例外由于在使用区域共享时不再有任何根记录 CKShareMetadata上的相关属性如hierarchicalRootRecordID 和rootRecord 在接受区域共享时将为零
同样的当使用 CKFetchShareMetadataOperation 来引导一个自定义共享接受流程时当获取区域范围共享的元数据时系统会忽略 “shouldFetchRootRecord” 和“rootRecordDesiredKeys”
因此现在有两种 CloudKit共享可用具体取决于你的数据模型如果你app的架构在逻辑上形成层次结构层次结构树作为可共享单元是有意义的那么继续使用CKRecord父引用来表示这些层次结构然后共享它们的根记录在Apple 我们为备忘录、提醒事项和iCloud Drive文件夹共享采用类似的方式
对于所有其他情况现在即可高效地共享整个记录区域现在只需创建单个区域范围的共享记录并充分利用CloudKit共享在Apple 我们已经利用了区域共享来实现了几个功能例如HomeKit安全视频共享和HomePod多用户功能
所以今天我们探讨了如何使用Swift中的async/await 以一种新的方式开始编写CloudKit代码包括对每项进度和错误报告API的增强
我们讨论了如何利用记录中的加密字段获取敏感用户数据充分利用Apple对用户隐私的承诺而无需自行加密
我们还了解了一种在数据模型没有分区共享时可以更快地开始使用CloudKit共享的方法
developer.apple.com上有一些关于这些功能的很棒的新文档你可以在网站上找到更多信息你可以去看看在《探索CloudKit》集合中也有许多相关的课程供你查看包括来自Core Data的课程介绍了构建在CloudKit之上的共享功能谢谢你希望你有个很棒的WWDC [欢乐的音乐]

3:34 - CloudKit: Existing convenience API

// Sample code using existing Convenience API

/// Delete the last person record.
/// - Parameter completionHandler: An optional handler to process completion `success` or `failure`.
func deleteLastPerson(completionHandler: ((Result<Void, Error>) -> Void)? = nil) {
    database.delete(withRecordID: lastPersonRecordId) { recordId, error in
        if let recordId = recordId {
            os_log("Record with ID \(recordId.recordName) was deleted.")
        }
        if let error = error {
            self.reportError(error)
            // If there is a completion handler, pass along the error here.
            completionHandler?(.failure(error))
        } else {
            // If there is a completion handler, like during tests, call it back now.
            completionHandler?(.success(()))
        }
    }
}

4:04 - CloudKit: Async convenience API

// Sample code updated to CloudKit Async API

/// Delete the last person record.
func deleteLastPerson() async throws {
    do {
        let recordId = try await database.deleteRecord(with: lastPersonRecordId)
        os_log("Record with ID \(recordId.recordName) was deleted.")
    } catch {
        self.reportError(error)
        throw error
    }
}

5:39 - CloudKit: Existing completion blocks

// Error reporting in CKFetchRecordsOperation

extension CKFetchRecordsOperation {
    var perRecordCompletionBlock: ((CKRecord?, CKRecord.ID?, Error?) -> Void)?

    var fetchRecordsCompletionBlock: (([CKRecord.ID : CKRecord]?, Error?) -> Void)?
}


fetchRecordsOp.perRecordCompletionBlock = { record, recordID, error in
    // error is CKError.unknownItem. 
}

fetchRecordsOp.fetchRecordsCompletionBlock = { recordsByRecordID, operationError in
    // operationError is CKError.partialFailure.
    // operationError.partialErrorsByItemID[missingRecordID] is CKError.unknownItem.
}

6:35 - CloudKit: Result type completion blocks

// Error reporting in CKFetchRecordsOperation

extension CKFetchRecordsOperation {
    var perRecordResultBlock: ((CKRecord.ID, Result<CKRecord, Error>) -> Void)?

    var fetchRecordsResultBlock: ((Result<Void, Error>) -> Void)?
}


fetchRecordsOp.perRecordResultBlock = { recordID, result in
    // result is .failure(CKError.unknownItem) or .success(record).
}

fetchRecordsOp.fetchRecordsResultBlock = { result in
    // result is .success.
}

9:14 - CloudKit: Delete single item

// Single item delete

func deleteLastPerson() async throws {
    do {
        let recordId = try await database.deleteRecord(with: lastPersonRecordId)
        os_log("Record with ID \(recordId.recordName) was deleted.")
    } catch {
        self.reportError(error)
        throw error
    }
}

9:37 - CloudKit: Delete batch

// Batched modifications

func deleteLastPeople() async throws {
    do {
        let recordIds = [lastPersonRecordId, penultimatePersonRecordId]
        let (_, deleteResults) = try await database.modifyRecords(deleting: recordIds)
        for (recordId, deleteResult) in deleteResults {
            switch deleteResult {
            case .failure(let error):
                self.reportError(error, itemId: recordId)
            case .success:
                os_log("Record with ID \(recordId.recordName) was deleted.")
            }
        }
    } catch let operationError {
        self.reportError(operationError)
        throw operationError
    }
}

13:43 - CloudKit: Encrypted values

extension CKRecord {
    @NSCopying open var encryptedValues: CKRecordKeyValueSetting { get }
}

14:29 - CloudKit: Using encrypted values

// Device 1: Encrypt data before calling CKModifyRecordsOperation.

myRecord.encryptedValues["encryptedStringField"] = "Sensitive value"

// Device 2: Decrypt data after calling CKFetchRecordsOperation.

let decryptedString = myRecord.encryptedValues["encryptedStringField"] as? String

16:35 - CloudKit: Account status

open func accountStatus(completionHandler: @escaping (CKAccountStatus, Error?) -> Void)

16:46 - CloudKit: CKAccountStatus

public enum CKAccountStatus : Int {
    case couldNotDetermine
    case available
    case restricted
    case noAccount
    case temporarilyUnavailable
}

21:10 - CloudKit: Setup a record hierarchy

// Share a record hierarchy


let zone = CKRecordZone(zoneName: "MyZone")

// Save zone...

let fileRecordA = CKRecord(recordType: "File", recordID: CKRecord.ID(zoneID: zone.zoneID))
let fileRecordB = CKRecord(recordType: "File", recordID: CKRecord.ID(zoneID: zone.zoneID))
let folderRecord = CKRecord(recordType: "Folder", recordID: CKRecord.ID(zoneID: zone.zoneID))

fileRecordA.setParent(folderRecord)
fileRecordB.setParent(folderRecord)

// Save records...

21:41 - CloudKit: Record Hierarchy, Share

// Share a record hierarchy


let share = CKShare(rootRecord: folderRecord)

do {
    let (saveResults, _) = try await database.modifyRecords(saving: [folderRecord, share])
    for (recordID, saveResult) in saveResults { 
        // Handle per-record result.
    }
} catch let operationError { 
    // Handle operation error.
}

22:51 - CloudKit: Share a Record Zone

// Share a record zone


let zone = CKRecordZone(zoneName: "MyZone")

// Save zone... 

let share = CKShare(recordZoneID: zone.zoneID)

do {
    let (saveResults, _) = try await database.modifyRecords(saving: [share])
    for (recordID, saveResult) in saveResults { 
        // Handle per-record result.
    }
} catch let operationError { 
    // Handle operation error.
}

正在查找特定内容？在上方输入一个主题，就能直接跳转到相应的精彩内容。

提交你查询的内容时出现错误。请检查互联网连接，然后再试一次。

资源

相关视频

WWDC23

WWDC22

Tech Talks

WWDC21