Swift中的HTTP請求體Request Bodies使用示例詳解

更新時間：2023年02月03日 15:20:54 作者：莊周曉夢

這篇文章主要為大家介紹了Swift中的HTTP請求體Request Bodies使用示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪

正文

在進行HTTPRequest請求發(fā)送前，我們稍稍改進一下我們的結(jié)構(gòu)體，最后，我們將會以下面的信息輸出：

public struct HTTPRequest {
    private var urlComponents = URLComponents()
    public var method: HTTPMethod = .get
    public var headers: [String: String] = [:]
    public var body: Data?
}

在本節(jié)中，我們將著重討論一下body屬性，并對其進行改造。

通用化body

在HTTP簡介那一節(jié)，我們了解到，一個請求體是原始二進制數(shù)據(jù)，但是，在與 Web API 通信時，這些數(shù)據(jù)有多種標準格式，例如 JSON 和表單提交。

我們可以將其概括為一種“給我們數(shù)據(jù)的東西”的形式，而不是要求此代碼的客戶手動構(gòu)造其提交數(shù)據(jù)的二進制表示。

由于我們不打算對用于構(gòu)造數(shù)據(jù)的算法施加任何限制，因此通過協(xié)議而不是具體類型來定義此功能是有意義的：

public protocol HTTPBody { }

接下來，我們需要一種方法從其中一個值中獲取Data，并在出現(xiàn)問題時選擇性地報告錯誤：

public protocol HTTPBody { 
    func encode() throws -> Data 
}

我們可以在這一點上停下來，但還有另外兩條信息值得擁有：

public protocol HTTPBody { 
    var isEmpty: Bool { get }
    var additionalHeaders: [String: String] { get } 
    func encode() throws -> Data 
}

如果我們能快速知道一個body是空的，那么我們就可以省去嘗試檢索任何編碼數(shù)據(jù)和處理錯誤或空數(shù)據(jù)值的麻煩。

此外，某些類型的正文與請求中的header結(jié)合使用。例如，當我們將值編碼為 JSON 時，我們希望有一種方法可以自動指定 Content-Type: application/json 的header，而無需在請求中手動指定它。為此，我們將允許這些類型聲明額外的header，這些標頭將作為最終請求的一部分結(jié)束。為了進一步簡化采用，我們可以為這些提供默認實現(xiàn)：

extension HTTPBody {
    public var isEmpty: Bool { return false }
    public var additionalHeaders: [String: String] { return [:] }
}

最后，我們可以將我們的類型更新到這個新的協(xié)議中

public struct HTTPRequest {
    private var urlComponents = URLComponents()
    public var method: HTTPMethod = .get
    public var headers: [String: String] = [:]
    public var body: HTTPBody?
}

空請求體 EmptyBody

最簡單的HTTPBody是”無體“。有了這個協(xié)議，定義一個空請求體也是很方便的。

public struct EmptyBody: HTTPBody {
    public let isEmpty = true
    public init() { }
    public func encode() throws -> Data { Data() }
}

我們甚至可以將其設置為默認的主體值，從而完全消除對該屬性的可選性的需要：

public struct HTTPRequest {
    private var urlComponents = URLComponents()
    public var method: HTTPMethod = .get
    public var headers: [String: String] = [:]
    public var body: HTTPBody = EmptyBody()
}

數(shù)據(jù)體 DataBody

下一個明顯要實現(xiàn)的主體類型是返回給定的任何Data值的主體。這將用于我們不一定有 HTTPBody 實現(xiàn)但也許我們已經(jīng)有Data值本身要發(fā)送的情況。

具體實現(xiàn)如下：

public struct DataBody: HTTPBody {    
    private let data: Data
    public var isEmpty: Bool { data.isEmpty }
    public var additionalHeaders: [String: String]
    public init(_ data: Data, additionalHeaders: [String: String] = [:]) {
        self.data = data
        self.additionalHeaders = additionalHeaders
    }
    public func encode() throws -> Data { data }    
}

有了這個，我們可以很輕松的將一個Data值封裝進HTTPBody里:

let otherData: Data = ...
var request = HTTPRequest()
request.body = DataBody(otherData)

JSON體 JSONBody

在發(fā)送網(wǎng)絡請求時，將值編碼為 JSON 是一項非常常見的任務。制作一個 HTTPBody 來為我們處理這個現(xiàn)在很容易：

public struct JSONBody: HTTPBody {
    public let isEmpty: Bool = false
    public var additionalHeaders = [
        "Content-Type": "application/json; charset=utf-8"
    ]
    private let encode: () throws -> Data
    public init<T: Encodable>(_ value: T, encoder: JSONEncoder = JSONEncoder()) {
        self.encode = { try encoder.encode(value) }
    }
    public func encode() throws -> Data { return try encode() }
}

首先，我們假設我們得到的任何值都會至少產(chǎn)生一些結(jié)果，因為即使是空字符串也會編碼為非空 JSON 值。因此，isEmpty = false。

