這篇文章給大家演示通過Combine來處理連續(xù)的網(wǎng)絡請求舶衬,場景是這樣子:首先進行A請求,然后通過A請求的結果進行B請求,最后展示B請求返回的結果箱亿。 大家可以回想一下,在沒有Combine的時代弃秆,我們是通過closure嵌套來實現(xiàn)這種需求届惋,接下來通過使用Combine來實現(xiàn),大家可以對比一下兩種方式的優(yōu)劣菠赚。
我們演示的 demo 網(wǎng)絡請求接口使用的是 http://www.MetaWeather.com 提供的測試API脑豹。
struct ClientWeather {
// url: https://www.metaweather.com/api/location/search/?query=san
// 通過query進行地址搜索,返回搜索到的地址集合
static func searchLocation(query: String) -> AnyPublisher<[Location], Never> {
var components = URLComponents(string: "https://www.metaweather.com/api/location/search")!
components.queryItems = [URLQueryItem(name: "query", value: query)]
return URLSession.shared.dataTaskPublisher(for: components.url!)
.map { data, _ in data }
.decode(type: [Location].self, decoder: jsonDecoder)
.catch { _ in Just([]) }
.eraseToAnyPublisher()
}
}
首先來看這部分代碼锈至, 我們一步一步的進行分析:
返回值 AnyPublisher<[Location], Never> 代表什么意思晨缴?
AnyPublisher<Output, Failure>是一個泛型類,Output代表的是管道中流動的數(shù)據(jù)類型峡捡,F(xiàn)ailure代表的是管道中可能會發(fā)生的錯誤击碗。我們這個搜索函數(shù)返回的是地址集合,所以 Output 定義為 [ [Location]们拙,我們先簡單來做稍途,忽略發(fā)生的錯誤,所以 Failure 定義為了 Never砚婆,代表永遠不會發(fā)生錯誤械拍,至于為什么是AnyPublisher我們下面再說。URLSession.shared.dataTaskPublisher(for: components.url!)
Combine對URLSession擴展了dataTaskPublisher(for url: URL) -> URLSession.DataTaskPublisher函數(shù)装盯,顧名思義函數(shù)返回的是一個Publisher坷虑,當我看到一個API會返回一個Publisher的時候,我第一件事就是要去確定Publisher攜帶的數(shù)據(jù)類型以及可能會產(chǎn)生的錯誤類型埂奈。
public typealias Output = (data: Data, response: URLResponse)
public typealias Failure = URLError
通過這兩段代碼可以確定URLSession.DataTaskPublisher中攜帶的數(shù)據(jù)類型以及會產(chǎn)生的錯誤類型迄损,至此我們對URLSession.DataTaskPublisher已經(jīng)很明確了。為什么要對URLSession.DataTaskPublisher進行map操作账磺?
我們先來簡略看一下map操作符芹敌,在平時我們使用map操作大多數(shù)場景是對數(shù)據(jù)類型進行轉換,比如[Int] -> [String]垮抗。其實在Combine的世界里氏捞,map操作的意思也非常類似,通過map操作符我們可以對Publisher攜帶的數(shù)據(jù)類型進行轉換冒版。
map { data, _ in data }
我們來分析下這行代碼液茎,上面我們提到過URLSession.DataTaskPublisher攜帶的數(shù)據(jù)類型是(Data, URLResponse)元祖類型,因為我們先從簡單起步,忽略了網(wǎng)絡請求過程中會發(fā)生的錯誤豁护,認為網(wǎng)絡請求一定會成功且數(shù)據(jù)準確哼凯,所以我們不關心URLResponse,我們只需要拿到Data進行Decode楚里,解析為最終我們想要的[Location]類型断部。所以我們要對URLSession.DataTaskPublisher攜帶的數(shù)據(jù)類型進行轉換:(Data, URLResponse) -> Data。為什么要使用catch操作符班缎?
我們需求Publisher永遠不會產(chǎn)生Error蝴光,但是無論是dataTaskPublisher還是decode都有可能產(chǎn)生相應的錯誤(比如URL404,decode失敗等)达址,那么catch操作符的作用就是來捕獲這些錯誤并且要求返回值是一個Publisher蔑祟。當產(chǎn)生錯誤時,我們默認返回一個空的Location集合沉唠,所以我們就使用Just([])疆虚,有的同學目前可能不理解Just,我們可以簡單理解就是一個立馬發(fā)出初始值的Publisher满葛,它和catch配合是很常見的場景径簿。通過catch操作,我們保證了我們的管道中不會向訂閱者發(fā)出任何錯誤嘀韧,這樣我們把Error定義了Never也獲得了編譯器的同意篇亭。eraseToAnyPublisher
最后解釋為什么要eraseToAnyPublisher,erase 顧名思義是擦除的意思锄贷,我們怎么理解這個操作符呢译蒂。經(jīng)過上面幾種操作符的使用,我們的Publisher其實是一個很復雜的類型了
Publishers.Catch<Publishers.Decode<Publishers.Map<URLSession.DataTaskPublisher, JSONDecoder.Input>, [Location], JSONDecoder>, Just<[Location]>>
看到這種類型的你是否開始有點不舒服了谊却,對于函數(shù)的使用者來說只需要知道返回的是一個Publisher以及Output和Error的類型柔昼,我能去訂閱就好了,我不需要知道你Publisher具體是什么類型炎辨,所以我們通過eraseToAnyPublisher操作把Publisher類型轉換為AnyPublisher捕透。
怎么樣,看到這里蹦魔,你是否對searchLocation函數(shù)每一步的操作都非常明確了呢激率?接下來咳燕,我們再來定義一個函數(shù)勿决,根據(jù)LocationId獲取當前的天氣信息
// https://www.metaweather.com/api/location/2487956/
static func weather(with locationId: Int) -> AnyPublisher<LocationWeather, ClientWeatherError> {
let url = URL(string: "https://www.metaweather.com/api/location/\(locationId)")!
return URLSession.shared.dataTaskPublisher(for: url)
.tryMap { data, response in
guard let response = response as? HTTPURLResponse,
response.statusCode == 200 else {
throw URLError(.badServerResponse)
}
return data
}
.decode(type: LocationWeather.self, decoder: jsonDecoder)
.mapError { error -> ClientWeatherError in
switch error {
case is URLError:
return .serverResponse(error)
case is DecodingError:
return .decodeFailed
default:
return .unknown
}
}
.eraseToAnyPublisher()
}
enum ClientWeatherError: Error, CustomStringConvertible {
case decodeFailed
case serverResponse(Error)
case unknown
var description: String {
switch self {
case .decodeFailed:
return "數(shù)據(jù)解碼失敗"
case .serverResponse(let error):
return "服務相應錯誤:\(error.localizedDescription)"
case .unknown:
return "未知錯誤"
}
}
}
這部分代碼和上面我們講解的方法類似,不同的地方就是這個函數(shù)增加了對錯誤的處理招盲。接下來低缩,我們主要解釋如何對錯誤進行處理。
tryMap vs map
tryMap 和 map 意義是一樣的,唯一的不同是tryMap允許閉包中throw錯誤咆繁。在這里讳推,我們簡單判斷下響應碼==200,其余的都拋出URLError(.badServerResponse)異常玩般。如果響應碼==200银觅,我們就繼續(xù)對data進行decoder,得到相應的數(shù)據(jù)坏为。mapError
顧名思義究驴,mapError是用來對Error類型進行轉換,轉換為我們自己定義的ClientWeatherError類型匀伏,這樣我們就可以遍歷Error case洒忧,展示不同的錯誤界面。
至此够颠,我們兩個網(wǎng)絡請求的函數(shù)都已經(jīng)定義完畢熙侍,它們都是返回相應的Publisher。在Combine之前履磨,它們應該都要接受一個escaping closure蛉抓,當網(wǎng)絡請求結束回來,調用closure蹬耘。
接下來芝雪,讓我們來把兩個網(wǎng)絡請求進行串聯(lián)起來。我們定義一個函數(shù)综苔,根據(jù)輸入的地址名字搜索惩系,用搜索的結果第一個地址獲取當前的天氣狀況
static func searchLocationWeather(with query: String) -> AnyPublisher<LocationWeather, ClientWeatherError> {
searchLocation(query: query)
.flatMap { locations -> AnyPublisher<LocationWeather, ClientWeatherError> in
if let location = locations.first {
return weather(with: location.id)
} else {
return Fail(outputType: LocationWeather.self, failure: ClientWeatherError.searchEmpty).eraseToAnyPublisher()
}
}
.eraseToAnyPublisher()
}
這個函數(shù)難以理解的就是flatMap,這個操作符允許把searchLocation(query: query)輸出的值轉換為另外一個Publisher如筛,在我們的需求就是轉換為weather(with)堡牡,另外我們還需要判斷 searchLocation是否查詢的為空,如果為空杨刨,我們直接返回Fail晤柄,它也是一個Publisher,只不過它只是會發(fā)出一個Error妖胀。
到現(xiàn)在芥颈,我們就使用Combine完成了兩個網(wǎng)絡請求的串聯(lián)。大家可以回顧一下和我們平時用的closure的不同和優(yōu)劣點赚抡。
最終爬坑,給大家截圖看下如何在SwiftUI中使用我們定義的函數(shù)吧
如果你有什么疑問或者更好的思路,請在留言區(qū)提出涂臣,謝謝盾计!