使用 FileProvider 将桌面级同步功能带入 iOS

探索在创建“文件提供程序”扩展时，如何在您的 iPhone 和 iPad App 内更快速、更高效地同步文件。与 File Provider 团队保持同步，了解如何为 iOS 构建现代文件提供程序。我们将向您展示如何架构 App，以支持无缝文件同步、上传和下载。我们还将探索如何实现无状态，并增强您的文件提供程序以防意外情况。为了充分利用好本次讲座，我们建议您先在 macOS 上体验一下文件提供程序。

资源

相关视频

WWDC21

使用 macOS 上的 FileProvider 将文件同步到云端

下载

大家好我叫 Johannes Fortmann 来自 Cloud File Provider 团队今天我们将讨论如何使用 iOS 16 中新引入的 File Provider API 从而将桌面级同步功能带入 iOS 介绍完之后我们会快速回顾一下文件提供程序的目标我们将讨论架构 App 的最优方法以及一些对 iOS 尤为重要的最佳做法最后我将向大家快速演示一个在 iOS 上运行的提供程序 Big Sur 推出了一个声明式 API 用于将文件同步到 Mac 该 API 已被许多云供应商采用并且取得了巨大成功我的团队一直在稳步改进这个 API 我们很高兴也能在 iOS 16 上使用它这一 API 将使您的 iOS App 能够提供我们所说的 “桌面级同步”功能具体而言随着 iOS 上的 App 功能越来越强大它们要能够访问文件系统上的共享位置这一点非常重要人们希望这些功能强大的 App 可以访问所有类型的文件系统对象他们还应该能够选择让 App 访问文件夹并创建新文件我们当然希望在保证一致性的同时实现所有这些目标这里的一致性是什么意思呢？在 iOS 上由于电源方面的问题后台运行时曾一直受到限制与此同时后台还会不断收到上传的更改内容为了解决这个问题新的 File Provider API 应运而生在基本层面上当您实现一个 App 扩展时该扩展负责枚举项目、获取并上传内容并在项目发生远程更改时更新项目列表而系统负责公开您所提供的信息并保持一致性系统的一项重要任务就是跟踪错误并在必要时重试对于某些操作例如获取内容重试是很自然的事用户正在热切地等待下载他们可能会紧盯着进度条另一方面上传需要进行调度通过跟踪磁盘上项目的状态系统可确保上传的是更新后的内容系统会跟踪进度和错误并在必要时重新上传另一个较为复杂的主题涉及到上传期间的一致性系统会管理文件内容的克隆以确保在上传过程中可成功完成对文件的后续访问并显示正确的数据在这些操作过程中系统还要确保本地版本保持一致哪怕有多个 App 访问它同时还要注意远程服务器的下行同步这是使用 APFS 功能和文件协调功能来实现的并且对您是透明的存储容量限制是移动设备的一个重要约束系统使用 APFS 功能来自动跟踪本地文件的更改状态它可以根据磁盘使用情况和最近不常使用状态来透明地收回没有发生本地更改的文件在“设置”的 “储存空间管理”面板中完全上传的文件不会计入 App 占用的内存大家可能已经注意到到目前为止我们已经讨论了系统和扩展现在让我们来谈一谈 App 发挥作用的地方我建议大家要严格区分不同的关注点系统负责管理磁盘上的结构并调度任务扩展负责执行这些任务以实现上行和下行同步系统会跟踪文件层次结构的所有状态以及需要同步的部分这意味着扩展可能会非常轻量它根本不需要跟踪任何特定于项目的状态您的 App 不负责任何同步理想情况下它根本不需要与服务器通信相反它会通过两种机制与扩展交互一种是与扩展间接交互具体方式与系统上任何其他 App 的相同通过 API 来获取任何托管项的文件 URL 包括根目录然后可以使用常规文件系统 API 来访问这些位置另一种是您的 App 可以请求指向扩展的直接 XPC 服务连接这对于处理那些无法表示为文件系统操作的任务尤为有用例如共享文件或解决冲突 File Provider UI 扩展也可以使用这两种机制在“文件”App 中提供额外的集成点这里我想简单谈谈三点这些对无状态提供程序来说尤其重要首先说一下上传正如我前面提到的系统会跟踪上传并允许您延长上传时间这样做的一个重要后果是：您必须通过报告进度让系统知道您的上传实际上正在进行如果上传任务没有进展它就会被取消在彻底结束上传之前系统提供了一个宽限期；但如果取消时间过长您的扩展将被终止让我们来看一下代码要实现取消处理程序只需通过特定于任务的方法在进度返回值上进行相应设置对于上传而言就是 modifyItem 在处理程序中正在执行的实际上传工作会被取消当然您还需要调用完成处理程序来指示发生了取消错误这里的代码示例使用了异步任务取消这是为了方便起见但您也可以手动调用完成处理程序接下来让我们来谈一谈下行同步路径当用户与他们的文件交互时您的主 App 并未运行也就无法从服务器接收更改内容要想通知系统有远程更改您应该实现推送通知 PushKit 为文件提供程序使用了特定的推送类型您可以直接在扩展上注册这些推送在您的服务器上使用定义明确的有效负载来发送推送系统将接收推送并在适当时刷新当前状态与其他类型的任务一样系统可能会根据实际情况推迟实际刷新比如根据电池状态或用户当前是否正在查看文件最后一点我只是想提醒大家注意这一点：系统管理着扩展所报告的文件夹层次结构因此它可以提供整个文件夹层次结构在这里扩展不需要做任何额外工作新的文件提供程序会默认启用该功能让我们来快速演示一下最后一项功能将会带来什么样的工作流程我已经用本次讲座的示例代码对我的设备进行了设置示例代码已经移植到 iOS 上我们构建了一个 iOS App 来处理服务器登录但这个版本的扩展与 macOS 版本基本相同现在我正在 iPad 上运行示例代码 “文件”App 在右侧运行它已经同步了我的文件我还编写了一个要用到文件夹选择的 App 该 App 会对文件夹中的所有图像应用深褐色滤镜这种类型的应用程序就会得益于文件夹访问功能因为它可以对文件夹中的所有项目进行操作而无需与每个项目单独交互借助桌面级同步我可以方便地将文件夹从“文件”App 拖到批处理编辑器中现在我来调取文件夹和文件以便监控进度然后按下按钮我的所有照片都会被下载和修改修改完成后它们会自动上传扩展所报告的上传进度将在“文件”App 的底部向用户显示让他们一目了然假设我想让自己的 App 也实现类似的功能首先让我们来实现项目拖动要允许拖动需实现 onDrag 方法该方法将返回 NSItemProvider 针对要拖动的文件类型您可以在 itemProvider 上注册一个文件表示形式在本例中它是一个文件夹使用 getUserVisibleURL 方法获取 URL 在接收端实现 onDrop 将某个视图标记为放置目标然后您可以从相应的项目提供程序载入文件 URL 请注意这是一个位于沙盒之外的文件为了让您的 App 能够访问它这个文件必须使用并发布 URL 的安全范围接下来该怎么做？我们已经更新了示例代码其中包含一个 iOS App 下载代码然后尝试设置一个简单的无状态提供程序如果是从零开始请确保使用已更新的 Xcode 模板它包含一个基本框架可以帮助您轻松入门要了解有关文件提供程序及其实现方式的更多信息请参考 WWDC21 中的 “使用 macOS 上的 File Provider 将文件同步到云端” 感谢您的观看我会很高兴能在 iOS 设备上使用到您的性能卓越、安全可靠的提供程序