接下來，大多數(shù)服務器在接收 JSON 正文時需要 application/json 的 Content-Type，因此我們假設這是常見情況，并在 additionalHeaders 中默認該值。但是，我們會將該屬性保留為 var，以防萬一出現(xiàn)客戶不希望這樣的情況。

對于編碼，我們需要接受一些通用值（要編碼的東西），但最好不要讓整個結(jié)構(gòu)對編碼類型通用。我們可以通過將類型的泛型參數(shù)限制為初始化器來避免類型的泛型參數(shù)，然后在閉包中捕獲泛型值。

我們還需要一種方法來提供自定義 JSONEncoder，以便客戶有機會擺弄諸如 .keyEncodingStrategy 之類的東西。但是，我們將提供一個默認編碼器來簡化使用。

最后，encode() 方法本身只是調(diào)用我們創(chuàng)建的閉包，它捕獲通用值并通過 JSONEncoder 執(zhí)行它。

其中一個的使用方法如下：

struct PagingParameters: Encodable {
    let page: Int
    let number: Int
}
let parameters = PagingParameters(page: 0, number: 10)
var request = HTTPRequest()
request.body = JSONBody(parameters)

這樣，正文將自動編碼為 {"page":0,"number":10}，我們的最終請求將具有正確的 Content-Type 標頭。

表單 FormBody

我們將在本文中看到的最后一種主體是表示基本表單提交的body。當我們專門討論多部分表單上傳時，我們將保存文件上傳以備將來使用。

表單提交正文最終為粗略的 URL 編碼鍵值對，例如 name=Arthur&age=42。

我們將從與我們的 HTTPBody 實現(xiàn)相同的基本結(jié)構(gòu)開始：

public struct FormBody: HTTPBody {
    public var isEmpty: Bool { values.isEmpty }
    public let additionalHeaders = [
        "Content-Type": "application/x-www-form-urlencoded; charset=utf-8"
    ]
    private let values: [URLQueryItem]
    public init(_ values: [URLQueryItem]) {
        self.values = values
    }
    public init(_ values: [String: String]) {
        let queryItems = values.map { URLQueryItem(name: $0.key, value: $0.value) }
        self.init(queryItems)
    }
    public func encode() throws -> Data {
        let pieces = values.map { /* TODO */ }
        let bodyString = pieces.joined(separator: "&")
        return Data(bodyString.utf8)
    }
}

和以前一樣，我們有一個自定義的 Content-Type 標頭來應用于請求。我們還公開了幾個初始化器，以便客戶端可以以對他們有意義的方式描述這些值。我們還刪除了大部分 encode() 方法，省略了 URLQueryItem 值的實際編碼。

不幸的是，對名稱和值進行編碼有點模棱兩可。如果你仔細閱讀關(guān)于表單提交的古老規(guī)范，你會看到提到“換行規(guī)范化”和將空格編碼為 + 的內(nèi)容。我們可以努力挖掘并找出這些東西的含義，但在實踐中，Web 服務器往往可以很好地處理任何百分比編碼的內(nèi)容，甚至是空格。我們將走捷徑并假設這是真的。我們還將全面假設字母數(shù)字字符在名稱和值中是可以的，并且其他所有內(nèi)容都應該被編碼：

private func urlEncode(_ string: String) -> String {
    let allowedCharacters = CharacterSet.alphanumerics
    return string.addingPercentEncoding(withAllowedCharacters: allowedCharacters) ?? ""
}

使用 = 字符組合名稱和值：

private func urlEncode(_ queryItem: URLQueryItem) -> String {
    let name = urlEncode(queryItem.name)
    let value = urlEncode(queryItem.value ?? "")
    return "(name)=(value)"
}

有了這個，我們可以解決 /* TODO */ 評論：

public struct FormBody: HTTPBody {
    public var isEmpty: Bool { values.isEmpty }
    public let additionalHeaders = [
        "Content-Type": "application/x-www-form-urlencoded; charset=utf-8"
    ]
    private let values: [URLQueryItem]
    public init(_ values: [URLQueryItem]) {
        self.values = values
    }
    public init(_ values: [String: String]) {
        let queryItems = values.map { URLQueryItem(name: $0.key, value: $0.value) }
        self.init(queryItems)
    }
    public func encode() throws -> Data {
        let pieces = values.map(self.urlEncode)
        let bodyString = pieces.joined(separator: "&")
        return Data(bodyString.utf8)
    }
    private func urlEncode(_ queryItem: URLQueryItem) -> String {
        let name = urlEncode(queryItem.name)
        let value = urlEncode(queryItem.value ?? "")
        return "(name)=(value)"
    }
    private func urlEncode(_ string: String) -> String {
        let allowedCharacters = CharacterSet.alphanumerics
        return string.addingPercentEncoding(withAllowedCharacters: allowedCharacters) ?? ""
    }
}

和以前一樣，使用它變得很簡單：

var request = HTTPRequest()
request.body = FormBody(["greeting": "Hello, ", "target": "??"])
// the body is encoded as:
// greeting=Hello%2C%20&target=%F0%9F%8C%8E