Alamofire-Request

request.png

一、簡(jiǎn)述

在Alamofire中為了方便管理，明確分工，Alamofire對(duì)整個(gè)請(qǐng)求過(guò)程做了明確劃分，并統(tǒng)一交由SessionManager來(lái)管理。SessionManager負(fù)責(zé)SessionDelegate、URLSession、URLRequest等對(duì)象創(chuàng)建與管理。先看一段請(qǐng)求示例：

let urlStr = "http://onapp.yahibo.top/public/?s=api/test/list"
let url = URL.init(string: urlStr)!
Alamofire.request(url,method: .post,parameters: ["page":"1","size":"20"]).responseJSON {
    (response) in
    switch response.result{
    case .success(let json):
        print("json:\(json)")
        break
    case .failure(let error):
        print("error:\(error)")
        break
    }
}

這里的request相當(dāng)于Alamofire的一個(gè)請(qǐng)求api，內(nèi)部實(shí)現(xiàn)了所有需要的請(qǐng)求配置，此外也封裝了download、upload、stream等請(qǐng)求api供用戶直接使用。一般請(qǐng)求流程為url -> request -> task -> response，一般url為String類型的資源鏈接，request才是我們請(qǐng)求的重中之重。在Alamofire中對(duì)請(qǐng)求流程都做了任務(wù)細(xì)分，下面以request作為主線向下探索，看看框架是如何細(xì)分的。

二、URLRequest常規(guī)配置

下面看一下常規(guī)配置：

let url = URL.init(string: "1?協(xié)議://2?主機(jī)地址/3?路徑/4?參數(shù)1&參數(shù)2")!
var request  = URLRequest.init(url: url)
request.httpMethod = HTTPMethod.post.rawValue
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
let postData = ["username":"hibo","password":"123456"]
request.httpBody = try?JSONSerialization.data(withJSONObject: postData, options: [])
request.timeoutInterval = 30
request.cachePolicy = .useProtocolCachePolicy

需要一系列參數(shù)配置，可能根據(jù)不同需要要做更多的配置，項(xiàng)目中幾乎每個(gè)頁(yè)面都需要網(wǎng)絡(luò)請(qǐng)求，對(duì)于以上的代碼量，肯定是要做封裝處理，提取通用代碼復(fù)用，開(kāi)放配置參數(shù)，供特殊需求使用。

三、對(duì)URLRequest的封裝

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)
    }
}
  • url：請(qǐng)求資源連接
  • method：HTTPMethod枚舉類型參數(shù)，設(shè)置請(qǐng)求類型默認(rèn)get類型
  • Parameters：請(qǐng)求參數(shù)，字典類型，默認(rèn)為nil
  • encoding：支持編碼格式，有三種類型：URLEncoding、JSONEncoding、PropertyListEncoding默認(rèn)URLEncoding
  • headers：請(qǐng)求頭參數(shù)設(shè)置默認(rèn)為空

以上為對(duì)外引出常規(guī)參數(shù)，用戶根據(jù)需求設(shè)置，內(nèi)部有默認(rèn)值，用戶不設(shè)置則啟用默認(rèn)值（通用屬性值）。以上幾個(gè)參數(shù)即是URLRequest的屬性，請(qǐng)求中的主要屬性。

四、參數(shù)處理

在開(kāi)發(fā)中，我們常常使用GET請(qǐng)求或POST請(qǐng)求。GET請(qǐng)求，請(qǐng)求參數(shù)是拼接在地址上的&或/符合分隔，常用于獲取數(shù)據(jù)；POST請(qǐng)求將參數(shù)封裝在請(qǐng)求體中，常用數(shù)據(jù)提交。

下面看一下框架是如何處理這些參數(shù)的：

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
}
  • 沒(méi)有參數(shù)直接返回URLRequest對(duì)象
  • 有參數(shù)則需要對(duì)分別處理參數(shù)，GET需要拼接，POST需要添加添加至httpBody請(qǐng)求體中
  • percentEncodedQuery獲取域名后的參數(shù)并與請(qǐng)求參數(shù)拼接

query函數(shù)對(duì)參數(shù)做了拼接處理。如下：

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: "&")
}
  • 傳入一個(gè)字典參數(shù)
  • 對(duì)字典key的ASCII碼進(jìn)行排序，重新組合成一個(gè)元組數(shù)組
  • queryComponents內(nèi)部進(jìn)行遞歸操作，將key和value進(jìn)行百分號(hào)編碼，并放回元組中
  • 通過(guò)map結(jié)合元組元素形成新的數(shù)組，在通過(guò)joined函數(shù)將數(shù)組元素拼接，兩個(gè)元素直接用&符分隔

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
}
  • 遞歸操作，遍歷到數(shù)據(jù)的每一層，直到鍵值對(duì)的值為非字典和數(shù)組類型，開(kāi)始對(duì)key和value做百分號(hào)編碼操作
  • escape為編碼函數(shù)

