RxSwift + Moya + HandyJSON + 各種插件搭建響應(yīng)式網(wǎng)絡(luò)架構(gòu)

<font color=red>??. RxSwift + Moya + HandyJSON + Plugins.??????</font>

English | 簡體中文

基于 RxSwift + Moya 搭建響應(yīng)式數(shù)據(jù)綁定網(wǎng)絡(luò)API架構(gòu)

MoyaNetwork

該模塊是基于Moya封裝的網(wǎng)絡(luò)API架構(gòu)

  • 主要分為以下8部分：
    • NetworkConfig：在程序最開始處設(shè)置配置信息，全局通用
      • addDebugging：是否開啟默認(rèn)加入調(diào)試插件
      • baseURL：根路徑地址
      • baseParameters：默認(rèn)基本參數(shù)，類似：userID，token等
      • baseMethod：默認(rèn)請求類型
      • updateBaseParametersWithValue：更新默認(rèn)基本參數(shù)數(shù)據(jù)
    • RxMoyaProvider：對網(wǎng)絡(luò)請求添加響應(yīng)式，返回Observable序列
    • NetworkUtil：網(wǎng)絡(luò)相關(guān)函數(shù)
      • defaultPlugin：添加默認(rèn)插件
      • transformAPIObservableJSON：轉(zhuǎn)換成可觀察序列JSON對象
      • handyConfigurationPlugin：處理配置插件
    • PluginSubType：繼承替換Moya插件協(xié)議，方便后序擴(kuò)展
      • configuration：設(shè)置網(wǎng)絡(luò)配置信息之后，開始準(zhǔn)備請求之前，該方法可以用于本地緩存存在時(shí)直接拋出數(shù)據(jù)而不用再執(zhí)行后序網(wǎng)絡(luò)請求等場景
      • lastNever：最后的最后網(wǎng)絡(luò)響應(yīng)返回時(shí)刻，該方法可以用于密鑰失效重新去獲取密鑰然后自動(dòng)再次網(wǎng)絡(luò)請求等場景
    • NetworkAPI：在TargetType基礎(chǔ)上增加協(xié)議屬性和封裝基礎(chǔ)網(wǎng)絡(luò)請求
      • ip：根路徑地址
      • parameters：請求參數(shù)
      • plugins：插件數(shù)組
      • stubBehavior：是否走測試數(shù)據(jù)
      • retry：請求失敗重試次數(shù)
      • request：網(wǎng)絡(luò)請求方法，返回可觀察序列JSON對象
    • NetworkAPI+Ext：NetworkAPI協(xié)議默認(rèn)實(shí)現(xiàn)方案
    • NetworkAPIOO：面向?qū)ο筠D(zhuǎn)換器，面向協(xié)議模式轉(zhuǎn)面向?qū)ο螅奖懔?xí)慣OC思維的小伙伴
      • cdy_ip：根路徑地址
      • cdy_path：請求路徑
      • cdy_parameters：請求參數(shù)
      • cdy_plugins：插件
      • cdy_testJSON：測試數(shù)據(jù)
      • cdy_testTime：測試數(shù)據(jù)返回時(shí)間，默認(rèn)半秒
      • cdy_retry：請求失敗重試次數(shù)
      • cdy_HTTPRequest：網(wǎng)絡(luò)請求方法
    • NetworkX：擴(kuò)展函數(shù)方法等
      • toJSON：對象轉(zhuǎn)JSON字符串
      • toDictionary：JSON字符串轉(zhuǎn)字典
      • +=：字典拼接

?? - 面向?qū)ο笫褂檬纠?:

class OOViewModel: NSObject {
    let disposeBag = DisposeBag()
    let data = PublishRelay<String>()

    func loadData() {
        var api = NetworkAPIOO.init()
        api.cdy_ip = "https://www.httpbin.org"
        api.cdy_path = "/ip"
        api.cdy_method = .get
        api.cdy_plugins = [NetworkLoadingPlugin.init()]
        api.cdy_retry = 3

        api.cdy_HTTPRequest()
            .asObservable()
            .compactMap{ (($0 as! NSDictionary)["origin"] as? String) }
            .catchAndReturn("")
            .bind(to: data)
            .disposed(by: disposeBag)
    }
}

