基于Alamofire+RxSwift+HandyJSON的網(wǎng)絡(luò)請求框架

其實(shí)寫這個(gè)網(wǎng)絡(luò)框架的時(shí)候我也只是才學(xué)習(xí)了RxSwift一周左右的時(shí)間，嘗試一下自己搭建的網(wǎng)絡(luò)請求的框架。抱著學(xué)習(xí)的態(tài)度，若果有什么不對的地方，請各位指正。

首先先用CocoaPods導(dǎo)入第三方庫，這是寫在Podfile中的：

Podfile

這四個(gè)三方庫我就不一一說明了，不清楚的小伙伴可以自行查閱。下面來看看整個(gè)框架結(jié)構(gòu)：

NetworkTool

APIUtil 這里放的是網(wǎng)絡(luò)協(xié)議，通過面向協(xié)議編程對網(wǎng)絡(luò)請求進(jìn)行封裝。

APIError 一個(gè)枚舉類型，專門用來處理網(wǎng)絡(luò)錯誤(可以自定義添加)。

Router 所有的接口地址在這里進(jìn)行拼接。

接下來一起看看它是怎么實(shí)現(xiàn)的。

APIUtil

我在這里定義了一個(gè)網(wǎng)絡(luò)協(xié)議:


import Foundation
import Alamofire
import HandyJSON
import RxSwift

struct APIUtil {
    static var httpsHeaders: HTTPHeaders = ["Content-Type": "application/json"]
}

接下來我對網(wǎng)絡(luò)進(jìn)行第一層封裝：

// MARK: - 對Alamofire的第一層封裝
extension APIUtil {
    /// 網(wǎng)絡(luò)請求方法
    ///
    /// - Parameters:
    ///   - observer: Rx 觀察者
    ///   - url: 路由地址
    ///   - method: 請求方式
    ///   - parameters: 參數(shù)
    ///   - returnType: 返回類型
    fileprivate static func request<T: HandyJSON>(observer: AnyObserver<T>, url: Router, method: HTTPMethod, parameters: Parameters?, encoding: ParameterEncoding, returnType: T.Type) {
        AF.request(url, method: method, parameters: parameters, encoding: encoding, headers: httpsHeaders).responseJSON { response in
            switch response.result {
            case .success:
                successHandle(observer: observer, result: response.value, retrunType: returnType)
            case .failure(let error):
                failHandle(observer: observer, error: APIError.apiError(with: error as NSError))
            }
        }
    }
    
    /// 上傳方法
    ///
    /// - Parameters:
    ///   - observer: Rx 觀察者
    ///   - url: 路由地址
    ///   - method: 請求方式
    ///   - uploadDatas: 上傳的數(shù)據(jù)數(shù)組
    ///   - parameters: 參數(shù)
    ///   - returnType: 返回類型
    fileprivate static func uploadRequest<T: HandyJSON>(observer: AnyObserver<T>, url: Router, method: HTTPMethod, uploadDatas: [UploadData]?, parameters: Parameters?, returnType: T.Type) {
        AF.upload(multipartFormData: { data in
            // Parameters
            if let parameters = parameters {
                for param in parameters {
                    let value = (param.value as! String).data(using: .utf8)
                    data.append(value!, withName: param.key)
                }
            }
            // uploadData
            if let toUploadDatas = uploadDatas {
                for toUploadData in toUploadDatas {
                    if let uploadData = toUploadData.data {
                        data.append(uploadData, withName: toUploadData.name!, fileName: toUploadData.fileName!, mimeType: toUploadData.mimeType!)
                    }
                }
            }
        }, to: url, method: method, headers: httpsHeaders).responseJSON { response in
            switch response.result {
            case .success:
                successHandle(observer: observer, result: response.value, retrunType: returnType)
            case .failure(let error):
                failHandle(observer: observer, error: APIError.apiError(with: error as NSError))
            }
        }
}
  • 這一層封裝主要利用RxSwift對Alamofire的網(wǎng)絡(luò)請求的結(jié)果包裝成一個(gè)AnyObserver，對不同的結(jié)果進(jìn)行不同的處理。
    接下來是對請求結(jié)果的處理：
// MARK: - 對網(wǎng)絡(luò)成功與否的處理
extension APIUtil {
    /// 網(wǎng)絡(luò)請求成功之后的回調(diào)
    ///
    /// - Parameters:
    ///   - observer: Rx 的觀察者(傳遞數(shù)據(jù))
    ///   - result: 請求結(jié)果
    ///   - retrunType: 返回值類型
    fileprivate static func successHandle<T: HandyJSON>(observer: AnyObserver<T>, result: Any?, retrunType: T.Type) {
        // 如果解析出來的不是json
        guard let JSON = result, let jsonDic = JSON as? [String: Any] else {
            failHandle(observer: observer, error: APIError.dataJSON(errorMessage: "非JSON格式的數(shù)據(jù)"))
            return
        }
        // jsonDic是原始數(shù)據(jù)，將其轉(zhuǎn)成HandyJSON
        guard let responseModel = retrunType.deserialize(from: NSDictionary(dictionary: jsonDic)) else {
            failHandle(observer: observer, error: APIError.dataMatch(errorMessage: "無法解析"))
            return
        }
        observer.onNext(responseModel)
        observer.onCompleted()
    }
    