6:04 - Implement a Progress Cancellation Handler

// Implementing a progress cancellation handler

public func modifyItem(_ item: ..., completionHandler: (..., Error?) -> Void) -> Progress {
    let progress = Progress()
    let uploadTask = Task {
        do {
            // ...
            try Task.checkCancellation()
            // ...
        } catch let error {
            completionHandler(nil, [], false, error)
        }
    }

    progress.cancellationHandler = {
        uploadTask.cancel()
    }
    return progress
}

6:53 - Register for Push Notifications

// Registering for push notifications

import PushKit

let pushRegistry = PKPushRegistry(queue: queue)

pushRegistry.delegate = self
pushRegistry.desiredPushTypes = Set([PKPushType.fileProvider])

...

// On the server: push
//
// {
//    "container-identifier" = "NSFileProviderWorkingSetContainerItemIdentifier"
//    "domain" = "<domain identifier>"
// }
//
// with topic "<your application identifier>.pushkit.fileprovider"

8:53 - Drag and Drop: Implement Dragging

// Sending out drags

var body: some View {
    Text("🥐")
    .onDrag {
        let itemProvider = NSItemProvider()
        itemProvider.registerFileRepresentation(for: .folder,
                                                openInPlace: true) { completionHandler in
            self.manager.getUserVisibleURL(for: folderItemID) { fileURL, error in
                guard let fileURL = fileURL else {
                    completionHandler(nil, false, error)
                    return
                }
                completionHandler(fileURL, true, nil)
            }
            return Progress()  
        }
        return itemProvider
    }
}

9:24 - Drag and Drop: Implement Dropping

// Receiving drops

var body: some View {
    Text("🥬")
    .onDrop(of: [.folder], isTargeted: $dropTarget) { providers in
        guard let prov = providers.first(where: { provider in
            !provider.registeredContentTypes(conformingTo: .folder).isEmpty
        }) else {
            return false
        }
        prov.loadFileRepresentation(for: .folder, openInPlace: true) { url, inPlace, err in
            guard let url = url else { return }
            Task {
                url.startAccessingSecurityScopedResource()
                // use URL
                url.stopAccessingSecurityScopedResource()
            }
        }
        return true
    }
}

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