Alamofire学习小结(基本使用)

一 安装:

cocoapods的配置文件如下:(cocoapods需要更新版本,才支撑swift的第三方框架,更新的方法可以参考:CocoaPods1.1.1更新

Podfile:        

 source 'https://github.com/CocoaPods/Specs.git'        

 platform :ios, '10.0'        

 use_frameworks!                

 target '' do

pod 'Alamofire', '~> 4.0'

end

完成之后添加一下动态库,如下图:


 二 基础用法:

Response handler

Alamofire 的网络操作都是异步进行(用response handler)的,最基本的请求代码如下:

Alamofire.request("https://httpbin.org/get").responseJSON { response in

print(response.request)  // original URL request

print(response.response) // HTTP URL response

print(response.data)    // server data

print(response.result)  // result of response serialization

if let JSON = response.result.value {

print("JSON: \(JSON)")

}}

Alamofire 默认包含物种类型的response handlers:response responseString responseJSON responseData

两种高级的方式:

1.Chained Response Handlers(链式,注意:会访问服务器数据多次)

Alamofire.request("https://httpbin.org/get")

.responseString { response in

print("Response String: \(response.result.value)")

}

.responseJSON { response in

print("Response JSON: \(response.result.value)")

}

It is important to note that using multiple response handlers on the same Request requires the server data to be serialized multiple times. Once for each response handler.

2.Response Handler Queue(多线程)

Response handlers 默认是在主线程上运行的,可以添加到GCD队列中。

let utilityQueue = DispatchQueue.global(qos: .utility)

Alamofire.request("https://httpbin.org/get").responseJSON(queue: utilityQueue) { response in

print("Executing response handler on utility queue")

}

判断服务器返回的数据有效性的方式:

Manual Validation

Alamofire.request("https://httpbin.org/get")

.validate(statusCode: 200..<300)

.validate(contentType: ["application/json"])

.responseData { response in

switch response.result {

case .success:

print("Validation Successful")

case .failure(let error):

print(error)

}}

Automatic Validation

Automatically validates status code within 200...299 range, and that the Content-Type header of the response matches the Accept header of the request, if one is provided.

Alamofire.request("https://httpbin.org/get").validate().responseJSON { response in

switch response.result {

case .success:

print("Validation Successful")

case .failure(let error):

print(error)

}}

 三 HTTP相关:

 HTTP Methods

public enum HTTPMethod: String {

case options = "OPTIONS"

case get    = "GET"

case head    = "HEAD"

case post    = "POST"

case put    = "PUT"

case patch  = "PATCH"

case delete  = "DELETE"

case trace  = "TRACE"

case connect = "CONNECT"

}

默认方法是 get

Alamofire.request("https://httpbin.org/post", method: .post)

Alamofire.request("https://httpbin.org/put", method: .put)

Alamofire.request("https://httpbin.org/delete", method: .delete)

Parameter Encoding(参数编码)

Alamofire 支持3种类型的参数编码:URL, JSON and PropertyList。也可以自定义类型,需支持ParameterEncoding协议。

 HTTP Headers(Http 头部)

let headers: HTTPHeaders = [

"Authorization": "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==",

"Accept": "application/json"

]

Alamofire.request("https://httpbin.org/headers", headers: headers).responseJSON { response in

debugPrint(response)

}

Alamofire SessionManager提供了默认的头部,内容如下:

• Accept-Encoding, which defaults to gzip;q=1.0, compress;q=0.5, per RFC 7230 §4.2.3.

• Accept-Language, which defaults to up to the top 6 preferred languages on the system, formatted like en;q=1.0, per RFC 7231 §5.3.5.

• User-Agent, which contains versioning information about the current app. For example: iOS Example/1.0 (com.alamofire.iOS-Example; build:1; iOS 10.0.0) Alamofire/4.0.0, per RFC 7231 §5.5.3.

如果需要自定义头部信息,需要这么来做:

If you need to customize these headers, a custom URLSessionConfiguration should be created, the defaultHTTPHeaders property updated and the configuration applied to a new SessionManager instance.

 Authentication(验证)

支持四种验证机制:

HTTP Basic          HTTP Digest        Kerberos      NTLM

基本的用法:

let user = "user"

let password = "password"

Alamofire.request("https://httpbin.org/basic-auth/\(user)/\(password)")

.authenticate(user: user, password: password)

.responseJSON { response in

debugPrint(response)

}

 四 Downloading Data to a File(下载文件)

Alamofire可以加载数据到内存缓存或者沙盒缓存,Alamofire.request用来将数据保存在内存中,这比较高效,但不适用于大文件的保存;使用Alamofire.download可以将大文件保存到应用的沙盒中。

Alamofire.download("https://httpbin.org/image/png").responseData { response in

if let data = response.result.value {

let image = UIImage(data: data)

}}

如果需要后台下载,需这样设置:

let configuration = URLSessionConfiguration.background(withIdentifier: "com.example.app.background")

let sessionManager = Alamofire.SessionManager(configuration: configuration)

sessionManager.download("https://httpbin.org/image/png").responseData { response in

if let data = response.result.value {

let image = UIImage(data: data)

}}

使用DownloadFileDestination

可以将文件从临时路径移动到目标路径:

let destination: DownloadRequest.DownloadFileDestination = { _, _ in

let documentsURL = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask)[0]

let fileURL = documentsURL.appendPathComponent("pig.png")

return (fileURL, [.removePreviousFile, .createIntermediateDirectories])

}

Alamofire.download(urlString, to: destination).response { response in

print(response)

if response.error == nil, let imagePath = response.destinationURL?.path {

let image = UIImage(contentsOfFile: imagePath)

}}

也可以使用建议的路径:

let destination = DownloadRequest.suggestedDownloadDestination(directory: .documentDirectory)

Alamofire.download("https://httpbin.org/image/png", to: destination)

监测下载进度:

Alamofire.download("https://httpbin.org/image/png")

.downloadProgress { progress in

print("Download Progress: \(progress.fractionCompleted)")

}

.responseData { response in

if let data = response.result.value {

let image = UIImage(data: data)

}}

可以将下载的进程加入到一个GCD队列中:

let utilityQueue = DispatchQueue.global(qos: .utility)

Alamofire.download("https://httpbin.org/image/png")

.downloadProgress(queue: utilityQueue) { progress in

print("Download Progress: \(progress.fractionCompleted)")

}

.responseData { response in

if let data = response.result.value {

let image = UIImage(data: data)

}}

 五 其他部分:

 Statistical Metrics(统计)

统计网络延时,响应时间等数据

Alamofire.request("https://httpbin.org/get").responseJSON { response in

print(response.timeline)

}

cURL Command Output (调试工具)

CustomStringConvertible

let request = Alamofire.request("https://httpbin.org/ip")

print(request)

// GET https://httpbin.org/ip (200)

CustomDebugStringConvertible

let request = Alamofire.request("https://httpbin.org/get", parameters: ["foo": "bar"])

debugPrint(request)


参考代码

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,324评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,303评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,192评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,555评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,569评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,566评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,927评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,583评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,827评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,590评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,669评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,365评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,941评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,928评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,159评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,880评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,399评论 2 342

推荐阅读更多精彩内容