Swift Moya实践与提升

Moya是什么就不再介绍了,因为网上已经有很多关于Moya的基础使用方法。
Swift:4.1
Moya: 11.0.2
RxSwift: 4.1.2
demo地址:https://github.com/hellolad/RxMoyaDemo

1. Moya TargetType: headers

在以前的Moya版本中,我们要给Reqeust提供Header的时候,TargetType里没有提供给我们直接使用的,所以我们需要使用Endpoint来给Request加上Header

let publicParamEndpointClosure = { (target: AccountService) -> Endpoint<AccountService> in
    let url = target.baseURL.appendingPathComponent(target.path).absoluteString
    let endpoint = Endpoint<AccountService>(url: url, sampleResponseClosure: { .networkResponse(200, target.sampleData) }, method: target.method, parameters: target.parameters, parameterEncoding: target.parameterEncoding)
    return endpoint.adding(newHTTPHeaderFields: ["x-platform" : "iOS", "x-interface-version" : "1.0"])
}

这是以前的老版本中,需要提供Header的时候就需要这样写,非常的复杂和不方便。现在TargetType提供了headers,所以我们可以摆脱这种写法了。

2. RxMoya

Moya支持RxSwift,改变以前的方式也非常的简单,只要在provider后面跟上.rx基本上就可以了.

provider.rx.request(.ip)
    .map(HTTBin.self)
    .subscribe { result in
        switch result {
        case .success(let element):
            guard let bin = element else { return }
            print("useage RxSwift: ", bin.ip)
        case .error(let error):
            print(error.localizedDescription)
        }
    }.disposed(by: bag)

3. Endpoint

在我们的MoyaProvider中提供了三种在初始化Provider的时候的回调参数:

  1. EndpointClosure
  2. RequestResultClosure
  3. RequestClosure
    这三种文章上面给Request提供Headers的时候已经用到了,第二种在项目里,暂时没有用到。下面介绍一下第三种的用法:
    Moya的请求大致可以看做是:Request->Endpoint->Response的过程,中间的Endpoint是给我们开发者留下的最后的可以修改Reqeust的地方,如果你错过了,你就修改不了,下面我们简单的介绍一下,如果在RequestClousre里提供给Request增加超时的操作:
let requestClosure = { (endpoint: Endpoint, closure: @escaping MoyaProvider<HttpbinService>.RequestResultClosure) in
    do {
        var request = try endpoint.urlRequest()
        request.timeoutInterval = 30
        closure(.success(request))
    } catch {
        print("error:", error)
    }
}
let provider = MoyaProvider<HttpbinService>(requestClosure: requestClosure)

然后调用的时候初始化Provider就可以了,这种方式真的是...我感觉写起来很不方便,正好,Moya给我们提供了另一种好东西:Plugin.

4. Plugin

Moya的插件机制非常的好,好在哪里?

  1. 捕获Request的准备
  2. 捕获Request的发送
  3. 捕获Response
  4. 捕获整个从请求到收到结果的过程

如何使用在网上也有很多,我们现在把增加超时的地方从Endpoint的回调里删掉,放在Plugin里

final class Plugin: PluginType {
    func prepare(_ request: URLRequest, target: TargetType) -> URLRequest {
        print("prepare")
        var mRequest = request
        mRequest.timeoutInterval = 10
        return mRequest
    }
}
let provider = MoyaProvider<HttpbinService>(plugins: [Plugin()])

感觉一下子清爽很多,可能我还不太够Swifty
插件机制是一个数组,所以你可以放入多种插件。还有三个函数我就不介绍了。

5. Moya扩展配合 Rx 和 SwiftyJSON 以及 ObjectMapper写出优雅的网络请求

通常我们使用Moya来获取网络请求是这样的:

let provider = MoyaProvider<HttpbinService>()
provider.request(.ip) { (result) in
    switch result {
    case .success(let response):
        do {
            let any = try JSONSerialization.jsonObject(with: response.data, options: .allowFragments)
            guard let obj = any as? [String: Any] else {
                return
            }
            /// 解析数据
        } catch {
            print(error)
        }
    case .failure(let error):
        print(error)
    }
}

这种操作在很多项目里真的好多好多,这样写的缺点是代码耦合性太强,维护起来很难,没有进行封装。有些时候我们可以到Github上找一些大佬封装好的,我们自己看一下源码学习一下,然后实践一下,你会发现我们的代码不管是质量还是可读性都会变强。
两个库:SwiftyJSON(4.1.0), ObjectMapper(3.1.0)写这篇文章的时候,我用的版本。

  • 使用RxMoya提供的函数进行过滤操作
provider.rx.request(.ip)
    .mapJSON()
    .subscribe { result in
        switch result {
        case .success(let element):
            print("element :", element)
        case .error(let error):
            print(error.localizedDescription)
        }
    }.disposed(by: bag)

    }
}
打印:
element : {
    origin = "101.81.57.239";
}

我们使用了RxMoya为我们提供的mapJSON我们很容易就转换成了JSON并且打印出来,非常方便,那我们有没有更快的转换方式,把这个JSON直接转换成Model发送出来,下面我们介绍一下ObjectMapper。

  • 使用ObjectMapper
    我现在进行的api都是从http://httpbin.org上进行的测试.
    ObjectMapper相信大家也都使用过了,看看我们的HTTBin的这个结构体:
struct HTTBin: Mappable {
    var ip: String = ""
    
    init?(map: Map) {}
    mutating func mapping(map: Map) {
        ip <- map["origin"]
    }
}
  • 封装map转换成Model
    现在我们有了SwiftyJSON也有了ObjectMapper两个神器,然后我们就可以去偷学怎么使用了,我们看一下mapJSON的实现
public func mapJSON(failsOnEmptyData: Bool = true) -> Single<Any> {
    return flatMap { response -> Single<Any> in
        return Single.just(try response.mapJSON(failsOnEmptyData: failsOnEmptyData))
    }
}

我只想说三个字:666
通过Single的方式发送出来(还有Observable的方式暂不讨论),发的是Any类型的数据,那我们就可以发出来Mappable的数据,动手:

extension PrimitiveSequence where TraitType == SingleTrait, ElementType == Response {
    func map<T: BaseMappable>(_ type: T.Type) -> Single<T?> {
        return flatMap { response -> Single<T?> in
            do {
                let any = try response.mapJSON()
                guard let dic = any as? [String: Any] else {
                    return Single<T?>.just(nil)
                }
                let mapper = T(JSON: dic)
                return Single<T?>.just(mapper)
                
            } catch {
                return Single<T?>.just(nil)
            }
        }
    }
}

我们通过扩展PrimitiveSequence ,然后定义函数map<T: BaseMappable>(_ type:)来实现发送Mappable的函数,具体实现其实就是拿到response转换成mapJSON,然后转换成字典,最后通过ObjectMapper拿到数据。
具体使用:

provider.rx.request(.ip)
    .map(HTTBin.self)
    .subscribe { result in
        switch result {
        case .success(let element):
            guard let bin = element else { return }
            print("ip :", bin.ip)
        case .error(let error):
            print(error.localizedDescription)
        }
    }.disposed(by: bag)
打印:
ip : 101.81.57.239

这样以来就方便并且快捷很多,非常容易扩展以及维护。

--以此来记录 Swift Moya ^ _^ --

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,457评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,837评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,696评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,183评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,057评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,105评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,520评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,211评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,482评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,574评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,353评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,213评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,576评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,897评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,174评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,489评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,683评论 2 335

推荐阅读更多精彩内容