Combine實現(xiàn)連續(xù)請求

這篇文章給大家演示通過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()
    }
}

首先來看這部分代碼锈至, 我們一步一步的進行分析:

  1. 返回值 AnyPublisher<[Location], Never> 代表什么意思晨缴?
    AnyPublisher<Output, Failure>是一個泛型類,Output代表的是管道中流動的數(shù)據(jù)類型峡捡,F(xiàn)ailure代表的是管道中可能會發(fā)生的錯誤击碗。我們這個搜索函數(shù)返回的是地址集合,所以 Output 定義為 [ [Location]们拙,我們先簡單來做稍途,忽略發(fā)生的錯誤,所以 Failure 定義為了 Never砚婆,代表永遠不會發(fā)生錯誤械拍,至于為什么是AnyPublisher我們下面再說。

  2. 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)很明確了。

  3. 為什么要對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。

  4. 為什么要使用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也獲得了編譯器的同意篇亭。

  5. 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ù)增加了對錯誤的處理招盲。接下來低缩,我們主要解釋如何對錯誤進行處理。

  1. tryMap vs map
    tryMap 和 map 意義是一樣的,唯一的不同是tryMap允許閉包中throw錯誤咆繁。在這里讳推,我們簡單判斷下響應碼==200,其余的都拋出URLError(.badServerResponse)異常玩般。如果響應碼==200银觅,我們就繼續(xù)對data進行decoder,得到相應的數(shù)據(jù)坏为。

  2. 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ù)吧


WX20220119-232335@2x.png

如果你有什么疑問或者更好的思路,請在留言區(qū)提出涂臣,謝謝盾计!

?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末售担,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子署辉,更是在濱河造成了極大的恐慌族铆,老刑警劉巖,帶你破解...
    沈念sama閱讀 211,348評論 6 491
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件哭尝,死亡現(xiàn)場離奇詭異哥攘,居然都是意外死亡,警方通過查閱死者的電腦和手機材鹦,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,122評論 2 385
  • 文/潘曉璐 我一進店門献丑,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人侠姑,你說我怎么就攤上這事创橄。” “怎么了莽红?”我有些...
    開封第一講書人閱讀 156,936評論 0 347
  • 文/不壞的土叔 我叫張陵妥畏,是天一觀的道長。 經(jīng)常有香客問我安吁,道長醉蚁,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,427評論 1 283
  • 正文 為了忘掉前任鬼店,我火速辦了婚禮网棍,結果婚禮上,老公的妹妹穿的比我還像新娘妇智。我一直安慰自己滥玷,他們只是感情好,可當我...
    茶點故事閱讀 65,467評論 6 385
  • 文/花漫 我一把揭開白布巍棱。 她就那樣靜靜地躺著惑畴,像睡著了一般。 火紅的嫁衣襯著肌膚如雪航徙。 梳的紋絲不亂的頭發(fā)上如贷,一...
    開封第一講書人閱讀 49,785評論 1 290
  • 那天,我揣著相機與錄音到踏,去河邊找鬼杠袱。 笑死,一個胖子當著我的面吹牛窝稿,可吹牛的內容都是我干的楣富。 我是一名探鬼主播,決...
    沈念sama閱讀 38,931評論 3 406
  • 文/蒼蘭香墨 我猛地睜開眼讹躯,長吁一口氣:“原來是場噩夢啊……” “哼菩彬!你這毒婦竟也來了?” 一聲冷哼從身側響起潮梯,我...
    開封第一講書人閱讀 37,696評論 0 266
  • 序言:老撾萬榮一對情侶失蹤骗灶,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后秉馏,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體耙旦,經(jīng)...
    沈念sama閱讀 44,141評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 36,483評論 2 327
  • 正文 我和宋清朗相戀三年萝究,在試婚紗的時候發(fā)現(xiàn)自己被綠了免都。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,625評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡帆竹,死狀恐怖绕娘,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情栽连,我是刑警寧澤险领,帶...
    沈念sama閱讀 34,291評論 4 329
  • 正文 年R本政府宣布,位于F島的核電站秒紧,受9級特大地震影響绢陌,放射性物質發(fā)生泄漏。R本人自食惡果不足惜熔恢,卻給世界環(huán)境...
    茶點故事閱讀 39,892評論 3 312
  • 文/蒙蒙 一脐湾、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧叙淌,春花似錦秤掌、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,741評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至衅谷,卻和暖如春椒拗,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背获黔。 一陣腳步聲響...
    開封第一講書人閱讀 31,977評論 1 265
  • 我被黑心中介騙來泰國打工蚀苛, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人玷氏。 一個月前我還...
    沈念sama閱讀 46,324評論 2 360
  • 正文 我出身青樓堵未,卻偏偏與公主長得像,于是被迫代替她去往敵國和親盏触。 傳聞我的和親對象是個殘疾皇子渗蟹,可洞房花燭夜當晚...
    茶點故事閱讀 43,492評論 2 348

推薦閱讀更多精彩內容