使用带有 URLSession 的 async/await

探索如何使用 async/await 和 AsyncSequence 在 URLSession 中采用 Swift 并发功能，以及如何运用 Swift 并发概念来改进您的网络代码。

资源

相关视频

WWDC22

利用 Swift 并发消除数据争用

WWDC21

下载

♪播放重低音音乐♪ ♪ 嗨我是国晔我和我的同事真超负责开发HTTP框架我相信目前为止您时常听闻Swift并发这个词如果您从未听过立即观看 “认识Swift async/await” 我将直接进入正题看看async/await 如何与URLSession一起运作我最喜欢Swift并发的一点是它可以让程序代码连贯、精简还支持原生Swift错误处理网络原先是异步化而在iOS 15和macOS Monterey中我们为您在URLSession 导入了一系列新的API 可供您运用Swift并发功能为了展示我们新的API 画面上是我们正在开发以采用async/await的app 这是狗狗爱好者专用的照片共享app 我们可以将这些照片加入最爱这是我们用来提取狗狗照片的现有程序代码它在URLSession上用的是以完成处理程序为基础的轻松方法程序代码看起来清楚明了而且能够在我的有限测试中运作但是它至少有三个错误让我们深入了解吧首先让我们跟着控制流程我们建立了资料数据工作并使其继续工作一完成我们就会进入完成处理程序我们检查响应建立图像这时控制流程就结束了看来我们在来来回回那么线程呢？以这一小段程序代码来说它出乎意料地复杂我们总共有三个不同的执行内容最外层可以在调用端任意的线程或队列上执行 URLSession工作完成处理程序会在会话的委托队列上执行而最后的完成处理程序是在主要队列上执行由于编译器在这里无法派上用场我们必须非常小心避免任何线程问题例如数据争用现在我发现了错误 completionHandler的调用未一致调度至主要队列这可能会成为程序错误另外这里缺少了提早返回如果发生错误 completionHandler 有可能被调用两次这可能会违反调用端所做的假设最后虽然可能不太明显但是UIImage建立有可能失败如果数据格式错误这个UIImage初始化式会回传nil 我们便会调用completionHandler 其中含有nil图像和nil错误这不是我们所预期的现在这是使用async/await的新版本一切都简单多了控制流程从上到下保持连贯我们知道这个函数里的所有程序代码是在相同的并发背景执行因此我们无须再担心线程问题这里我们对URLSession使用了新的async数据方法它暂停了目前的执行内容而无须进行阻挡并成功回传数据和响应或是掷回错误我们也使用throw关键词在得到未预期的回应时掷回错误这可让调用端抓出并处理错误运用Swift原生错误处理最后编译器会吠叫只要我们试图从此函数回传可选UIImage 原则上它会强迫我们正确处理nil 画面上是从网络提取数据时所使用方法的签名 URLSession数据方法可接受URL或URLRequest 它们等同于现有数据工作的轻松方法我们也提供上传方法可让您上传数据或上传档案它们等同于现有上传工作的轻松方法请确保在传送请求前设定正确的HTTP方法因为预设方法GET不支持上传下载方法会将回应本体存为档案而不是存在内存不同于下载工作的轻松方法这些新方法不会自动删除档案因此请别忘记自己执行这个动作在本范例中我们要将档案移至不同位置以进一步处理 Swift并发的取消作业会使用URLSession的async方法其中一种取消方法是使用并发工作处理这里我们调用async 来建立并发工作将两个资源逐一载入之后我们可以使用工作处理取消目前执行的作业请注意并发工作与URLSession工作无关联即使它们共享“工作”这个名称我们刚刚提到的方法数据、上传、下载都会在回传前等着收到整个回应本体如果我们想要渐进式接收回应本体呢？我很荣幸向您介绍 URLSession.bytes方法它们会在收到回应标题时回传并将回应本体作为bytes的AsyncSequence 为了让您了解运作方式我的同事真超将示范他在狗狗app中是如何采用的谢谢你国晔嗨我是真超我持续在开发狗狗app的新功能可以显示多少人将狗狗的照片加入最爱

现在我可以将滚动视图下拉来重新整理最爱计数我想要实时更新这些最爱计数如此一来就能提升app互动性为了实现此目标我们的后端工程师已建立实时事件端点提供我们照片的实时更新内容我要前往端点来检视回应每行响应本体都是一段JSON数据说明了照片的更新内容例如更新的最爱计数让我们使用新的AsyncSequence API 使用端点的响应并在剖析实时事件时更新最爱计数我们可以在onAppearHandler函数中开始实时更新这个动作会在照片集合视图出现时调用在函数内我要调用新的URLSession.bytes API 从我们新的端点提取数据

请注意此处回传的bytes 类型为URLSession.AsyncBytes 这可以让我们渐进式使用回应本体我还在此新增了错误检查确保我们从服务器获得成功的回应

我们要将每行回应作为一段JSON数据剖析若要这么做我们可以在AsyncBytes使用行方法

这可让我们收到数据时逐行使用回应

在循环内我可以直接剖析JSON数据并调用updateFavoriteCount 来更新我的用户界面请注意用户界面更新必须在主要动作项目上执行这就是为什么我要使用await语法调用updateFavoriteCount 也就是async函数好极了现在这些最爱计数已实时更新交还给你吧国晔

