Alamofire Request流程分析

Alamofire是一个网络请求的框架,使用起来非常简单,几行代码就可以实现网络请求的功能。那么它内部到底做了些什么呢?让我们不用再写一些繁琐的代码就能够实现同样的功能。这边文章就来分析下Request模块的具体实现。

Request整个流程分析

SessionManager.default.request(urlStr, method: .get, parameters: ["name":"xxx"])
    .response { (response) in
        print(response)
}
  • 这是一个非常简单的请求网络代码,直接进入到request方法里面
open func request(
    _ url: URLConvertible,
    method: HTTPMethod = .get,
    parameters: Parameters? = nil,
    encoding: ParameterEncoding = URLEncoding.default,
    headers: HTTPHeaders? = nil)
    -> DataRequest
{
    var originalRequest: URLRequest?

    do {
        originalRequest = try URLRequest(url: url, method: method, headers: headers)
        let encodedURLRequest = try encoding.encode(originalRequest!, with: parameters)
        return request(encodedURLRequest)
    } catch {
        return request(originalRequest, failedWith: error)
    }
}
  • 首先创建了一个URLRequest对象,然后对请求参数进行编码。Alamofire支持的编码格式有三种:
    • URLEncoding: URL相关的编码,有两种编码方式:1.直接拼接到URL中,2.通过request的httpBody传值
    • JSONEncoding 把参数字典编码成JSONData后赋值给request的httpBody
    • PropertyListEncoding 把参数字典编码成PlistData后赋值给request的httpBody
  • 进入到encode方法查看参数编码的具体实现
public func encode(_ urlRequest: URLRequestConvertible, with parameters: Parameters?) throws -> URLRequest {
    var urlRequest = try urlRequest.asURLRequest()

    guard let parameters = parameters else { return urlRequest }

    if let method = HTTPMethod(rawValue: urlRequest.httpMethod ?? "GET"), encodesParametersInURL(with: method) {
        guard let url = urlRequest.url else {
            throw AFError.parameterEncodingFailed(reason: .missingURL)
        }

        if var urlComponents = URLComponents(url: url, resolvingAgainstBaseURL: false), !parameters.isEmpty {
            let percentEncodedQuery = (urlComponents.percentEncodedQuery.map { $0 + "&" } ?? "") + query(parameters)
            urlComponents.percentEncodedQuery = percentEncodedQuery
            urlRequest.url = urlComponents.url
        }
    } else {
        if urlRequest.value(forHTTPHeaderField: "Content-Type") == nil {
            urlRequest.setValue("application/x-www-form-urlencoded; charset=utf-8", forHTTPHeaderField: "Content-Type")
        }

        urlRequest.httpBody = query(parameters).data(using: .utf8, allowLossyConversion: false)
    }

    return urlRequest
}
  • 先获取urlRequest对象,然后通过请求方法判断参数怎么传递。如果是.get, .head, .delete就把参数拼接到URL后面,否则放到请求体里面。
  • 因为我们的请求是通过ASCII编码的,所以需要对参数进行百分号编码。进入到query方法。
private func query(_ parameters: [String: Any]) -> String {
    var components: [(String, String)] = []

    for key in parameters.keys.sorted(by: <) {
        let value = parameters[key]!
        components += queryComponents(fromKey: key, value: value)
    }
    return components.map { "\($0)=\($1)" }.joined(separator: "&")
}
  • 先对参数通过 ASCII 从小到大进行排序。然后循环遍历参数调用queryComponents方法。
public func queryComponents(fromKey key: String, value: Any) -> [(String, String)] {
    var components: [(String, String)] = []

    if let dictionary = value as? [String: Any] {
        for (nestedKey, value) in dictionary {
            components += queryComponents(fromKey: "\(key)[\(nestedKey)]", value: value)
        }
    } else if let array = value as? [Any] {
        for value in array {
            components += queryComponents(fromKey: arrayEncoding.encode(key: key), value: value)
        }
    } else if let value = value as? NSNumber {
        if value.isBool {
            components.append((escape(key), escape(boolEncoding.encode(value: value.boolValue))))
        } else {
            components.append((escape(key), escape("\(value)")))
        }
    } else if let bool = value as? Bool {
        components.append((escape(key), escape(boolEncoding.encode(value: bool))))
    } else {
        components.append((escape(key), escape("\(value)")))
    }

    return components
}
  • 判断参数类型分别处理,如果是集合类型,需要递归调用此方法。
  • keyvalue取出,然后进行了百分号编码。并把编码后的结果放进元组保存,形成参数对。然后把元组加入到数组中。
  • components.map { "\($0)=\($1)" }.joined(separator: "&")把数据中的数据通过map映射成($0)=\($1),然后在映射之后的元素之间加入一个分隔符号&进行拼接。
  • 如果是get,head,delete方法就直接拼接到URL的后面,如果是POST等方法就是把这些编码好的参数对放入请求体中。其中还要加入Content-Type的请求头。
  • 回到request方法里面,调用了request(encodedURLRequest)这个方法,跟踪进入。