    /// 網(wǎng)絡(luò)請求失敗的回調(diào)
    ///
    /// - Parameters:
    ///   - observer: Rx 的觀察者
    ///   - error: 錯誤信息
    fileprivate static func failHandle<T: HandyJSON>(observer: AnyObserver<T>, error: Error) {
        observer.onError(NetError.networkError(with: error as NSError))
        observer.onCompleted()
    }
}
  • 如果請求成功的話會返回一個(gè)遵循HandyJSON協(xié)議的數(shù)據(jù)模型，失敗的話返回網(wǎng)絡(luò)錯誤的信息。
    接下來創(chuàng)建Rx序列：
// MARK: - 利用Rx傳遞數(shù)據(jù)
extension APIUtil {
    
    /// 獲取數(shù)據(jù)
    ///
    /// - Parameters:
    ///   - url: 路由地址
    ///   - method: 請求方式
    ///   - parameters: 參數(shù)
    ///   - returnType: 返回類型
    /// - Returns: 返回一個(gè)Rx序列
    static func fetchData<T: HandyJSON>(with url: Router, method: HTTPMethod = .get, parameters: Parameters? = nil, encoding: ParameterEncoding = URLEncoding.queryString, returnType: T.Type) -> Observable<T> {
        return Observable<T>.create({ (observer: AnyObserver<T>) -> Disposable in
            self.request(observer: observer, url: url, method: method, parameters: parameters, returnType: returnType)
            return Disposables.create()
        })
    }
    
    /// 上傳數(shù)據(jù)
    ///
    /// - Parameters:
    ///   - url: 路由地址
    ///   - method: 請求方式
    ///   - uploadDatas: 上傳數(shù)據(jù)的數(shù)組
    ///   - parameters: 參數(shù)(可以不填)
    ///   - returnType: 返回類型
    /// - Returns: 返回一個(gè)Rx序列
    static func uploadData<T: HandyJSON>(with url: Router, method: HTTPMethod, uploadDatas: [UploadData]?, parameters: Parameters? = nil, returnType: T.Type) -> Observable<T> {
        return Observable<T>.create({ (observer: AnyObserver<T>) -> Disposable in
            self.uploadRequest(observer: observer, url: url, method: method, uploadDatas: uploadDatas, parameters: parameters, returnType: returnType)
            return Disposables.create()
        })
    }
  • 調(diào)用方法會創(chuàng)建一個(gè)Rx的序列，在閉包中直接調(diào)用第一層封裝的方法。

APIError

在這里我們?yōu)榫W(wǎng)絡(luò)錯誤的處理進(jìn)行了簡單的分類：

import Foundation

enum NetError: Error {
    /// 普通的錯誤信息
    case error(errorMessage: String)
    /// 數(shù)據(jù)不是json格式
    case dataJSON(errorMessage: String)
    /// 數(shù)據(jù)不匹配
    case dataMatch(errorMessage: String)
    /// 數(shù)據(jù)為空
    case dataEmpty(errorMessage: String)
    /// 網(wǎng)絡(luò)錯誤
    case network(errorMessage: String)
    /// 網(wǎng)絡(luò)錯誤的信息打印
    ///
    /// - Parameter error: 錯誤信息
    /// - Returns: 網(wǎng)絡(luò)錯誤處理
    static func networkError(with error: NSError) -> NetError {
        print("This error message is \(error)")
        if error.domain == "Alamofire.AFError" {
            //處理自帶的錯誤
            if error.code == 4 {
                return NetError.dataEmpty(errorMessage: "數(shù)據(jù)為空")
            }
        }
        return NetError.network(errorMessage: "未知的網(wǎng)絡(luò)錯誤")
    }
}

Router

import UIKit
import Alamofire

enum Router: String, URLConvertible {
    