?? - MVP使用示例2:

enum LoadingAPI {
    case test2(String)
}

extension LoadingAPI: NetworkAPI {
    var ip: APIHost {
        return NetworkConfig.baseURL
    }

    var path: String {
        return "/post"
    }

    var parameters: APIParameters? {
        switch self {
        case .test2(let string): return ["key": string]
        }
    }
}

class LoadingViewModel: NSObject {
    let disposeBag = DisposeBag()
    let data = PublishRelay<NSDictionary>()

    /// 配置加載動(dòng)畫插件
    let APIProvider: MoyaProvider<MultiTarget> = {
        let configuration = URLSessionConfiguration.default
        configuration.headers = .default
        configuration.timeoutIntervalForRequest = 30
        let session = Moya.Session(configuration: configuration, startRequestsImmediately: false)
        let loading = NetworkLoadingPlugin.init()
        return MoyaProvider<MultiTarget>(session: session, plugins: [loading])
    }()

    func loadData() {
        APIProvider.rx.request(api: LoadingAPI.test2("666"))
            .asObservable()
            .subscribe { [weak self] (event) in
                if let dict = event.element as? NSDictionary {
                    self?.data.accept(dict)
                }
            }.disposed(by: disposeBag)
    }
}

?? - MVVM使用示例3:

class CacheViewModel: NSObject {
    let disposeBag = DisposeBag()
    struct Input {
        let count: Int
    }
    struct Output {
        let items: Driver<[CacheModel]>
    }

    func transform(input: Input) -> Output {
        let elements = BehaviorRelay<[CacheModel]>(value: [])
        let output = Output(items: elements.asDriver())
        request(input.count)
            .asObservable()
            .bind(to: elements)
            .disposed(by: disposeBag)
            
        return output
    }
}

extension CacheViewModel {
    func request(_ count: Int) -> Driver<[CacheModel]> {
        CacheAPI.cache(count).request()
            .asObservable()
            .mapHandyJSON(HandyDataModel<[CacheModel]>.self)
            .compactMap { $0.data }
            .observe(on: MainScheduler.instance) // 結(jié)果在主線程返回
            .delay(.seconds(1), scheduler: MainScheduler.instance) // 延時(shí)1秒返回
            .asDriver(onErrorJustReturn: []) // 錯(cuò)誤時(shí)刻返回空
    }
}

?? - 鏈?zhǔn)秸埱笫褂檬纠?:

class ChainViewModel: NSObject {
    let disposeBag = DisposeBag()
    let data = PublishRelay<NSDictionary>()

    func chainLoad() {
        requestIP()
            .flatMapLatest(requestData)
            .subscribe(onNext: { [weak self] data in
                self?.data.accept(data)
            }, onError: {
                print("Network Failed: \($0)")
            }).disposed(by: disposeBag)
    }
}

extension ChainViewModel {
    func requestIP() -> Observable<String> {
        return ChainAPI.test.request()
            .asObservable()
            .map { ($0 as! NSDictionary)["origin"] as! String }
            .catchAndReturn("") // 異常拋出
    }

    func requestData(_ ip: String) -> Observable<NSDictionary> {
        return ChainAPI.test2(ip).request()
            .asObservable()
            .map { ($0 as! NSDictionary) }
            .catchAndReturn(["data": "nil"])
    }
}

?? - 批量請求使用示例5:

class BatchViewModel: NSObject {
    let disposeBag = DisposeBag()
    let data = PublishRelay<NSDictionary>()

    /// 配置加載動(dòng)畫插件
    let APIProvider: MoyaProvider<MultiTarget> = {
        let configuration = URLSessionConfiguration.default
        configuration.headers = .default
        configuration.timeoutIntervalForRequest = 30
        let session = Moya.Session(configuration: configuration, startRequestsImmediately: false)
        let loading = NetworkLoadingPlugin.init()
        return MoyaProvider<MultiTarget>(session: session, plugins: [loading])
    }()

