Moya + RxSwift + ObjectMapper 封装网络请求

provider.rx.request 方法

下面是Moya为对RxSwift提供扩展的源码,它的实现使得我们可以通过provider.rx.request(api)的方式进行网络请求。

request方法的原理是,创建一个 Single 类型对象(只发送一个元素的 Observable),很显然这是一个 Cold Observable,当他被订阅或者由其他事件触发时,provider会执行网络请求方法。当网络请求返回数据时,single通过判断返回结果的类型来发送对应的事件:result.success时,就发送.success事件(是对.next的封装);为.failure时,就发送.error事件。

public extension Reactive where Base: MoyaProviderType {

    /// Designated request-making method.
    ///
    /// - Parameters:
    ///   - token: Entity, which provides specifications necessary for a `MoyaProvider`.
    ///   - callbackQueue: Callback queue. If nil - queue from provider initializer will be used.
    /// - Returns: Single response object.
    public func request(_ token: Base.Target, callbackQueue: DispatchQueue? = nil) -> Single<Response> {
        return Single.create { [weak base] single in
            let cancellableToken = base?.request(token, callbackQueue: callbackQueue, progress: nil) { result in
                switch result {
                case let .success(response):
                    single(.success(response))
                case let .failure(error):
                    single(.error(error))
                }
            }

            return Disposables.create {
                cancellableToken?.cancel()
            }
        }
    }
}

上面的方法返回了一个Single<Response>,然后可以通过mapJSON()方法将Response元素转为字典或数组。

封装 ObjectMapper

mapJSON后获得的字典或数组可以通过map方法,进一步转化为 Mappable 模型或元素为Mappable模型的数组。解析出错时,就抛出error,这里我的做法是,定义一个特殊数值的code,表示服务器的数据返回有误。

extension Observable {
    
    /// 将字典转为model
    public func mapObject<T: Mappable>(type: T.Type) -> Observable<T> {
        return self.map { response in
            guard let dict = response as? [String: Any] else {
                throw self.parseError(response: response)
            }
            
            guard let model = Mapper<T>().map(JSON: dict) else {
                throw self.parseError(response: response)
            }
            return model
        }
    }
    
    /// 将字典数组转为model数组
    public func mapArray<T: Mappable>(type: T.Type) -> Observable<[T]> {
        return self.map { response in
            guard let array = response as? [[String: Any]] else {
                throw self.parseError(response: response)
            }
            return Mapper<T>().mapArray(JSONArray: array)
        }
    }
    
    /// 抛出解析的错误
    private func parseError(response: Any) -> MoyaError {
        if let _response = response as? Response {
            return MoyaError.statusCode(_response)
        }
        
        // 解析失败时,作为服务器响应错误处理
        let data = try? JSONSerialization.data(withJSONObject: response, options: [])
        let _response = Response(statusCode: 555, data: data ?? Data())
        return MoyaError.statusCode(_response)
    }
}

Single 扩展

如果想在网络请求返回Response以后做些统一的操作,例如后台规定假如返回一个code字段,数值等于4000时,表示用户登录的Token失效,需要退出登录,那么可以模仿mapJSON的做法,对Single<Response>添加一个扩展方法来处理。然后结合上面的mapObjectmapArray方法,就可以愉快地使用moya进行链式地网络操作了。

extension PrimitiveSequence where TraitType == SingleTrait, ElementType == Response {
    func mapObjectResponse<T: Mappable>(type: T.Type) -> Observable<T> {
        return self.mapResponse(complete: complete).mapObject(type: type)
    }
    
    func mapArrayResponse<T: Mappable>(type: T.Type) -> Observable<[T]> {
        return self.mapResponse(complete: complete).mapArray(type: type)
    }
    
    private func mapResponse() -> Observable<Any> {
        return self.map({ (res) in
                // 处理Response
                handleResponse(response: res)
            return res
        })
            .mapJSON()// Response 转 Foundation 对象
            .debug()
            .asObservable()
    }
}

使用范例:

provider.rx.request(HomeAPI.home)
        .mapObjectResponse(type: HomeModel.self)
        .subscribe(onNext: { (model) in
            print("请求成功", model)
        }, onError: { (err) in
            print("请求错误", err)
        }, onCompleted: {
            print("请求结束")
        }).disposed(by: disposeBag)

如何取消请求操作?

日常使用中,网络请求一般是由其他事件触发的,例如点击一个搜索按钮:

_ = button.rx.tap
       .flapMap { _ in provider.rx.request(MyAPI.search) }

如果在搜索结果未返回之前,搜索条件改变了,我们需要触发新的请求,那么这时候就有必要取消掉上次的网络请求。回头看看rx.request方法,在源码中,返回Disposables时,同时对当前的网络请求进行了cancel操作。

return Disposables.create {
    cancellableToken?.cancel()
}

所以我们在新的请求出现时,只需要让上一次的请求事件dispose掉就好了。而这里我们可以使用flatMapLatest来实现。flatMapLatest等于flatMapswitchLatest的效果。

switchLatest
_ = button.rx.tap
       .flapMapLatest { _ in provider.rx.request(MyAPI.search) }

有时候我们只需要取消一个请求操作,这时肯定有一个取消的事件,例如cancelEvent = Variable(true),当这个事件发生时,就表示我们要主动取消请求,使用takeUntil即可。

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,601评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,520评论 25 707
  • 国家电网公司企业标准(Q/GDW)- 面向对象的用电信息数据交换协议 - 报批稿:20170802 前言: 排版 ...
    庭说阅读 10,869评论 6 13
  • 一: 连续写作三十天的训练营已有人陆续落下,退出营了。 三十天已经过去一半!耶! 三十天才过去一半!唉! 我的无法...
    姗姗来德池阅读 300评论 2 0
  • 最近很多人都在热议前任三。不为追回,不为想念。只是再次走过那些曾经熟悉的街,总期待着你依然会跟我一样,保留着记忆中...
    曾经你说我阅读 124评论 0 1