open func request(_ urlRequest: URLRequestConvertible) -> DataRequest {
    var originalRequest: URLRequest?

    do {
        originalRequest = try urlRequest.asURLRequest()
        let originalTask = DataRequest.Requestable(urlRequest: originalRequest!)

        let task = try originalTask.task(session: session, adapter: adapter, queue: queue)
        let request = DataRequest(session: session, requestTask: .data(originalTask, task))

        delegate[task] = request

        if startRequestsImmediately { request.resume() }

        return request
    } catch {
        return request(originalRequest, failedWith: error)
    }
}
  • 参数urlRequestURLRequestConvertible类型的。URLRequestConvertible协议的目的是对URLRequest进行自定义的转换。在获得转换后的URLRequest后,需要用URLRequest生成task,这样才能发起网络请求。
  • 在上边的函数中,用到了DataRequest.RequestableRequestable其实一个结构体,他实现了TaskConvertible协议,因此,它能够用URLRequest生成与之相对应的task。在这里是通过内部的Requestable结构体来帮助 DataRequest 创建 Task,任务分层,架构思路更清晰。
  • 绑定 taskrequest , 方便在 SessionDelegate 下发任务,task 方便获取requestrequest也方便获取task
  • 执行任务 request.resume() 启动
  • 再来看看DataRequest的初始化
init(session: URLSession, requestTask: RequestTask, error: Error? = nil) {
    self.session = session

    switch requestTask {
    case .data(let originalTask, let task):
        taskDelegate = DataTaskDelegate(task: task)
        self.originalTask = originalTask
    case .download(let originalTask, let task):
        taskDelegate = DownloadTaskDelegate(task: task)
        self.originalTask = originalTask
    case .upload(let originalTask, let task):
        taskDelegate = UploadTaskDelegate(task: task)
        self.originalTask = originalTask
    case .stream(let originalTask, let task):
        taskDelegate = TaskDelegate(task: task)
        self.originalTask = originalTask
    }

    delegate.error = error
    delegate.queue.addOperation { self.endTime = CFAbsoluteTimeGetCurrent() }
}
  • Request 初始化的时候利用了枚举的便利性,构造创建,相关信息保存。
  • 在初始化的时候看到保存了一个taskDelegate属性,那么这个taskDelegate是干嘛用的呢?前面不是已经通过SessionDelegate这个类来专门实现了相关代理吗?为什么这里还要有一个 DataTaskDelegate
    • 首先 SessionDelegate 是所有 Session 的代理遵循者,任何的代理都会来到这里响应。但是里面不会实现具体的繁琐的任务,它会把任务下发到对应任务执行者。
    • DataTaskDelegate 就是我们具体繁琐任务执行者,这里面所有方法都是由 SessionDelegate 下发响应的。
    • SessionDelegate 是事件总响应者,它会把具体的事务交给具体的人去执行。不能因为在 SessionDelegate 能够拿到所有的响应,就把所有的代码都罗列在这里,那样会显得很臃肿很乱。所以我们根据不同的需求,响应总代理会根据需求的不同交给专业的人去做专业的事。耦合性大大降低,架构的分层更加明显。
  • 下面举个例子:
open func urlSession(
    _ session: URLSession,
    downloadTask: URLSessionDownloadTask,
    didFinishDownloadingTo location: URL)
{
    if let downloadTaskDidFinishDownloadingToURL = downloadTaskDidFinishDownloadingToURL {
        downloadTaskDidFinishDownloadingToURL(session, downloadTask, location)
    } else if let delegate = self[downloadTask]?.delegate as? DownloadTaskDelegate {
        delegate.urlSession(session, downloadTask: downloadTask, didFinishDownloadingTo: location)
    }
}
  • 这是task的一个代理方法,当代理回调时,会先通过 task 找到相应的 Request,然后直接拿出 Request 的属性delegate来处理相关事务,SessionDelegate只是做一个中转的作用,是一个管理者,负责分发任务。从这里也就知道前面为什么要让Requesttask建立一个绑定关系。

总结

调用request发起请求后:

  1. 首先对参数进行编码和拼接。
  2. 通过内部的结构体Requestable创建task
  3. 创建request并保存了DataTaskDelegate
  4. requesttask进行绑定,方便使用。
  5. 执行resume启动任务。

整个流程下来非常的清晰,容易理解,代码阅读性高。SessionDelegate负责所有Session的响应回调,然后把任务分发给DataTaskDelegate去具体实现。实现解耦,业务下沉,提高代码的可以性。

有问题或者建议和意见,欢迎大家评论或者私信。
喜欢的朋友可以点下关注和喜欢,后续会持续更新文章。

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

推荐阅读更多精彩内容