真超刚刚让我们看到了如何使用 AsyncSequence内建转换这些行可以用来逐行剖析响应本体 AsyncSequence支持许多轻松的转换您还可以一起使用AsyncSequence 和其他系统框架API 如FileHandle 若要深入了解AsyncSequence 我推荐您观看影片 “认识AsyncSequence” URLSession是以委托模型设计可为事件提供回调函数例如验证挑战、矩阵还有更多功能新的async方法不会再公开基础工作那么我们该如何处理某个工作特定的验证挑战呢？是的所有这些方法都能涵盖额外的自变量亦即工作特定委托可让您提供对象来处理数据、上传、下载或字节作业特定的委托信息我们也在Objective-C的 NSURLSessionTask导入了委托属性让您运用相同的功能委托会由工作负责处理直到工作完成或失败值得注意的是背景URLSession 不支持工作特定委托若会话委托和工作委托皆已建置方法则系统会调用工作委托上的方法现在真超将为我们展示如何使用工作特定委托来处理验证挑战谢谢你国晔我们的狗狗app 具有简易的数据提取层它是使用新的async API写入的针对一些数据提取工作例如将照片标记为最爱或提取所有加入最爱的照片用户需要经过验证现在当我点击照片来加入最爱我会收到“未授权”错误我们来了解该如何使用工作特定委托新增用户验证首先写入URLSessionTaskDelegate 我们将它称为AuthenticationDelegate吧 AuthenticationDelegate会符合 URLSessionTaskDelegate协定并会在其初始化式中接受signInController实例我们建置的 signInController类别已经包含实用的helper函数可让我们用来提示用户进行认证接着我们来建置URLSession didReceive challenge委托方法

在委托方法内我们可以选择响应 HTTP基础验证挑战只要提示用户进行认证即可当然我们不能忘记错误处理现在将AuthenticationDelegate类别作为我们的工作特定委托若要执行此动作我可以直接将其实例进行实例化并作为URLSession.data方法的委托参数进行剖析请注意委托对象不是实例变量且会由工作负责处理直到工作完成或失败此处的新功能在于委托可以用来处理URLSession工作实例特定的事件这点非常方便当委托方法内的逻辑只能套用至特定URLSession工作而无法套用于其他部分太好了现在当我们点击照片来加入最爱

就会弹出登入窗体

登入后照片便会显示已加入最爱并且已新增至最爱照片集合交还给你吧国晔真超谢谢你的示范我们等不及让您试一试 URLSession与async/await 我们推荐您套用相同的async概念来改善您的程序代码包含变更函数将完成处理程序变更为async函数并将重复事件处理程序变更为AsyncSequence 若要了解更多URLSession的改进我们有一部影片是关于前卫的全新instrument 负责检验您app的HTTP流量还有一部影片是关于 URLSession中的HTTP/3支持谢谢大家祝您有个愉快的WWDC体验 ♪

2:52 - Fetch photo with async/await

// Fetch photo with async/await

func fetchPhoto(url: URL) async throws -> UIImage
{
    let (data, response) = try await URLSession.shared.data(from: url)

    guard let httpResponse = response as? HTTPURLResponse,
          httpResponse.statusCode == 200 else {
        throw WoofError.invalidServerResponse
    }

    guard let image = UIImage(data: data) else {
        throw WoofError.unsupportedImage
    }

    return image
}

3:45 - URLSession.data

let (data, response) = try await URLSession.shared.data(from: url)
guard let httpResponse = response as? HTTPURLResponse,
      httpResponse.statusCode == 200 /* OK */ else {
    throw MyNetworkingError.invalidServerResponse
}

4:03 - URLSession.upload

var request = URLRequest(url: url)
request.httpMethod = "POST"

let (data, response) = try await URLSession.shared.upload(for: request, fromFile: fileURL)
guard let httpResponse = response as? HTTPURLResponse,
      httpResponse.statusCode == 201 /* Created */ else {
    throw MyNetworkingError.invalidServerResponse
}

4:21 - URLSession.download

let (location, response) = try await URLSession.shared.download(from: url)
guard let httpResponse = response as? HTTPURLResponse,
      httpResponse.statusCode == 200 /* OK */ else {
    throw MyNetworkingError.invalidServerResponse
}

try FileManager.default.moveItem(at: location, to: newLocation)

4:44 - Cancellation

let task = Task {
    let (data1, response1) = try await URLSession.shared.data(from: url1)

    let (data2, response2) = try await URLSession.shared.data(from: url2)

}

task.cancel()

7:53 - asyncSequence demo

let (bytes, response) = try await URLSession.shared.bytes(from: Self.eventStreamURL)
guard let httpResponse = response as? HTTPURLResponse, httpResponse.statusCode == 200 else {
    throw WoofError.invalidServerResponse
}
for try await line in bytes.lines {
    let photoMetadata = try JSONDecoder().decode(PhotoMetadata.self, from: Data(line.utf8))
    await updateFavoriteCount(with: photoMetadata)
}

11:20 - task specific delegate demo

class AuthenticationDelegate: NSObject, URLSessionTaskDelegate {
    private let signInController: SignInController
    
    init(signInController: SignInController) {
        self.signInController = signInController
    }
    
    func urlSession(_ session: URLSession,
                    task: URLSessionTask,
                    didReceive challenge: URLAuthenticationChallenge) async
    -> (URLSession.AuthChallengeDisposition, URLCredential?) {
        if challenge.protectionSpace.authenticationMethod == NSURLAuthenticationMethodHTTPBasic {
            do {
                let (username, password) = try await signInController.promptForCredential()
                return (.useCredential,
                        URLCredential(user: username, password: password, persistence: .forSession))
            } catch {
                return (.cancelAuthenticationChallenge, nil)
            }
        } else {
            return (.performDefaultHandling, nil)
        }
    }
}

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