直到现在为止,如果我们想要异步请求数据,应该说至少有三种方式:
- 传统的通过闭包(
@escaping closure
)方式回调处理。 - 通过
Combine
的发布者订阅者机制。 - 通过
async/await
组合的方式。
采用哪种方式,还得因项目而异,本文将对这三种方式做一个简单的总结,以及代码示例。
下面就以下载一个网络图片为例。
首先还是要先定义一个界面和一个对应的ViewModel:
struct DownloadImageDemo: View {
@StateObject private var viewModel = DownloadImageDemoViewModel()
var body: some View {
ZStack {
if let image = viewModel.image {
Image(uiImage: image)
.resizable()
.scaledToFit()
.frame(width: 200, height: 200)
}
}
.onAppear {
}
}
}
class DownloadImageDemoViewModel: ObservableObject {
@Published var image: UIImage?
var downloader: ImageDownloader = ImageDownloader()
func fetchImageWithEscapingClosure() {
}
func fetchImageWithCombine() {
}
func fetchImageWithAsnynAndAwait() {
}
}
在ViewModel中我们先定义了三个方法,分别用于处理不同的请求,另外为了更加符合项目,将图片下载逻辑放到一个我们模拟的网络层处理ImageDownloader
。
class ImageDownloader {
let url = URL(string: "https://picsum.photos/200")!
}
至此基本的代码逻辑已经完成,下面重点看一下下载部分的代码,这部分代码统一在ImageDownloader
中处理。
escaping closure方式
class ImageDownloader {
let url = URL(string: "https://picsum.photos/200")!
func handleResponse(data: Data?, response: URLResponse?) -> UIImage? {
guard let data,
let image = UIImage(data: data),
let response = response as? HTTPURLResponse,
response.statusCode >= 200 && response.statusCode < 300 else {
return nil
}
return image
}
func fetchImageWithEscapingClosure(_ completion: @escaping (UIImage?, Error?) -> Void) {
URLSession.shared.dataTask(with: URLRequest(url: url)) { [weak self] data, response, error in
let image = self?.handleResponse(data: data, response: response)
completion(image, error)
}
.resume()
}
}
在上面的代码中,我们在ImageDownloader
中定义了fetchImageWithEscapingClosure
方法,其参数为一个逃逸闭包,用于返回网络请求的结果,想必都不陌生了。
为了简化代码,这里面将错误处理单独拿出来放到handleResponse
中处理,并返回一个可选的UIImage
。
在ViewModel中的方法中调用如下:
func fetchImageWithEscapingClosure() {
downloader.fetchImageWithEscapingClosure { [weak self] image, _ in
self?.image = image
}
}
SwiftUI界面调用如下:
struct DownloadImageDemo: View {
@StateObject private var viewModel = DownloadImageDemoViewModel()
var body: some View {
ZStack {
if let image = viewModel.image {
Image(uiImage: image)
.resizable()
.scaledToFit()
.frame(width: 200, height: 200)
}
}
.onAppear {
viewModel.fetchImageWithEscapingClosure()
}
}
}
Combine方式
首先在ImageDownloader
中定义一个方法,具体如下:
func fetchImageWithCombine() -> AnyPublisher<UIImage? ,Error> {
URLSession.shared.dataTaskPublisher(for: url)
.map(handleResponse)
.mapError({ $0 })
.eraseToAnyPublisher()
}
该方法返回了一个AnyPublisher
类型,并定义好泛型类型,以便调用的地方订阅。
URLSession.shared.dataTaskPublisher
方法返回了一个Publisher
,这样我们可以继续往下走,使用map
操作符去做一些类型转换,这里在map
操作符里面使用了之前定义的handleResponse
方法。因为map
方法闭包返回的参数和handleResponse
接收的参数相同,所以可以简写,如下图:
另外在map
操作符后还用了mapError
操作符,将错误类型转换,否则就会报下面的错误:
主要原因是我们尝试将一个返回AnyPublisher<UIImage?, URLError>
类型的表达式转换为返回AnyPublisher<UIImage?, Error>
类型的表达式,但类型不匹配。
可以通过使用.mapError
操作符来转换错误类型,将URLError
转换为Error
,以使类型匹配。
最后使用eraseToAnyPublisher()
类型抹除到统一的AnyPublisher
。
下面在看看调用订阅的地方,在ViewModel中定义了如下方法:
func fetchImageWithCombine() {
downloader.fetchImageWithCombine()
.sink { _ in
} receiveValue: { [weak self] image in
self?.image = image
}
.store(in: &cancellable)
}
通过sink添加订阅者,并处理收到的信息,最后别忘了store
,否则出了方法作用域订阅就失效了。
在UI部分调用也是非常简单:
struct DownloadImageDemo: View {
@StateObject private var viewModel = DownloadImageDemoViewModel()
var body: some View {
ZStack {
if let image = viewModel.image {
Image(uiImage: image)
.resizable()
.scaledToFit()
.frame(width: 200, height: 200)
}
}
.onAppear {
// viewModel.fetchImageWithEscapingClosure()
viewModel.fetchImageWithCombine()
}
}
}
async/await方式
async/await
方式就用到了上一篇文章中说到的内容了。
首先还是处理网络层ImageDownloader
,在其中添加方法,如下:
func fetchImageWithAsyncAndAwait() async throws -> UIImage? {
do {
let (data, response) = try await URLSession.shared.data(from: url)
return handleResponse(data: data, response: response)
} catch {
throw error
}
}
上面这个方法在方法名的后面添加了async
,告诉系统这是个异步方法,另外还添加了throws
,当错误的时候抛出异常。
在选择URLSession.shared
的方法的时候我们看到有下面的这个方法,系统同样提供了一个异步的且抛出异常的data()
方法。
所以我们也按照系统的规则去写。方法里面的do-catch
等逻辑之前文章有介绍,这里就不多说了。
下面在ViewModel调用的方法里面,调用上面这个方法。
func fetchImageWithAsnynAndAwait() async {
let image = try? await downloader.fetchImageWithAsyncAndAwait()
await MainActor.run {
self.image = image
}
}
这个方法我们只是添加了async
,并没有throws
,这里我们暂时忽略异常错误,方法里面也用到了try?
。
调用async
的异步方法,需要在前面加上await
,并且刷新UI要回主线程哦。
最后就是在界面调用了:
struct DownloadImageDemo: View {
@StateObject private var viewModel = DownloadImageDemoViewModel()
var body: some View {
ZStack {
if let image = viewModel.image {
Image(uiImage: image)
.resizable()
.scaledToFit()
.frame(width: 200, height: 200)
}
}
.onAppear {
// viewModel.fetchImageWithEscapingClosure()
// viewModel.fetchImageWithCombine()
Task {
await viewModel.fetchImageWithAsnynAndAwait()
}
}
}
}
因为调用异步方法需要在异步上下文环境中,所以我们将调用方法放到了Task
闭包中。关于Task
下一篇文章将重点介绍一下。
写在最后
本篇文章主要回顾了一下三种异步请求方式,@escaping closure
, Combine
, async/await
这三种方式,并做了一些代码示例,无论采用哪种方法,都是因人而异,因项目而异,不过还是希望大家跟上最新的步伐,让自己的代码更高效,更稳健,更易维护。
最后,希望能够帮助到有需要的朋友,如果觉得有帮助,还望点个赞,添加个关注,笔者也会不断地努力,写出更多更好用的文章。