
作者:@請叫我汪二,授權本站轉載。
最近在新項目裡嘗試用 Moya + RxSwift + Argo 做網絡請求與解析,整體體驗很不錯,值得再安利一次。
Moya 是基於 Alamofire 的上層封裝,深入內容建議直接看官方文檔 Moya/Docs。接入之後,請求大致長這樣:
provider.request(.UserProfile("ashfurrow")) { (data, statusCode, response, error) in
if let data = data {
// do something with the data
}
}Moya 提供了不少實用特性,我最喜歡的是 stub,配合 sampleData,單元測試幾分鐘就能搭起來:
private let provider = MoyaProvider(stubClosure: MoyaProvider.ImmediatelyStub)
這裡的 MoyaProvider.ImmediatelyStub 有點意思。我以為它是枚舉,翻 MoyaProvider 定義才發現該位置要傳的是 closure,再看 ImmediatelyStub 原來是個類方法:
public typealias StubClosure = Target -> Moya.StubBehavior
override public init(stubClosure: StubClosure = MoyaProvider.NeverStub, ...) { }
public final class func ImmediatelyStub(_: Target) -> Moya.StubBehavior {
return .Immediate
}想打印每次請求的參數,在組裝 endpoint 時順手輸出即可:
private func endpointMapping(target: Target) -> Endpoint {
if let parameters = target.parameters {
log.verbose("\(parameters)")
}
return MoyaProvider.DefaultEndpointMapping(target)
}
private let provider = RxMoyaProvider(endpointClosure: endpointMapping)RxSwift 我前面已經安利過兩輪,這裡不再重複。Moya 自帶 RxSwift 擴展,能與 ReactiveCocoa 無縫對接,於是打開方式變成這樣:
private let provider = RxMoyaProvider()
private var disposeBag = DisposeBag()
extension ItemAPI {
static func getNewItems(completion: [Item] -> Void) {
disposeBag = DisposeBag()
provider
.request(.GetItems())
.subscribe(
onNext: { items in
completion(items)
}
)
.addDisposableTo(disposeBag)
}
}Moya 的核心開發者、同時也是 Artsy 成員的 Ash Furrow,曾在 AltConf 做過一次《Functional Reactive Awesomeness With Swift》的分享,很值得一看。
Argo 是 thoughtbot 開源的函數式 JSON 解析庫。提到 thoughtbot,就不得不說他們那一系列質量頗高的解析文章:
Argo 基本就是沿著這些文章的思路寫出來的,配套還有 Runes 和 Curry。使用起來頗有意思:
struct Item {
let id: String
let url: String
}
extension Item: Decodable {
static func decode(j: JSON) -> Decoded<Item> {
return curry(Item.init)
<| "id"
<| "url"
}
}那些符號的由來,上面幾篇博客裡都有講解,讀起來還挺過癮。
三個庫說完,怎麼把它們接成一個整體?Emergence 中的 Observable/Networking 給出了答案。整理後大致如下:
enum ORMError: ErrorType {
case ORMNoRepresentor
case ORMNotSuccessfulHTTP
case ORMNoData
case ORMCouldNotMakeObjectError
}
extension Observable {
private func resultFromJSON(object: [String: AnyObject], classType: T.Type) -> T? {
let decoded = classType.decode(JSON.parse(object))
switch decoded {
case .Success(let result):
return result as? T
case .Failure(let error):
log.error("\(error)")
return nil
}
}
func mapSuccessfulHTTPToObject(type: T.Type) -> Observable<T> {
return map { representor in
guard let response = representor as? MoyaResponse else {
throw ORMError.ORMNoRepresentor
}
guard ((200...209) ~= response.statusCode) else {
if let json = try? NSJSONSerialization.JSONObjectWithData(response.data, options: .AllowFragments) as? [String: AnyObject] {
log.error("Got error message: \(json)")
}
throw ORMError.ORMNotSuccessfulHTTP
}
do {
guard let json = try NSJSONSerialization.JSONObjectWithData(response.data, options: .AllowFragments) as? [String: AnyObject] else {
throw ORMError.ORMCouldNotMakeObjectError
}
return self.resultFromJSON(json, classType: type)!
} catch {
throw ORMError.ORMCouldNotMakeObjectError
}
}
}
func mapSuccessfulHTTPToObjectArray(type: T.Type) -> Observable<[T]> {
return map { response in
guard let response = response as? MoyaResponse else {
throw ORMError.ORMNoRepresentor
}
// 只接受 2xx
guard ((200...209) ~= response.statusCode) else {
if let json = try? NSJSONSerialization.JSONObjectWithData(response.data, options: .AllowFragments) as? [String: AnyObject] {
log.error("Got error message: \(json)")
}
throw ORMError.ORMNotSuccessfulHTTP
}
do {
guard let json = try NSJSONSerialization.JSONObjectWithData(response.data, options: .AllowFragments) as? [[String: AnyObject]] else {
throw ORMError.ORMCouldNotMakeObjectError
}
// 無法保證每個元素都能解析,因此不能直接 map
var objects = [T]()
for dict in json {
if let obj = self.resultFromJSON(dict, classType: type) {
objects.append(obj)
}
}
return objects
} catch {
throw ORMError.ORMCouldNotMakeObjectError
}
}
}
}這樣調用起來就舒服多了,仍以前面的 Item 為例:
private let provider = RxMoyaProvider()
private var disposeBag = DisposeBag()
extension ItemAPI {
static func getNewItems(records: [Record] = [], needCount: Int, completion: [Item] -> Void) {
disposeBag = DisposeBag()
provider
.request(.AddRecords(records, needCount))
.mapSuccessfulHTTPToObjectArray(Item)
.subscribe(
onNext: { items in
completion(items)
}
)
.addDisposableTo(disposeBag)
}
}一個 mapSuccessfulHTTPToObjectArray 就把 JSON 直接變成了 [Item] 進入下游隊列,onNext 拿到的已經是模型對象。更關鍵的是這個轉換過程可複用,適用於所有請求中 JSON 到 Model 的轉換。爽就一個字,我只說一次。
爽!
匆匆翻了些 Emergence 和 Eidolon 的源碼,沒深入但已受益匪淺。用 bundle 管理 id 和 key 的做法,直接解決了我糾結很久的問題:完整項目開源時如何優雅地保留 git 記錄又保護隱私。而 Moya/RxSwift、Moya/ReactiveCocoa 這種子模塊化處理,也在共有模塊管理上給了我一些啟發。
很喜歡 Artsy 這樣的團隊,大家一起做自己喜歡的事,還能站著把錢賺了。所幸的是我現在也能做喜歡的事了,雖然不賺錢——具體情況以後單獨開一篇閒扯。
碎告。
參考資料:RxSwift、Moya、Argo、Emergence、Eidolon,以及 thoughtbot 的上述四篇 JSON 解析文章。