GET請(qǐng)求

通過(guò)query來(lái)拼接并做百分號(hào)編碼所有的鍵值對(duì)，處理成"username=hibo&password=123456"這種形式，直接拼接至請(qǐng)求域名上，request.url為域名，上面通過(guò)urlComponents.percentEncodedQuery已經(jīng)拆分出來(lái)了資源路徑因此，拼接的連接為：host+資源路徑（s=api/test/list/）+&+參數(shù)

POST請(qǐng)求

在沒(méi)有Content-Type配置的情況下給默認(rèn)配置。如下：

urlRequest.setValue("application/x-www-form-urlencoded; charset=utf-8", forHTTPHeaderField: "Content-Type")

把query拼接后的參數(shù)轉(zhuǎn)換為Data類型數(shù)據(jù)，傳給請(qǐng)求體httpBody。至此GET或其他請(qǐng)求的參數(shù)就已經(jīng)設(shè)置完畢。URLRequest設(shè)置完成后，就可以創(chuàng)建任務(wù)發(fā)送請(qǐng)求了。下面看一下框架怎么處理。

五、發(fā)送請(qǐng)求

順著代碼找到另一個(gè)request方法：

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)
    }
}

這里只做了三步處理：

  1. 在這個(gè)方法中并沒(méi)有發(fā)起請(qǐng)求，而是將發(fā)起任務(wù)的session和request，交給了DataRequest，對(duì)任務(wù)分層，manager說(shuō)我這只管維持你們需要的參數(shù)，具體任務(wù)自己帶回家去做，分工明確，思路更清晰。

  2. 綁定綁定返回task和request，以便SessionDelegate做任務(wù)下發(fā)，在SessionDelegate中通過(guò)task獲取taskDelegate對(duì)象

  3. 有manager管理任務(wù)的啟動(dòng)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() }
}
  • 通過(guò)枚舉來(lái)配置不同的任務(wù)代理

TaskDelegate

分多個(gè)子類，具有不同職能。子類如下：

DataTaskDelegate
DownloadTaskDelegate
UploadTaskDelegate

根據(jù)不同任務(wù)類型，由Request類確定不同的處理類，stream類的任務(wù)有基類處理。該類中都對(duì)外聲明了相應(yīng)代理事件的閉包，以便對(duì)外傳遞代理消息。如下：

var progressHandler: (closure: Request.ProgressHandler, queue: DispatchQueue)?
var uploadProgressHandler: (closure: Request.ProgressHandler, queue: DispatchQueue)?

該閉包都是在Request類中或者拓展方法中實(shí)現(xiàn)的，實(shí)際不是實(shí)現(xiàn)只是橋接到界面中實(shí)現(xiàn)，從而代理事件傳遞直接傳到界面閉包。

總結(jié)

1、SessionManager

  • httpAdditionalHeaders參數(shù)配置
  • 創(chuàng)建URLRequest
  • 創(chuàng)建URLSession
  • URLSessionDelegate代理移交給SessionDelegate
  • 發(fā)起任務(wù)請(qǐng)求

2、SessionDelegate

  • 實(shí)現(xiàn)所有網(wǎng)絡(luò)請(qǐng)求的代理方法，并對(duì)外聲明閉包，通過(guò)閉包向外傳遞代理響應(yīng)事件
  • 如果外部沒(méi)有實(shí)現(xiàn)接收代理事件的閉包，會(huì)將代理事件通過(guò)task標(biāo)識(shí)移交給TaskDelegate中具體的子類來(lái)處理

3、Request

  • 負(fù)責(zé)任務(wù)的創(chuàng)建，保留URLSession對(duì)象即URLRequest對(duì)象
  • 負(fù)責(zé)任務(wù)下發(fā)，下發(fā)至TaskDelegate中
  • 實(shí)現(xiàn)數(shù)據(jù)傳遞方法，對(duì)外設(shè)置閉包參數(shù)，內(nèi)部將閉包橋接至TaskDelegate中，即實(shí)現(xiàn)TaskDelegate中對(duì)外聲明的閉包
  • 方法返回self實(shí)現(xiàn)鏈?zhǔn)秸{(diào)用

4、TaskDelegate

  • 創(chuàng)建子類，負(fù)責(zé)具體任務(wù)實(shí)現(xiàn)
  • 對(duì)外聲明閉包向外傳遞代理消息
  • 改類對(duì)象在Request中使用
最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

友情鏈接更多精彩內(nèi)容