Swift中的网络请求库Alamofire,相当于OC中的AFNetworking,在使用的过程中,我们一般都会对Alamofire做进一步的封装,可是结果大多不太理想。
所以就引出了今天的主角Moya,它是一个网络抽象层,封装的比较充分,并且是直接调用Alamofire,借用一下Moya的图如下。
Moya
下面就来说一下Moya的基本使用方法。
本文Demo的Github地址:MoyaDemo
1、创建网络层.swift文件
这里我创建了一个WHService.swift文件
创建swift.文件
2、定义网络请求接口
实际上是定义一个枚举,枚举值就是每个网络请求API。
// 定义请求方法 enum WHService { case demo1 case demo2(name: String) case demo3(name: String, score: Int) }
3、扩展遵守协议,并实现协议方法
这一步我们创建一个扩展,并遵守TargetType协议,这个协议中有6个方法需要实现,具体意义看下面代码中的注释
extension WHService: TargetType { // 请求服务器的根路径 var baseURL: URL { return URL.init(string: "https://httpbin.org")! } // 每个API对应的具体路径 var path: String { switch self { case .demo1: return "/get" case .demo2(name: _), .demo3(name: _, score: _): return "/post" } } // 各个接口的请求方式,get或post var method: Moya.Method { switch self { case .demo1: return .get case .demo2, .demo3: return .post } } // 请求是否携带参数,如果需要参数,就做如demo2和demo3的设置 var task: Task { switch self { case .demo1: return .requestPlain // 无参数 case let .demo2(name): // 带有参数,注意前面的let return .requestParameters(parameters: ["name" : name], encoding: URLEncoding.default) case let .demo3(name, score): // 带有参数,注意前面的let return .requestParameters(parameters: ["name" : name, "score" : score], encoding: URLEncoding.default) } } // 单元测试使用 var sampleData: Data { switch self { case .demo1, .demo3: return "just for test".utf8Encoded case .demo2(let name): return "{/"name/": /(name)/"}".utf8Encoded } } // 请求头 var headers: [String : String]? { return ["Content-type" : "application/json"] } }
4. 实现网络请求(推荐第5步的做法,可以忽略本条,直接查看第5步)
如下代码所示,首先创建一个MoyaProvider,并跟上
然后直接调用request方法请求数据。
注意:request方法的参数就是上面定义的方法枚举,由此调用不同的API。达到了把网络请求封装到了WHService.swift中的需求。
let provider = MoyaProvider() provider.request(.demo1) { (result) in switch result { case let .success(moyaResponse): let data = moyaResponse.data // 获取到的数据 let statusCode = moyaResponse.statusCode // 请求状态: 200, 401, 500, etc case let .failure(error): print(error.localizedDescription) } }
5. 创建Network结构体实现网路请求
在WHService.swift中创建一个WHNetwork结构体,用单例创建MoyaProvider。
这样的好处是,可以在任何需要的地方通过WHNetwork调用任意API。
// 网络请求结构体 struct WHNetwork { // 请求成功的回调 typealias successCallback = (_ result: Any) -> Void // 请求失败的回调 typealias failureCallback = (_ error: MoyaError) -> Void // 单例 static let provider = MoyaProvider() // 发送网络请求 static func request( target: WHService, success: @escaping successCallback, failure: @escaping failureCallback ) { provider.request(target) { result in switch result { case let .success(moyaResponse): do { try success(moyaResponse.mapJSON()) // 测试用JSON数据 } catch { failure(MoyaError.jsonMapping(moyaResponse)) } case let .failure(error): failure(error) } } } }
完成了WHService.swift中的工作之后,现在我们在ViewController.swift中进行网络访问,来看一下效果。
override func viewDidLoad() { super.viewDidLoad() WHNetwork.request(target: .demo1, success: { (result) in whLog(result) }) { (error) in whLog(error.localizedDescription) } WHNetwork.request(target: .demo2(name: "wuhao"), success: { (result) in whLog(result) }) { (error) in whLog(error.localizedDescription) } WHNetwork.request(target: .demo3(name: "wuhao", score: 100), success: { (result) in whLog(result) }) { (error) in whLog(error.localizedDescription) }
显然比较简洁,并且用闭包的方式获取到需要的数据。
后记
本文简单介绍了Moya的使用方法,更多用法或注意事项可以到Github上学习:Moya
本文Demo地址:MoyaDemo
我的GitHub