    case tianqi = "data/sk/101010100.html"
    
    /// 實(shí)現(xiàn)協(xié)議方法
    func asURL() throws -> URL {
        return try URL(string: urlString)!.asURL()
    }
    
    /// 主機(jī)地址
    static var baseUrl: String  = "http://mobile.weather.com.cn/"
    
    /// 拼接過的地址鏈接
    private var urlString: String {
        return Router.baseUrl.appending(rawValue)
    }
}

在這里要說明一下URLConvertible這個(gè)協(xié)議，實(shí)現(xiàn)這個(gè)協(xié)議可以將Router中的地址自動拼接并轉(zhuǎn)成URL類型。

接下來就可以使用它來進(jìn)行簡單的網(wǎng)絡(luò)請求：

import Foundation
import HandyJSON
import RxSwift

struct DataModel: HandyJSON {
    var skinfo: SkyInfo?
    
    mutating func mapping(mapper: HelpingMapper) {
        mapper <<<
            self.skinfo <-- "sk_info"
    }
}

struct SkyInfo: HandyJSON {
    var areaID: Int = 0
    var cityName: String?
    var date: String?
    var sd: String?
    var sm: String?
    var temp: String?
    var tempF: String?
    var time: String?
    var wd: String?
    var ws: String?
    
    mutating func mapping(mapper: HelpingMapper) {
        mapper.specify(property: &date) { (dateInt) -> String in
            return "\(dateInt)"
        }
    }
}

extension DataModel {
    func fetchSkyData() -> Observable<DataModel> {
        return APIUtil.fetchData(with: .tianqi, method: .get, parameters: ["_" : "1381891661455"], returnType: DataModel.self).map({ (response: DataModel) -> DataModel in
            return response
        })
    }
}
  • 在這里調(diào)用網(wǎng)絡(luò)請求的方法，返回一個(gè)Rx序列攜帶請求結(jié)果。

最后在需要對數(shù)據(jù)處理的地方返回模型：

let dataModel = DataModel()
let disposeBag = DisposeBag()
dataModel.fetchSkyData().subscribe(onNext: { (model) in
  print(model.skinfo!.date!)
}, onError: { (error) in
  print(error)
}).disposed(by: disposeBag)

到這里，就完成了一個(gè)簡單的網(wǎng)絡(luò)請求框架，最后放上demo的地址，感興趣的小伙伴可以下載看看：demo地址

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

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

  • 1、通過CocoaPods安裝項(xiàng)目名稱項(xiàng)目信息 AFNetworking網(wǎng)絡(luò)請求組件 FMDB本地?cái)?shù)據(jù)庫組件 SD...
    陽明AI閱讀 16,172評論 3贊 119
  • 岑嶸 也許你正在看電視劇。剛剛播放的一集電視劇也許是42分鐘，也許是43分鐘，這有什么區(qū)別呢？你也許還想到，并不是...
    aipanda閱讀 535評論 0贊 0

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