Alamofire 是一个跨平台的网络框架,由著名的AFNetworking 的作者用Swift 3.0开发完成,目前支持的平台包含 (iOS 8.0+ / macOS 10.10+ / tvOS 9.0+ / watchOS 2.0+),可以说是Swift开发App必备的工具,目前的版本是4.4.0,本文是阅读Alamofire源码的一些总结。
Alamofire.swift
这个文件是用来快捷发送请求的,定义了一些方便的方法,供我们调用。
一个get请求最简单的调用方式,看起来清新明快:
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)")
}
}
另外针对文件下载,上传,多格式文件上传,二进制流文件的拉取都提供了对SessionManager的封装:
//Data Request
//Download Request
//Upload Request
//Stream Request
另外这个文件还定义了两个协议:
public protocol URLConvertible
用来快捷构造URL
URLRequestConvertible
用来快捷构造URLRequest
这里提供的一些便利方法,让我们更加方便的使用Alamofire发送HTTP请求。
ParameterEncoding.swift
ParameterEncoding 给我们提供了对请求参数进行格式化的功能,一般我们的发送请求的时候,都会按照key=value的方式,带上各种参数,但是在代码里面我们一般会构建一个参数的字典,但是HTTP请求是不认识我们OC或者Swift的数据结构的(例如:Array,Dictionary,Set),所以我们需要对参数进行格式化形成在HTTP请求中能够传输的数据格式。
格式化的过程大致是这样的:
[
"username": "ParadiseTaboo",
"phone": ["mobile": "138xxxx", "home": "010-xxxx","work": 123456],
"merry": false,
"families": ["father", "mother"]
]
-->
families%5B%5D=father&families%5B%5D=mother&merry=0&phone%5Bmobile%5D=138xxxx&phone%5Bwork%5D=123456&phone%5Bhome%5D=010-xxxx&username=ParadiseTaboo
ParameterEncoding 帮我们做了以下几件事:
1.把swift的数据结构格式化成了Url的参数,对于GET/HEAD/DELETE方法,把参数加到Url后面,对于POST/PUT等其他方法,把参数先转化成字符串,在转化成Data并且赋值为httpBody,并根据转化的类型设置好HTTPHeader的Content-Type告诉服务端编码类型;
2.对Url进行编码,去除掉特殊字符,满足RFC 3986的标准要求;
3.支持对满足格式要求的结构转化成Json或者plist格式,其实是调用了系统的JSONSerialization和PropertyListSerialization两个工具,对参数进行格式化;
4.支持自定义的格式化方法,其实是对protocol ParameterEncoding的方法func encode(_ urlRequest: URLRequestConvertible, with parameters: Parameters?) throws -> URLRequest的实现。
MultipartFormData.swift
Alamofire为构建MultipartFormData专门新建了一个文件,处理多格式文件的上传。
Multipart协议介绍
Multipart是HTTP协议为web表单新增的上传文件的协议,协议文档是rfc1867,它基于HTTP的POST方法,数据同样是放在body上,跟普通POST方法的区别是数据不是key=value形式,key=value形式难以表示文件实体,为此Multipart协议添加了分隔符,有自己的格式结构,大致如下:
—AaB03x
content-disposition: form-data; name=“name"
ParadiseTaboo
–AaB03x
content-disposition: form-data; name=”pic”; filename=“content.txt”
Content-Type: text/plain
...contents of bang.txt...
–AaB03x–
以上表示数据name=ParadiseTaboo以及一个文件,content.txt是文件名,...contents of bang.txt...是文件实体内容。分隔符—AaB03x是可以自定义的,写在HTTP头部里:
Content-type: multipart/form-data, boundary=AaB03x
每一个部分都有自己的头部,表明这部分的数据类型以及其他一些参数,例如文件名,普通字段的key。最后一个分隔符会多加两横,表示数据已经结束:—AaB03x—。
实现方式
由以上可知我们的目的就是把文件按照符合协议规则的方式组装起来,赋值给HTTP的body部分,URLSession就会如我们所愿上传多种格式的文件给服务端。
我们自然而然能想到的就是文件的转化和拼接,我们创建一个可变的Data容器,把拼接好的二进制数据都追加在后面,赋值给URLRequest的httpBody属性,这样做当然是可以的,但是有一个致命的缺项就是,我们这些操作都是在内存中进行的,一旦我们要上传的文件尺寸过大,我们的内存就会爆掉。
有另外一种方式是把上述过程放到文件系统中来做,每次创建一个文件来保存拼接好的数据,再读取该文件分片上传。
Alamofire给我们提供了一种跟有效的方式,通过一个自定义的MultipartFormData类型,分片读取要上传的文件,转化成bodyPart,参考设置的内存阈值来决定是在内存中操作,还是写到文件系统中进行操作,上传的时候我们有可能直接从内存中取到数据,也有可能从外存中分片读取数据。
关于InputStream/OutputStream
private func write(_ buffer: inout [UInt8], to outputStream: OutputStream) throws {
var bytesToWrite = buffer.count//要写入的字节数
while bytesToWrite > 0, outputStream.hasSpaceAvailable {
let bytesWritten = outputStream.write(buffer, maxLength: bytesToWrite)//执行写入操作
if let error = outputStream.streamError {
throw AFError.multipartEncodingFailed(reason: .outputStreamWriteFailed(error: error))//捕获错误信息
}
bytesToWrite -= bytesWritten//去掉已经写入的字节数
if bytesToWrite > 0 {
buffer = Array(buffer[bytesWritten..<buffer.count])//把写入的开始位置移动到上次写入完成的位置向后一个字节,直到写入完成
}
}
}
无论是读取文件还是写入文件都是通过文件流的方式来操作,InputStream(输入流),OutputStream(输出流)是iOS平台用来操作文件的一种方式,我们把Data数据通过一个buffer写到OutputStream中,系统会把流写到文件系统中。