Swift - 网络抽象层库Moya的使用详解1（安装配置、基本用法）

作者：hangge | 2017-09-25 08:10

一、基本介绍

1，什么是 Moya

（1）我们知道在 iOS 开发中，可以使用 URLSession 进行网络请求。但为了方便起见，我通常会选择使用 Alamofire 这样的第三方库。这些库本质上也是基于 URLSession 的，但其封装了许多细节，可以让我们网络请求相关代码（如获取数据，提交数据，上传文件，下载文件等）更加简洁易用。

（2）而 Moya 又是一个基于 Alamofire 的更高层网络请求封装抽象层。Moya 也就可以看做我们的网络管理层，用来封装 URL、参数等请求所需要的一些基本信息。使用后我们的客户端代码会直接操作 Moya，然后 Moya 去管理请求，而不用跟 Alamofire 进行直接接触。

GitHub 主页地址：https://github.com/Moya/Moya

2，使用 Moya 的优点

（1）在我们项目的 Service、View、或者 Model 文件中可能都会出现请求网络数据的情况，如果直接使用 Alamofire，不仅很繁琐，而且还会使代码变得很混乱。

（2）过去我们通常的做法是在项目中添加一个网络请求层（比如叫做 APIManager、或者 NetworkModel），用来管理网络请求。但这样做可能会遇到一些问题：

难以开发一个新的 App（不知从哪里下手）
难以维护现有的 App（这一层比较混乱，混合了各种请求不好管理。）
难以做做单元测试。

（3）而 Moya 作为一个基于 Alamofire 的更高层网络请求封装抽象层，拥有更好更清晰的网络管理。不仅可以轻松实现简单的事情，对于复杂的情况也轻松应对。它有如下优点：

定义了一个清晰的网络结构（通过枚举值定义不同的请求）
可以简单地进行网络单元测试

二、安装配置

由于 Moya 需要依赖 Alamofire 库，手动配置会麻烦些。所以下面我们还是使用 CocoaPods 来进行安装配置。

1，创建 Podfile

首先进入到工程的根目录下，创建空白的 Podfile 文件。

cd /Users/hangge/Documents/Code/hangge_1797
touch Podfile

2，编辑 Podfile

我们在 Podfile 文件中写上需要引入的第三方库：Alamofire、Moya、SwiftyJSON（方便解析返回的 JSON 数据）

use_frameworks!

def libraries
  pod 'Alamofire'
  pod 'Moya'
  pod 'SwiftyJSON'
end

target 'hangge_1797' do
  platform :ios, '8.0'
  libraries
end

3，开始导入库

执行下面命令，开始导入前面配置的第三方库。

cd /Users/hangge/Documents/Code/hangge_1797
pod install

4，打开新生成的 .xcworkspace 文件

往后我们就需要使用这个新生成的 hangge_1797.xcworkspace 文件来开发。因为原来的工程（hangge_1358.xcodeproj）设置已经被更改了，如果我们直接打开原来的工程文件去编译就会报错。

三、使用样例

1，效果图

（1）我们使用 Moya 调用豆瓣 FM 的 API 接口，获取所有的频道列表并显示在表格中。

（2）点击任意一个频道，调用另一个接口随机获取该频道下的一首歌曲，并弹出显示。

2，样例代码

（1）DouBanAPI.swift（网络请求层）

首先我们定义一个 provider，即请求发起对象。往后我们如果要发起网络请求就使用这个 provider。
接着声明一个 enum 来对请求进行明确分类，这里我们定义两个枚举值分别表示获取频道列表、获取歌曲信息。
最后让这个 enum 实现 TargetType 协议，在这里面定义我们各个请求的 url、参数、header 等信息。

import Foundation
import Moya

//初始化豆瓣FM请求的provider
let DouBanProvider = MoyaProvider<DouBan>()

/** 下面定义豆瓣FM请求的endpoints（供provider使用）**/

//请求分类
public enum DouBan {
    case channels  //获取频道列表
    case playlist(String) //获取歌曲
}

//请求配置
extension DouBan: TargetType {
    //服务器地址
    public var baseURL: URL {
        switch self {
        case .channels:
            return URL(string: "https://www.douban.com")!
        case .playlist(_):
            return URL(string: "https://douban.fm")!
        }
    }
    
    //各个请求的具体路径
    public var path: String {
        switch self {
        case .channels:
            return "/j/app/radio/channels"
        case .playlist(_):
            return "/j/mine/playlist"
        }
    }
    
    //请求类型
    public var method: Moya.Method {
        return .get
    }
    
    //请求任务事件（这里附带上参数）
    public var task: Task {
        switch self {
        case .playlist(let channel):
            var params: [String: Any] = [:]
            params["channel"] = channel
            params["type"] = "n"
            params["from"] = "mainsite"
            return .requestParameters(parameters: params,
                                      encoding: URLEncoding.default)
        default:
            return .requestPlain
        }
    }
    
    //是否执行Alamofire验证
    public var validate: Bool {
        return false
    }
    