    func batchLoad() {
        Observable.zip(
            APIProvider.rx.request(api: BatchAPI.test).asObservable(),
            APIProvider.rx.request(api: BatchAPI.test2("666")).asObservable(),
            APIProvider.rx.request(api: BatchAPI.test3).asObservable()
        ).subscribe(onNext: { [weak self] in
            guard var data1 = $0 as? Dictionary<String, Any>,
                  let data2 = $1 as? Dictionary<String, Any>,
                  let data3 = $2 as? Dictionary<String, Any> else {
                      return
                  }
            data1 += data2
            data1 += data3
            self?.data.accept(data1)
        }, onError: {
            print("Network Failed: \($0)")
        }).disposed(by: disposeBag)
    }
}

MoyaPlugins

該模塊主要就是基于moya封裝網(wǎng)絡(luò)相關(guān)插件

  • 目前已封裝6款插件供您使用：
    • Cache：網(wǎng)絡(luò)數(shù)據(jù)緩存插件
    • Loading：加載動(dòng)畫插件
    • Indicator：指示器插件
    • Warning：網(wǎng)絡(luò)失敗提示插件
    • Debugging：調(diào)試日志插件
    • GZip：解壓縮插件

?? - 簡單使用，在API協(xié)議當(dāng)中實(shí)現(xiàn)該協(xié)議方法，然后將插件加入其中即可：

var plugins: APIPlugins {
    let cache = NetworkCachePlugin(cacheType: .networkElseCache)
    let loading = NetworkLoadingPlugin.init(delayHideHUD: 0.5)
    loading.changeHudCallback = { (hud) in
        hud.detailsLabel.textColor = UIColor.yellow
    }
    return [loading, cache]
}

HandyJSON

該模塊是基于HandyJSON封裝網(wǎng)絡(luò)數(shù)據(jù)解析

  • 大致分為以下3個(gè)部分：
    • HandyDataModel：網(wǎng)絡(luò)外層數(shù)據(jù)模型
    • HandyJSONError：解析錯(cuò)誤相關(guān)
    • RxHandyJSON：HandyJSON數(shù)據(jù)解析，目前提供兩種解析方案
      • 方案1 - 結(jié)合HandyDataModel模型使用解析出data數(shù)據(jù)
      • 方案2 - 根據(jù)keyPath解析出指定key的數(shù)據(jù)，前提條件數(shù)據(jù)源必須字典形式

?? - 結(jié)合網(wǎng)絡(luò)部分使用示例：

func request(_ count: Int) -> Driver<[CacheModel]> {
    CacheAPI.cache(count).request()
        .asObservable()
        .mapHandyJSON(HandyDataModel<[CacheModel]>.self)
        .compactMap { $0.data }
        .observe(on: MainScheduler.instance) // 結(jié)果在主線程返回
        .delay(.seconds(1), scheduler: MainScheduler.instance) // 延時(shí)1秒返回
        .asDriver(onErrorJustReturn: []) // 錯(cuò)誤時(shí)刻返回空
}

CocoaPods Install

Ex: 導(dǎo)入網(wǎng)絡(luò)架構(gòu)API
- pod 'RxNetworks/MoyaNetwork'

Ex: 導(dǎo)入數(shù)據(jù)解析
- pod 'RxNetworks/HandyJSON'

Ex: 導(dǎo)入加載動(dòng)畫插件
- pod 'RxNetworks/MoyaPlugins/Loading'

Demo

大體流程差不多就是這樣，Demo也寫的很詳細(xì)，大家可以自己去看看??

RxNetworksDemo

提示：如果覺得有幫助，請幫忙點(diǎn)個(gè)星 ?..

謝謝.??

  • 后序有相關(guān)插件，也會(huì)慢慢補(bǔ)充..

??

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容