前言
Moya简单介绍
Moya结构：
image.png
`Provider`：provider是一个提供网络请求服务的提供者。通过一些初始化配置之后，在外部可以直接用provider来发起request。
`Request`：在使用Moya进行网络请求时，第一步需要进行配置，来生成一个Request。首先按照官方文档，创建一个枚举，遵守`TargetType协议`: 并实现协议所规定的属性。为什么要创建枚举来遵守协议，枚举结合switch语句，使得API管理起来比较方便。
根据创建了一个遵守TargetType协议的名为YShareAPI的枚举，我们完成了如下几个变量的设置。
`baseURL`
`path`
`method`
`sampleData`
`task`
`headers`
Moya.Response里面有一些常用的方法:
// 转换为Image
func mapImage() throws -> Image;
// 转换为Json
func mapJSON(failsOnEmptyData: Bool = true) throws -> Any;
// 装换为String
func mapString(atKeyPath keyPath: String? = nil) throws -> String;
// 转换为对应的model
func map<D: Decodable>(_ type: D.Type, atKeyPath keyPath: String? = nil, using decoder: JSONDecoder = JSONDecoder(), failsOnEmptyData: Bool = true) throws -> D;
一：Moya用法1：
let weatherUrl:String = "http://weatherapi.market.xiaomi.com/wtr-v2/temp/realtime?cityId="
func getWeatherInfo() -> Void {
let parameters = ["cityId":"101040100"];
Alamofire.request(weatherUrl,method:.get,parameters:parameters,encoding: URLEncoding.default).responseJSON { (response) in
switch response.result {
case .success(let json ):
let jsonDic = json as? NSDictionary
print(jsonDic! as NSDictionary);
self.showAlert(weatherDic: jsonDic!)
break
case .failure(let error):
print("error:\(error)")
break
}
}
}
二：Moya用法2：
①Moya的一个简单工具类
//
// DouBanAPI.swift
// hangge_1797
//
// Created by hangge on 2017/9/19.
// Copyright © 2017年 hangge.com. All rights reserved.
//
import Foundation
import Moya
//初始化豆瓣FM请求的provider
let Provider = 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
}
}
②具体使用
//
// ViewController.swift
// hangge_1797
//
// Created by hangge on 2017/9/19.
// Copyright © 2017年 hangge.com. All rights reserved.
//
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进行网络请求（获取频道列表数据）
Provider.request(.channels) { result in
if case let .success(response) = result {
/*
switch result {
case .success(let responseData):
if let response = JSONResponseFormatter(responseData.data) {
print(response)
if let status = response["state"] as? Int {
completion(.success(status == 1 ? true : false))
}
}
case .failure(_):
self.failureAction(error: .server)
completion(.failure(.server))
}
*/
//解析数据
let data = try? response.mapJSON()
let json = JSON(data!)
self.channels = json["channels"].arrayValue
print("请求成功+++++:\(String(describing: data))" )
//刷新表格数据
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获取下面的歌曲）
Provider.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)"
/*
switch result {
case .success(let responseData):
if let response = JSONResponseFormatter(responseData.data) {
print(response)
if let status = response["state"] as? Int {
completion(.success(status == 1 ? true : false))
}
}
case .failure(_):
self.failureAction(error: .server)
completion(.failure(.server))
}
*/
//将歌曲信息弹出显示
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()
}
}
另外：
③通过HTTPHeader设置公共请求参数
在实际开发中我们可能会需要在请求头内添加一些公共请求参数，如用于识别一些平台标志、辨别接口的版本号。你可以定义一个Endpoint的闭包:
let publicParamEndpointClosure = { (target: AccountService) -> Endpoint< DouBan> in
let url = target.baseURL.appendingPathComponent(target.path).absoluteString
let endpoint = Endpoint< DouBan>(url: url, sampleResponseClosure: { .networkResponse(200, target.sampleData) }, method: target.method, parameters: target.parameters, parameterEncoding: target.parameterEncoding)
return endpoint.adding(newHTTPHeaderFields: ["x-platform" : "iOS", "x-interface-version" : "1.0"])
}
然后在创建请求的Provider把它添加上去:
let provider = MoyaProvider(endpointClosure: publicParamEndpointClosure)
④通过插件的方式监听网络状态
通常我们会在进行网络请求的时候进行一些状态展示，如loading，那么你可以通过插件的方式来实现。Moya默认有4个插件:
AccessTokenPlugin管理AccessToken的插件CredentialsPlugin管理认证的插件NetworkActivityPlugin管理网络状态的插件NetworkLoggerPlugin管理网络log的插件
在这里就演示一下NetworkActivityPlugin的使用：
let networkPlugin = NetworkActivityPlugin { (type) in
switch type {
case .began:
NSLog("显示loading")
case .ended:
NSLog("隐藏loading")
}
}
同样在创建请求的Provider把它添加上去即可
let provider = MoyaProvider< DouBan>(plugins: [networkPlugin])
⑤当然你也可以自定义一些功能的插件,只需要实现PluginType协议，具体功能实现可参考Moya默认的插件：
final class CustomPlugin: PluginType {
// MARK: Plugin
}
⑥设置接口的超时时间
一般网络的请求需要根据具体的业务接口设置合适的超时时间，你可以参照一下方法进行设置
let requestTimeoutClosure = { (endpoint: Endpoint< DouBan>, done: @escaping MoyaProvider< DouBan>.RequestResultClosure) in
guard var request = endpoint.urlRequest else { return }
request.timeoutInterval = 30 //设置请求超时时间
done(.success(request))
}
同样在创建请求的Provider把它添加上去即可
let provider = MoyaProvider< DouBan>(requestClosure: requestTimeoutClosure)
