swift4.0 -Moya使用(包含批量上传图片,请求出错或者业务统一处理)

学习目的

我只是出于对于这个框架的好奇,曾经我在学习swift的时候,就是用的Alamofire,突然发现有一个很优雅的第三方是基于这个向上封装。并且,我很久没有写swift了。

功能

本文包含了Moya的基本使用和图片批量上传(视频等其它文件上传跟图片上传类似)。并且应用泛型实现了对返回结果统一做出处理,便于统一处理一些业务或者错误。

  • 实现协议

LoginAPIManager文件包含一个登陆的请求,一个批量上传图片的请求(单张请自行做修改)。分别传入了对应的参数,小伙伴可以根据自己需求去写这个枚举。
这里啰嗦一下,请求的manager请做好分类,这样找起来会方便很多,根据功能,或者根据模块等都可以。

public enum LoginAPIManager {
    case login(name:String,password:String) //登录
    case uploadPictures(paramsDic:NSMutableDictionary,dataAry:NSArray)  //上传图片
}

实现TargetType协议内容,代码中注释很清楚了哈。

extension LoginAPIManager: TargetType {
    public var baseURL: URL {
        return URL(string: kBaseUrl)!   //这里是aip的base
    }
    
    public var path: String {
        switch self {
        case .login(_, _):
            return "登陆请求api"  //(这里请写上自己的api哦)
        case .uploadPictures(_, _):
            return "上传图片api"  //(这里请写上自己的api哦)
        }
       
    }
    //请求方式
    public var method: Moya.Method {
        return .post
    }

    //请求任务事件,带上参数
    public var task: Task {
        switch self {
        case .login( let name, let password):
            return .requestParameters(parameters: ["userAccount": name,"initialPassword" : password], encoding: JSONEncoding.default)
        case .uploadPictures( let paramsDic, let dataAry):
            let formDataAry:NSMutableArray = NSMutableArray()
            for (index,image) in dataAry.enumerated() {
                //图片转成Data
                let data:Data = UIImageJPEGRepresentation(image as! UIImage, 0.9)!
                //根据当前时间设置图片上传时候的名字
                let date:Date = Date()
                let formatter = DateFormatter()
                formatter.dateFormat = "yyyy-MM-dd-HH:mm:ss"
                var dateStr:String = formatter.string(from: date as Date)
                //别忘记这里给名字加上图片的后缀哦
                dateStr = dateStr.appendingFormat("-%i.png", index)
                
                let formData = MultipartFormData(provider: .data(data), name: "file", fileName: dateStr, mimeType: "image/jpeg")
                formDataAry.add(formData)
            }
            return .uploadCompositeMultipart(formDataAry as! [MultipartFormData], urlParameters: paramsDic as! [String : Any])
//        default:
//            return .requestPlain    // 没有参数
        }
    }
    
    //是否执行Alamofire验证
//    public var validate: Bool {
//        return false
//    }
    
    //验证方式
    public var validationType: ValidationType {
        return .none
    }

    //这个就是做单元测试模拟的数据,只会在单元测试文件中有作用
    public var sampleData: Data {
        return "{}".data(using: String.Encoding.utf8)!
    }
    
    //请求头
    public var headers: [String: String]? {
        return nil
    }
}
  • 泛型实现返回结果统一处理

这里的endpointMapping是为了便于出错的情况下,清楚的知道这个请求的相关信息。

EDBaseAdapter这个文件,是用来对于请求的返回值,做统一处理的。在这个文件的
上层做一些紧密业务的处理,这里可以抛出问题和做一些大家共同需要处理的业务或者错误。

例如:这里可以做,如果你的项目session过期了,要统一弹出登录页面。还有业务出错,错误码的解析,都可以放在这个文件里面。

这里实现思路是用泛型的概念,传了枚举作为参数的方法,生成一个实现了TargetType协议的类,从而去调用request方法。

这里的泛型我理解了很久,因为我不知道为什么我传了一个LoginAPIManager里面的枚举对象,就可以生成一个LoginAPIManager的Provider。后来我这样理解,虽然我传入的是一个LoginAPIManager的枚举,但是实际上在生成MoyaProvider,用到的是LoginAPIManager实现的TargetType协议,枚举泛指着LoginAPIManager这个类。个人理解,可能会不对哈。

private func endpointMapping<Target: TargetType>(target: Target) -> Endpoint {
    
    print("请求连接:\(target.baseURL)\(target.path) \n方法:\(target.method)\n参数:\(String(describing: target.task)) ")
    return MoyaProvider.defaultEndpointMapping(for: target)
}
class EDBaseAdapter:NSObject {
    
    class func  request<T:TargetType>(
        _ target:T,success successCallback: @escaping (Any) -> Void,
        error errorCallback: @escaping (Int,String ) -> Void,
        failure failureCallback: @escaping (MoyaError) -> Void
        ) {
        let provider = MoyaProvider<T>(endpointClosure: endpointMapping,plugins:[])
        provider.request(target) { (result) in
        switch result {
            case let .success(response):
                do {
                    let data = try response.mapJSON()
                    let statusCode = response.statusCode
                    //在我的项目里,200和201是请求成功。
                    if (statusCode == 201 || statusCode == 200) {
                        //解析登录数据
                        print("请求成功")
                        successCallback(data)
                    } else {
                        //请求报错提示,一般处理业务提示
                        print("请求出错了")
                        let dict = data
                        errorCallback(statusCode,(dict as AnyObject).object(forKey:"message") as! String)
                    }
                } catch {
                    //可不做处理
                }
                break
            case let .failure(error):
                print(error)
                failureCallback(error)
                break
            }
        }
    }
}

请求调用

下面的方法,我自己写完测试,是可以获取到数据的。

        //登录调用
        EDBaseAdapter.request(LoginAPIManager.login(name: self.userNameTextField.text!, password: self.passwordTextField.text!), success: { (data) in
            print(data)
        }, error: { (statutCode, message) in
            print(statutCode,message)
        }) { (error) in
            print(error)
        }
        
        //上传图片调用
        let paramsDic:NSMutableDictionary = NSMutableDictionary()
        paramsDic.setValue(0, forKey: "projectType")
        EDBaseAdapter.request(LoginAPIManager.uploadPictures(paramsDic: paramsDic, dataAry:NSArray.init(object: UIImage.init(named: "example")!)), success: { (data) in
            print(data)
        }, error: { (statutCode, message) in
            print(statutCode,message)
        }) { (error) in
            print(error)
        }

结尾

如果有什么问题或者疑问,请告知我。可能我回复慢,或者不及时请谅解一下呢。但是态度绝对是很端正的。还有,妹子还是写OC的,swift边写边学,不懂的再找资料。所以,描述或者用词不准确,请谅解同时请告知我,我看到会及时更正。希望能够一起学习和一起进步。
有一个简单的工程,里面包含了这些文件。是我随手写的一个登陆的界面,登录事件里面调用了文中登录和上传图片的方法。
链接:https://pan.baidu.com/s/132XqsEzdEV0q0A2SiIdbJQ 密码:0m51

推荐阅读更多精彩内容