RxSwift+Moya+ObjectMapper优雅的网络请求及模型转换

RxSwift+Moya+ObjectMapper优雅的网络请求本人已写了一个开源的拿来即用的Swift项目框架 可以参考此框架来通篇阅读此文章更有帮助 有喜欢的还望送人玫瑰手留余香哦
当然这个拿来即用的Swift项目框架有不合理的地方 还望大神指点一二

末尾有彩蛋

文章目录
一 Rxswift 简单介绍
二 Moya 简单介绍以及使用
三 ObjectMapper 简单介绍以及使用
四 RxSwift+Moya+ObjectMapper优雅的网络请求及模型转换

一 RxSwift 简单介绍

• RxSwift是Swift函数响应式编程的一个开源库，由GitHub的ReactiveX组织开发和维护
• 其他语言像C#，Java 和JS也有: Rx.Net、RxJava、RxJS
• RxSwift的目的是让数据/事件流和异步任务能够更方便的序
  列化处理 能够使用Swift进行响应式编程
  本文就不详细介绍Rxswift 楼主之前写过RxSwift 的介绍以及使用 可以参看一下 RxSwift 个人学习笔记记录

二 Moya 简单介绍以及使用

1 Moya 简单介绍

Moya是一个基于Alamofire的Networking library，并且添加了对于ReactiveCocoa和RxSwift的接口支持，大大简化了开发过程，是Reactive Functional Programming的网络层首选。

Github上的官方介绍罗列了Moya的一些特点：

• 编译的时候会检查API endpoint
• 可以用枚举值清楚地定义很多endpoint
• 增加了stubResponse类型，大大方便了unit testing

2 Moya 的 使用

首先我们需要声明一个enum来对请求进行明确分类。

enum APIManager{
    case GetHomeList // 获取首页列表
    case GetHomeDetail(Int)  // 获取详情页
}

然后我们需要让这个enum遵守TargetType协议，在这个协议中可以看到 TargetType定义了我们发送一个网络请求所需要的东西，baseURL，parameter，method等一些计算性属性，我们要做的就是去实现这些东西，当然有带默认值的我们可以不去实现。

extension APIManager: TargetType {
    /// The target's base `URL`.
    var baseURL: URL {
        return URL.init(string: "http://news-at.zhihu.com/api/")!
    }
    /// The path to be appended to `baseURL` to form the full `URL`.
    var path: String {
        switch self {            
        case .GetHomeList: // 不带参数的请求
            return "4/news/latest"
        case .GetHomeDetail(let id):  // 带参数的请求
            return "4/theme/\(id)"
        }
    }
// 区分get 和 post     
    var method: Moya.Method {        
        return .get
    }

    /// The parameters to be incoded in the request.
    var parameters: [String: Any]? {
        return nil
    }
    /// The method used for parameter encoding.
    var parameterEncoding: ParameterEncoding {
        return URLEncoding.default
    }
    /// Provides stub data for use in testing.
    var sampleData: Data {
        return "".data(using: String.Encoding.utf8)!
    }
    /// The type of HTTP task to be performed.
    var task: Task {
        return .request
    }
    /// Whether or not to perform Alamofire validation. Defaults to `false`.
    var validate: Bool {
        return false
    }
}

写好上边的以后 我们就可以去发送一个请求了

private let provider = RxMoyaProvider()

  // 请求数据
        provider
            .request(.GetHomeList)
            .filterSuccessfulStatusCodes()
            .mapJSON().subscribe(onNext: { (json) in                
                print(json)                
            }).addDisposableTo(bag)    

上边就是请求数据了 回调出来json数据

如果对RxSwift还不熟悉的话 建议去看一下之前写的文章RxSwift 个人学习笔记记录
Moya其实是提供了非常方面的RxSwift扩展
简单介绍一下上边方法和变量中的各个名词:

• RxMoyaProvider是MoyaProvider的子类，是对RxSwift的扩展
• filterSuccessfulStatusCodes() 是Moya为RxSwift提供的扩展方法，顾名思义，可以得到成功成功地网络请求，忽略其他的
• mapJSON() 也是Moya RxSwift的扩展方法，可以把返回的数据解析成 JSON 格式 会返回一个Observable
  然后我们就可以对这个Observable进行订阅了
  然后我们就可以得到下边的json数据 只展示了部分数据
  网络请求就已经结束了 就这这么简单轻松and easy

{
    date = 20170908;
    stories =     (
                {
            "ga_prefix" = 090817;
            id = 9602715;
            images =             (
                "https://pic2.zhimg.com/v2-3b39b83f560e089a7f6ddb00f6948b81.jpg"
            );
            title = "\U4e24\U5343\U591a\U5e74\U524d\Uff0c\U79e6\U56fd\U4e3a\U4ec0\U4e48\U8981\U7edf\U4e00\U4e2d\U56fd\Uff1f";
            type = 0;
        },
                {
            "ga_prefix" = 090816;
            id = 9601590;
            images =             (
                "https://pic4.zhimg.com/v2-700a8c29d04a885354d78d5a91a9fa5b.jpg"
            );
            title = "\U8fdc\U5904\U6765\U4e86\U8f66\Uff0c\U5148\U89c1\U5230\U8f66\U9876\U5c31\U8bf4\U660e\U5730\U7403\U662f\U5706\U7684\Uff1f\U4e0d\U53ef\U80fd\U7684";
            type = 0;
        },
       );
    "top_stories" =     (
                {
            "ga_prefix" = 090815;
            id = 9607829;
            image = "https://pic3.zhimg.com/v2-14c13f9f87b1b3082929b444072eebb6.jpg";
            title = "\U770b\U7167\U7247\Uff0c\U6211\U5c31\U77e5\U9053\U4f60\U662f\U540c\U6027\U604b\Uff0c\U65af\U5766\U798f\U5927\U5b66\U7684\U4eba\U5de5\U667a\U80fd\U8bf4";
            type = 0;
        },
                {
            "ga_prefix" = 090807;
            id = 9606837;
            image = "https://pic1.zhimg.com/v2-cceffc2e17185ae51b7b2d14b4414e84.jpg";
            title = "\U6211\U8fd9\U4e48\U80d6\Uff0c\U5230\U5e95\U662f\U56e0\U4e3a\U5403\U5f97\U592a\U591a\U8fd8\U662f\U52a8\U5f97\U592a\U5c11\Uff1f";
            type = 0;
        },
        
    );
}

