Swift网络请求基础篇-Alamofire

安装Alamofire

可以通过Cocoapods的方式进行安装,podfile配置如下:

platform :ios, '8.0'
use_frameworks!
target '你的工程名称' do
pod 'Alamofire', '~> 3.3.0'
end

然后到终端执行pod install就可以了,使用之前先import一下

1	import Alamofire

基本使用,请求数据

普通数据请求

//我把请求放在了button的点击事件里面
    @IBAction func onBtnClick(sender: UIButton) {
        //这里我使用一个查询手机号码归属地的接口为例,
        Alamofire.request(.GET,, requestURL,parameters: ["phone":phoneNumber],encoding: .URL,headers: ["apix-key":apiKey]).responseJSON { (response) in
            //是否请求成功
//            if response.result.isSuccess{}
            if let jsonValue = response.result.value {
                print(jsonValue)
            }
        }
    }

Alamofire.request(Method, URLString, parameters, encoding, headers)
//这是一个完整的Alamofire.Request的初始化方法,其中:
//Method,请求方式,如:.GET .POST .DELETE等
//URLString,请求接口
//parameters,请求参数,字典类型,如果是GET方法请求数据,传入的参数将会被转换为key1=value1&key2=value2的形式
//encoding,编码方式,Alamofire提供一个枚举来表示请求所用编码,如.URL,.JSON,那么GET方式请求数据一般使用.URL编码方式
//headers,请求头,对应于在NSURLRequest中的属性allHTTPHeaderFields

这里是一个普通的GET请求,传入的参数Alamofire自动以key=value&kay2=value2的形式拼接,如果请求是POST或者需要把请求参数已JSON的形=形式传输的话,encoding参数传入.JSON即可
responseJSON闭包中我们得到的参数是一个结构体,里面分别包含了此次请求的request对象,返回数据,请求结果等.

响应结果控制

Alamofire.request()返回的是一个Request对象,Request对象的参数都是本次请求中附带的参数,responseJSON是对返回结果的控制,针对返回结果为JSON数据的情况,Alamofire中还提供了处理其他返回结果地方法:

response()
responseData()//二进制数据
responseString(encoding: NSStringEncoding)//字符串结果
responseJSON(options:NSJSONReadingOptions)//JSON数据
responsePropertyList(options: NSPropertyListReadOptions)//属性列表
///响应方式应该试服务器返回结果而定,如果服务器给你的是JSON数据那么就用responseJSON,如果是其他数据那么也使用对应的

使用validate()验证是否请求成功

 Alamofire.request(.GET, requestURL,parameters:["phone":phoneNumber],encoding: .URL,headers: ["apix-key":apiKey]).validate().responseJSON { (response) in
            //是否请求成功
            switch response.result{
            case .Success:
                print("数据请求成功")
            case .Failure(let error):
                print(error)
            }
        }

validate()将确认响应的状态编码控制在可接受的范围200-299内,如果验证失败,那么在响应的处理方法内部将会出现一个错误.

上传数据

一个简单地上传文件的小栗子
let fileURL = NSBundle.mainBundle().URLForResource("1", withExtension: "jpg")
Alamofire.upload(.POST, uploadURL, file: fileURL!)
//这里的前面两个参数分别是连接方式,请求接口,第三个参数就是需要上传的文件的本地URL

当然也可以使用NSData的形式上传:

1	Alamofire.upload(.POST, uploadURL, data: "upload Data".dataUsingEncoding(NSUTF8StringEncoding)!)

其他的还有使用MultipartFormData等,这里就不做介绍了.

上传附件时监测进度

Alamofire.upload(.POST, uploadURL, data: "upload Data".dataUsingEncoding(NSUTF8StringEncoding)!).progress { (written, totalWritten, totalNeedsToWrite) in
            print("written bytes \(written) totalWritten \(totalWritten)  totalBytes\(totalNeedsToWrite)")
///每次上传一部分数据就会回调此闭包.
        }

同样的,不管是上传还是请求数据或是下载文件,我们都可以得到服务器的响应,所以上传也是可以使用response系列方法的:

Alamofire.upload(.POST, uploadURL, data: "upload Data test ".dataUsingEncoding(NSUTF8StringEncoding)!).progress { (written, totalWritten, totalNeedsToWrite) in
            print("written bytes \(written) totalWritten \(totalWritten)  totalBytes\(totalNeedsToWrite)")
        }.responseJSON { (response) in
            print(response)//服务器对本次数据上传的响应
        }

有上传就有下载,Alamofire提供Alamofire.download()方法来执行下载操作:

///本例中所下载的文件是在网上随便找的一张图片
Alamofire.download(.GET, "http://pic.to8to.com/attch/day_160218/20160218_d968438a2434b62ba59dH7q5KEzTS6OH.png") { (URL, response) -> NSURL in
         var path = NSSearchPathForDirectoriesInDomains(.DocumentDirectory, .UserDomainMask, true)[0]
         path += "/\(response.suggestedFilename!)"
         return NSURL.fileURLWithPath(path)
}

download方法接受一个闭包,此闭包在文件下载完成后调用,我们需要在闭包中返回文件下载完毕之后,保存此文件的资源路径,你也可以单独拆分一个函数,然后传入函数名即可
如果觉得这样比较麻烦或者没有必要在闭包中那些代码,我们可以使用默认的资源路径:

///这里使用的是系统的Document路径
 let destina = Alamofire.Request.suggestedDownloadDestination(directory: .DocumentDirectory, domain: .UserDomainMask)
        
 Alamofire.download(.GET, "http://pic.to8to.com/attch/day_160218/20160218_d968438a2434b62ba59dH7q5KEzTS6OH.png",destination: destina)

同样的,下载文件也可以检测下载进度

let destina = Alamofire.Request.suggestedDownloadDestination(directory: .DocumentDirectory, domain: .UserDomainMask)
Alamofire.download(.GET, "http://pic.to8to.com/attch/day_160218/20160218_d968438a2434b62ba59dH7q5KEzTS6OH.png",destination: destina).progress { (downloadBytes, totalDownloadBytes, totalBytesToDownload) in
            //在此实现检测下载进度逻辑
        }

如果需要实现断点续传来下载文件的话,实现起来也是比较简单,首先,Alamofire提供了对应的download方法:

1	Alamofire.download(resumeData: NSData() , destination: destina)

第一个参数应该传入已经下载得到的数据,就可以在已经下载数据的基础上继续下载,那么我们需要做的事就只有在下载出现错误或者暂停的时候把已下载数据保存起来就可以了,大致的实现思路就是这样,我这里就不作演示了.

暂时先总结到这里,如果本文中有什么写的不正确的地方,欢迎指正!
(搬运自本人的简书)