网络抽象层库Moya的基本使用

一、基本介绍

1. 什么是 Moya

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

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

2,使用 Moya 的优点

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

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

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


    image.png

二、安装配置

由于 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_1358
pod install
4,打开新生成的 .xcworkspace 文件

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


image.png

三、使用样例

1,效果图

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

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

image.png

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

推荐阅读更多精彩内容