1. 概述
Moya是對(duì)請(qǐng)求庫(kù)Alamofire的抽象封裝队秩,相當(dāng)于YTKNetwork和AFNetworking的關(guān)系
image.png
2. 基本使用
假設(shè)有如下api用于訂單相關(guān)邏輯,使用Moya來(lái)實(shí)現(xiàn)
- 請(qǐng)求地址:http://127.0.0.1:8080
- 公共請(qǐng)求頭:devtype:iOS榄融,devid
- 公共請(qǐng)求參數(shù):token:"Gz1qYLXeBW8MZuUfDlr9wsAYuVS1cZFMJY9BbaF842L2gRps747o4w=="
API | 參數(shù) | 說(shuō)明 |
---|---|---|
order/list | pageNO:訂單列表開(kāi)始頁(yè)碼,默認(rèn)從1, pageSize:每頁(yè)記錄數(shù) | 訂單列表 |
order/findById | sn:訂單id | 根據(jù)id查詢訂單 |
使用Moya接入API,它的設(shè)計(jì)風(fēng)格就是利用枚舉來(lái)實(shí)現(xiàn),特別很好的利用枚舉綁定值這個(gè)特性
// 生成請(qǐng)求封裝類
let orderProvider = MoyaProvider<OrderApi>()
/// 訂單相關(guān)api
enum OrderApi {
case list(pageNO: Int = 1, pageSize: Int = 10)
case findOne(sn: String)
}
/// 實(shí)現(xiàn)TargetType協(xié)議
extension OrderApi: TargetType {
/// url
var baseURL: URL {
return URL(string: "http://127.0.0.1:8080/order")!
}
/// 請(qǐng)求路徑
var path: String {
switch self {
case .list:
return "list"
case .findOne(_):
return "findById"
}
}
/// 請(qǐng)求方式
var method: Moya.Method {
return .post
}
/// 解析格式
var sampleData: Data {
return "{}".data(using: String.Encoding.utf8)!
}
var task: Task {
// 公共參數(shù)
var params: [String: Any] = ["token": "Gz1qYLXeBW8MZuUfDlr9wsAYuVS1cZFMJY9BbaF842L2gRps747o4w=="]
// 收集參數(shù)
switch self {
case let .list(pageNO, pageSize):
params["pageNO"] = pageNO
params["pageSize"] = pageSize
case .findOne(let sn):
params["sn"] = sn
}
// 發(fā)起請(qǐng)求
return .requestParameters(parameters: params, encoding: URLEncoding.default)
}
/// 公共請(qǐng)求頭
var headers: [String : String]? {
return ["devtype": "iOS", "devid": UIDevice().identifierForVendor?.uuidString ?? "unknow"]
}
}
調(diào)用發(fā)送請(qǐng)求
orderProvider.request(OrderApi.findOne(sn: "DJKRE3248DFHJEW23")) { (result) in
let json = try! JSON(data: result.value!.data)
}
3. 高級(jí)使用
實(shí)際使用中可能有很多需求囚枪,并不像上述這么簡(jiǎn)單,比如顯示網(wǎng)絡(luò)指示器簿晓、統(tǒng)一加密解密后回調(diào)等等...Moya中的解決方案是在MoyaProvider創(chuàng)建的時(shí)候眶拉,可以傳入回調(diào)閉包和插件
import Foundation
import Moya
import SwiftyJSON
import KRProgressHUD
//import Alamofire
import enum Result.Result
let endpointClosure = { (target: LawApi) -> Endpoint in
var endpoint: Endpoint = MoyaProvider.defaultEndpointMapping(for: target)
endpoint = endpoint.adding(newHTTPHeaderFields: ["appName": appName()])
let request = try! endpoint.urlRequest()
DLog("\n請(qǐng)求地址:\(request.url!.absoluteString)\n" + "請(qǐng)求頭:\(request.allHTTPHeaderFields!)\n" + "請(qǐng)求參數(shù):\(String(describing: String(data: request.httpBody!, encoding: .utf8)?.components(separatedBy: "&")))")
return endpoint
}
let requestClosure = { (endpoint: Endpoint, done: MoyaProvider.RequestResultClosure) -> Void in
// done(.success(<#T##URLRequest#>))
}
// 插件寫(xiě)法
class LoadingPlugin: PluginType {
func prepare(_ request: URLRequest, target: TargetType) -> URLRequest {
return request
}
func willSend(_ request: RequestType, target: TargetType) {
KRProgressHUD.show()
}
func didReceive(_ result: Result<Response, MoyaError>, target: TargetType) {
KRProgressHUD.dismiss()
}
func process(_ result: Result<Response, MoyaError>, target: TargetType) -> Result<Response, MoyaError> {
// 在這里對(duì)請(qǐng)求進(jìn)行統(tǒng)一處理(比如有加密千埃,可以統(tǒng)一進(jìn)行解密)
if let value = result.value, let _ = try? JSONSerialization.jsonObject(with: value.data, options: JSONSerialization.ReadingOptions.allowFragments) as? [String: Any] {
let ob = ["code": 666, "description": "牛逼大發(fā)了"] as [String : Any]
let data = try! JSONSerialization.data(withJSONObject: ob, options: JSONSerialization.WritingOptions.fragmentsAllowed)
let response = Response(statusCode: value.statusCode, data: data, request: value.request, response: value.response)
let res = Result<Response, MoyaError>.init(value: response)
return res
}
return result
}
}
// 生成請(qǐng)求封裝類
let lawProvider = MoyaProvider<LawApi>(endpointClosure: endpointClosure, plugins: [LoadingPlugin()])
enum LawApi {
case getUserInfo
case getNewsList(pageNo: Int = kPAGENO, pageSize: Int = kPAGESIZE)
case getNewsDetail(id: String)
}
extension LawApi: TargetType {
var baseURL: URL {
return URL(string: "http://xxoo/parse/rest.q4w")!
}
var path: String {
return ""
}
var method: Moya.Method {
return .post
}
var sampleData: Data {
return "{}".data(using: String.Encoding.utf8)!
}
var task: Task {
// 公共參數(shù)
var params: [String: Any] = ["appsid": "Gz1qYLXeBW8MZuUfDlr9wsAYuVS1cZFMJY9BbaF842L2gRps747o4w=="]
// 收集參數(shù)
switch self {
case .getUserInfo:
params["cfg"] = "com.lawyee.lam.web.parse.dto.LamUserDto@getUserInfo"
case let .getNewsList(pageNo, pageSize):
params["cfg"] = "com.lawyee.lam.web.parse.dto.LamNewsDto@getNewsList"
params["pageNo"] = pageNo
params["pageSize"] = pageSize
case .getNewsDetail(let id):
params["cfg"] = "com.lawyee.lam.web.parse.dto.LamNewsDto@getNewsDetail"
params["id"] = id
}
// 發(fā)起請(qǐng)求
return .requestParameters(parameters: params, encoding: URLEncoding.default)
}
var headers: [String : String]? {
return ["devtype": "wechat", "devid": "af533cbd0168f046e60817b04fd5db7f2057"]
}
}