三 ObjectMapper 简单介绍以及使用

json得到了 接下来那就是json转模型了

ObjectMapper 是一个在 Swift 下数据转模型的非常好用，并且很 Swift 的一个框架。以前我们在写 OC 代码的时候用 MJExtension 转模型，到了 Swift 的时代赶紧将 ObjectMapper 使用起来吧。

为了支持映射，类或者结构体只需要实现Mappable协议。这个协议包含两个方法 而且这两个方法是必须实现的

class LLHomeModel: Mappable {
    
    var date: String?
    var stories: [StoryModel]?
    var top_stories: [StoryModel]?
            
    //  接下来的两个方法是必须要实现的 
    required init?(map: Map) {        
    }
    public func mapping(map: Map) {
        date <- map["date"]
        stories <- map["stories"]
        top_stories <- map["top_stories"]
    }
    
}

一旦你的对象实现了 Mappable, ObjectMapper就可以让你轻松的实现和 JSON 之间的转换。
把 JSON 字符串转成 model 对象：

let homeModel = LLHomeModel(JSONString: JSONString)

把一个 model 转成 JSON 字符串：

let JSONString = homeModel.toJSONString(prettyPrint: true)

还有一些具体的基础使用可以参考ObjectMapper中文翻译

四 RxSwift+Moya+ObjectMapper优雅的网络请求及模型转换

RxSwift结合MVVM 简直的太合适不过了
我们将 网络请求放在VM里边

    private let provider = RxMoyaProvider()
        

        // 请求数据
        provider
            .request(.GetHomeList)
            .filterSuccessfulStatusCodes()
            .mapJSON().mapObject(type: LLHomeModel.self).subscribe(onNext: { (model) in                

                self.modelObserable.value = model.stories!                

            }, onError: { (error) in                
            }).addDisposableTo(bag)

可以看到我们上边代码中 provider .request(.GetHomeList) .filterSuccessfulStatusCodes() .mapJSON(). 这个方法本身应该得到 JSON的 但是我后边跟了一个mapObject 的方法 这个方式可以直接根据json的格式转换成模型 或者是模型数组 来看一下这个方法 我是单独定义了一个json转模型的类LLToModelExtension.swift

extension Observable{
    func mapObject(type: T.Type) -> Observable {
        return self.map { response in
            guard let dict = response as? [String : Any] else{
                throw RxSwiftMoyaError.ParseJSONError
            }
            return Mapper().map(JSON: dict)!
        }
    }
        
    func mapArray(type: T.Type) -> Observable<[T]> {
        return self.map { response in
            //if response is an array of dictionaries, then use ObjectMapper to map the dictionary
            //if not, throw an error
            guard let array = response as? [Any] else {
                throw RxSwiftMoyaError.ParseJSONError
            }
            
            guard let dicts = array as? [[String: Any]] else {
                throw RxSwiftMoyaError.ParseJSONError
            }            
            return Mapper().mapArray(JSONArray: dicts)
        }
    }
}

enum RxSwiftMoyaError: String {
    case ParseJSONError
    case OtherError
}
extension RxSwiftMoyaError: Swift.Error { }

介绍一下上边代码中各个方法以及名词

• 1 mapObject 方法是处理单个对象的 mapArray 处理对象数组
• 2 如果传进来的数据 是一个NSDictionary 的话 那么就利用 ObjectMapper 的 map 方法映射这些数据，这个方法会调用你之前在 mapping 方法里面定义的逻辑。
• 3 如果 response 不是一个 dictionary， 那么就抛出一个错误。
• 4 在底部自定义了简单的 Error，继承了 Swift 的 Error 类，在实际应用过程中可以根据需要提供自己想要的 Error。

彩蛋

可能会有人问 为什么请求回来的数据 要赋值给modelObserable.Value呢 而不是赋值给一个模型数组 然后reloadData呢
这里我用的RXSwift里边UItableView绑定数据的一个方法 再也不用写一大串数据源方法了 这个也可以去这里参考哦

      var modelObserable = Variable<[StoryModel]> ([])

        //MARK: Rx 绑定tableView数据
        modelObserable.asObservable().bind(to: tableV.rx.items(cellIdentifier: cellID, cellType: LLHomeCell.self)){ row , model , cell in            
            cell.titleLbl.text = model.title            
            cell.imageV?.kf.setImage(with: URL.init(string: (model.images?.count)! > 0 ? (model.images?.first)! : ""))            
            }.addDisposableTo(bag)

Swift项目框架地址

参考文章
Moya入坑记
RxSwift+Moya