    //这个就是做单元测试模拟的数据，只会在单元测试文件中有作用
    public var sampleData: Data {
        return "{}".data(using: String.Encoding.utf8)!
    }
    
    //请求头
    public var headers: [String: String]? {
        return nil
    }
}

（2）ViewController.swift（主视图代码）

代码中高亮部分是通过 Moya 发起网络请求。可以看到页面上不再有 url 地址、参数拼接、请求方式等，比直接使用 Alamofire 清爽许多。

import UIKit
import SwiftyJSON

class ViewController: UIViewController, UITableViewDelegate, UITableViewDataSource {
    
    //显示频道列表的tableView
    var tableView:UITableView!
    
    //频道列表数据
    var channels:Array<JSON> = []
    
    override func viewDidLoad() {
        super.viewDidLoad()
        
        //创建表视图
        self.tableView = UITableView(frame:self.view.frame, style:.plain)
        self.tableView!.delegate = self
        self.tableView!.dataSource = self
        //创建一个重用的单元格
        self.tableView!.register(UITableViewCell.self,
                                 forCellReuseIdentifier: "SwiftCell")
        self.view.addSubview(self.tableView!)
        
        //使用我们的provider进行网络请求（获取频道列表数据）
        DouBanProvider.request(.channels) { result in
            if case let .success(response) = result {
                //解析数据
                let data = try? response.mapJSON()
                let json = JSON(data!)
                self.channels = json["channels"].arrayValue
                
                //刷新表格数据
                DispatchQueue.main.async{
                    self.tableView.reloadData()
                }
            }
        }
    }
    
    //返回表格分区数
    func numberOfSections(in tableView: UITableView) -> Int {
        return 1
    }
    
    //返回表格行数（也就是返回控件数）
    func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
        return channels.count
    }
    
    //创建各单元显示内容(创建参数indexPath指定的单元）
    func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath)
        -> UITableViewCell {
            //为了提供表格显示性能，已创建完成的单元需重复使用
            let identify:String = "SwiftCell"
            let cell = tableView.dequeueReusableCell(
                withIdentifier: identify, for: indexPath)
            cell.accessoryType = .disclosureIndicator
            //设置单元格内容
            cell.textLabel?.text = channels[indexPath.row]["name"].stringValue
            return cell
    }
    
    //处理列表项的选中事件
    func tableView(_ tableView: UITableView, didSelectRowAt indexPath: IndexPath) {
        //获取选中项信息
        let channelName = channels[indexPath.row]["name"].stringValue
        let channelId = channels[indexPath.row]["channel_id"].stringValue
        
        //使用我们的provider进行网络请求（根据频道ID获取下面的歌曲）
        DouBanProvider.request(.playlist(channelId)) { result in
            if case let .success(response) = result {
                //解析数据，获取歌曲信息
                let data = try? response.mapJSON()
                let json = JSON(data!)
                let music = json["song"].arrayValue[0]
                let artist = music["artist"].stringValue
                let title = music["title"].stringValue
                let message = "歌手：\(artist)\n歌曲：\(title)"
                
                //将歌曲信息弹出显示
                self.showAlert(title: channelName, message: message)
            }
        }
    }
    
    //显示消息
    func showAlert(title:String, message:String){
        let alertController = UIAlertController(title: title,
                                                message: message, preferredStyle: .alert)
        let cancelAction = UIAlertAction(title: "确定", style: .cancel, handler: nil)
        alertController.addAction(cancelAction)
        self.present(alertController, animated: true, completion: nil)
    }
    
    override func didReceiveMemoryWarning() {
        super.didReceiveMemoryWarning()
    }
}

源码下载：

hangge_1797.zip

全部评论（3）

WhatsXIe2017-11-13 10:45

航哥，你好，请问moya的task使用这种方法后
//请求任务事件（这里附带上参数）
public var task: Task {
switch self {
case .playlist(let channel):
var params: [String: Any] = [:]
params["channel"] = channel
params["type"] = "n"
params["from"] = "mainsite"
return .requestParameters(parameters: params,
encoding: URLEncoding.default)
我想在TargetType里获取params要怎么搞啊，打印Task看到有数据，但是怎么取到呢？
public extension TargetType {
print(task)
}
1. 站长回复：不太明白你的意思，是TargetType里的哪个方法需要再去获取params吗？或者说你要实现的目的是什么。
dolphinNEUQ2017-10-10 10:01

航哥，您好我知道我的问题所在了，由于太心急，没有注意到‘hangge_1797.xcworkspace ’和‘hangge_1358.xcodeproj’，打扰您了，非常不好意思。。
1. 站长回复：没关系，找到问题原因就好。
dolphinNEUQ2017-10-09 17:24

航哥，您好！我在运行您写的hangge_1797项目时，报错，报告的错误是Swift Compiler Error No such module 'SwiftyJSON'，不知您遇见过没。希望您有时间了帮我看看哈。
1. 站长回复：没关系，找到问题原因就好。