LCToolKit 1.1.0

LCToolKit 1.1.0

×

测试经过测试的✗
语语言 SwiftSwift
许可 MIT
发布最后发布2017年10月
SwiftSwift 版本4.0
SPM支持 SPM✗

由 LazyCat 维护。

 
依赖
Alamofire~> 4.5.1
FMDB~> 2.7.2
 

LCToolKit 1.1.0

  • 由
  • LazyCat






Alamofire 是一个用 Swift 编写的 HTTP 网络库。

特性

  • 链式请求/响应方法
  • URL/JSON/plist 参数编码
  • 上传文件/数据/流/MultipartFormData
  • 使用请求或恢复数据下载文件
  • 使用 URLCredential 进行认证
  • HTTP 响应验证
  • 使用进度闭包的上传和下载进度
  • cURL 命令输出
  • 动态调整并重试请求
  • TLS 证书和公钥固定
  • 网络可达性
  • 详尽的单元和集成测试覆盖率
  • 完整的文档

组件库

为了使 Alamofire 专注于核心网络实现，Alamofire 软件基金会创建了额外的组件库，以增加 Alamofire 生态系统的功能性。

  • AlamofireImage - 包含图像响应序列化器、UIImage 和 UIImageView 扩展、自定义图像过滤器、自动清理内存缓存以及基于优先级的图像下载系统的图像库。
  • AlamofireNetworkActivityIndicator - 使用 Alamofire 控制iOS上网络活动指示器的可见性。它包含可配置的延迟计时器，以帮助减少闪烁，并且可以支持不由 Alamofire 管理的 URLSession 实例。

要求

  • iOS 8.0+ / macOS 10.10+ / tvOS 9.0+ / watchOS 2.0+
  • Xcode 8.3+
  • Swift 3.1+

迁移指南

交流

  • 如果您需要帮助，请使用 Stack Overflow。 (标签 'alamofire')
  • 如果您想提一个一般性问题，请使用 Stack Overflow。
  • 如果您找到一个bug，请提交一个问题。
  • 如果您有功能请求，请提交一个问题。
  • 如果您想做出贡献，请提交一个pull请求。

安装

Swift 包管理器

Swift 包管理器 是一个用于自动化分发 Swift 代码的工具，它集成到了 swift 编译器中。它处于早期开发阶段，但Alamofire支持在支持的平台上使用它。

一旦您的 Swift 包设置好了，将 Alamofire 作为依赖项添加，就像将其添加到您的 Package.swift 文件的 dependencies 价值中一样简单。

dependencies: [
    .Package(url: "https://github.com/Alamofire/Alamofire.git", majorVersion: 4)
]

手工方式

如果您不想使用上述任何依赖项管理器，您可以将Alamofire手动集成到您的项目中。

嵌入式框架

  • 打开终端，使用 cd 进入您的顶级项目目录，并运行以下命令（如果您的项目尚未作为git仓库初始化）

    $ git init

  • 使用以下命令通过运行以下命令将 Alamofire 添加为git 子模块

    $ git submodule add https://github.com/Alamofire/Alamofire.git

  • 打开新的 Alamofire 文件夹，并将 Alamofire.xcodeproj 拖入您应用程序的Xcode项目的“项目导航器”中。

    它应该嵌套在您应用程序的蓝色项目图标下。它是否在上面或下面所有其他Xcode组中并不重要。

  • 在项目导航器中选择 Alamofire.xcodeproj，并验证其部署目标是否与您的应用程序目标相同。

  • 接下来，在项目导航器中选择您的应用程序项目（蓝色项目图标），进入目标配置窗口，在侧边栏的“Targets”标题下选择应用程序目标。

  • 在该窗口顶部的标签栏中，打开“通用”面板。

  • 在“嵌入式二进制文件”部分下点击 + 按钮。

  • 您将看到两个不同的 Alamofire.xcodeproj 文件夹，每个文件夹中都包含两个不同的 Alamofire.framework 版本，这些版本嵌套在 Products 文件夹中。

    您可以选择哪个 Products 文件夹不重要，但您选择顶部的还是底部的 Alamofire.framework 则很重要。

  • 对于iOS，选择顶部的 Alamofire.framework；对于OS X，选择底部的那个。

    您可以通过检查项目的构建日志来验证您选择了哪个。Alamofire 的构建目标将列出于 Alamofire iOS、Alamofire macOS、Alamofire tvOS 或 Alamofire watchOS。

  • 就是这样！

    Alamofire.framework 将自动添加为目标依赖项、链接框架和嵌入式框架，在复制文件构建阶段中，这是您在模拟器和设备上构建所需的全部。

使用

发起请求

import Alamofire

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

响应处理

处理使用 Alamofire 制作的 Request 的 Response 包括将响应处理程序链接到 Request。

Alamofire.request("https://httpbin.org/get").responseJSON { response in
    print("Request: \(String(describing: response.request))")   // original url request
    print("Response: \(String(describing: response.response))") // http url response
    print("Result: \(response.result)")                         // response serialization result

    if let json = response.result.value {
        print("JSON: \(json)") // serialized json response
    }

    if let data = response.data, let utf8Text = String(data: data, encoding: .utf8) {
        print("Data: \(utf8Text)") // original server data as UTF8 string
    }
}

在上面的示例中，将 responseJSON 处理程序附加到要执行的 Request 上，一旦 Request 完成，就会执行它。不需要阻塞执行以等待服务器响应，而是一次指定了回调形式的闭包来处理收到响应。请求的结果仅在响应闭包的作用域内可用。所有基于响应或服务器收到的数据执行的任何操作都必须在响应闭包内完成。

Alamofire 中的网络请求是以异步方式执行的。异步编程可能让对这一概念不熟悉的程序员感到沮丧，但这样做的确有很好的原因。

Alamofire 默认包含五种不同的响应处理器，包括：

// Response Handler - Unserialized Response
func response(
    queue: DispatchQueue?,
    completionHandler: @escaping (DefaultDataResponse) -> Void)
    -> Self

// Response Data Handler - Serialized into Data
func responseData(
    queue: DispatchQueue?,
    completionHandler: @escaping (DataResponse<Data>) -> Void)
    -> Self

// Response String Handler - Serialized into String
func responseString(
    queue: DispatchQueue?,
    encoding: String.Encoding?,
    completionHandler: @escaping (DataResponse<String>) -> Void)
    -> Self

// Response JSON Handler - Serialized into Any
func responseJSON(
    queue: DispatchQueue?,
    completionHandler: @escaping (DataResponse<Any>) -> Void)
    -> Self

// Response PropertyList (plist) Handler - Serialized into Any
func responsePropertyList(
    queue: DispatchQueue?,
    completionHandler: @escaping (DataResponse<Any>) -> Void))
    -> Self

默认情况下，没有任何响应处理器对从服务器返回的 HTTPURLResponse 进行任何验证。

例如，状态码在 400..<500 和 500..<600 范围内的响应不会自动触发 Error。Alamofire 使用响应验证链式调用来实现这一点。

响应处理器

response 处理器不会评估任何响应数据。它只是将来自 URL 会话代理的所有信息直接传递。它是 Alamofire 中使用 cURL 执行 Request 的等同。

Alamofire.request("https://httpbin.org/get").response { response in
    print("Request: \(response.request)")
    print("Response: \(response.response)")
    print("Error: \(response.error)")

    if let data = response.data, let utf8Text = String(data: data, encoding: .utf8) {
    	print("Data: \(utf8Text)")
    }
}

我们强烈建议您利用其他响应序列化器，这些序列化器利用了 Response 和 Result 类型。

响应数据处理器

的 responseData 处理器使用 responseDataSerializer（对象将服务器数据序列化为其他类型）提取服务器返回的 Data。如果没有发生错误并且返回了 Data，则响应 Result 将是 .success，而 value 将是 Data 类型。

Alamofire.request("https://httpbin.org/get").responseData { response in
    debugPrint("All Response Info: \(response)")

    if let data = response.result.value, let utf8Text = String(data: data, encoding: .utf8) {
    	print("Data: \(utf8Text)")
    }
}

响应字符串处理器

responseString 处理器使用 responseStringSerializer 将服务器返回的 Data 转换为指定编码的 String。如果没有发生错误并且服务器数据成功序列化为 String，则响应 Result 将是 .success，并且 value 将是 String 类型。

Alamofire.request("https://httpbin.org/get").responseString { response in
    print("Success: \(response.result.isSuccess)")
    print("Response String: \(response.result.value)")
}

如果没有指定编码，Alamofire 将使用服务器 HTTPURLResponse 中指定的文本编码。如果无法通过服务器响应确定文本编码，则默认为 .isoLatin1。

响应 JSON 处理器

responseJSON 处理器使用 responseJSONSerializer 使用指定的 JSONSerialization.ReadingOptions 将服务器返回的 Data 转换为 Any 类型。如果没有发生错误并且服务器数据成功序列化为 JSON 对象，则响应 Result 将是 .success，并且 value 将是 Any 类型。

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

    if let json = response.result.value {
        print("JSON: \(json)")
    }
}

所有 JSON 序列化都由 Foundation 框架中的 JSONSerialization API 处理。

链式响应处理器

响应处理器甚至可以链式使用

Alamofire.request("https://httpbin.org/get")
    .responseString { response in
        print("Response String: \(response.result.value)")
    }
    .responseJSON { response in
        print("Response JSON: \(response.result.value)")
    }

需要注意的是，在同一个 Request 上使用多个响应处理器需要将服务器数据序列化多次。每次响应处理器处理一次。

响应处理器队列

默认情况下，响应处理器在主发送队列上执行。但是，可以提供自定义发送队列。

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

Alamofire.request("https://httpbin.org/get").responseJSON(queue: utilityQueue) { response in
    print("Executing response handler on utility queue")
}

响应验证

默认情况下，Alamofire 将完成的任何请求视为成功，无论响应内容如何。在响应处理器之前调用 validate 将生成错误，如果响应包含无法接受的状态码或 MIME 类型。

手动验证

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

自动验证

自动验证状态码在 200..<300 范围内，并且响应的 Content-Type 响应头与请求的 Accept 响应头匹配（如果提供的话）。

Alamofire.request("https://httpbin.org/get").validate().responseJSON { response in
    switch response.result {
    case .success:
        print("Validation Successful")
    case .failure(let error):
        print(error)
    }
}

响应缓存

响应缓存由系统框架级别的 URLCache 处理。它提供了一个组合的内存和磁盘缓存，并允许您调整内存和磁盘部分的大小。

默认情况下，Alamofire 利用共享的 URLCache。要自定义它，请参阅 会话管理器配置 部分。

HTTP 方法

HTTPMethod 枚举列出了在 RFC 7231 §4.3 中的定义的 HTTP 方法。

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

这些值可以作为 method 参数传递给 Alamofire.request API。

Alamofire.request("https://httpbin.org/get") // method defaults to `.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)

Alamofire.request 方法参数默认为 .get。

参数编码

Alamofire 支持三种类型的参数编码，包括：URL、JSON 和 PropertyList。它还可以支持任何符合 ParameterEncoding 协议的自定义编码。

URL 编码

名为 URLEncoding 的类型会创建一个 url 编码后的查询字符串，该字符串将被设置为或追加到任何现有的 URL 查询字符串或设置为 URL 请求的 HTTP 主体。查询字符串是设置为或追加到现有 URL 查询字符串或设置为 HTTP 主体取决于编码的 Destination。编码的 Destination 枚举有三个情况

  • .methodDependent - 对于 GET、HEAD 和 DELETE 请求将编码后的查询字符串应用于现有的查询字符串，并对于任何其他 HTTP 请求将其设置为 HTTP 主体。
  • .queryString - 设置或追加编码后的查询字符串到现有查询字符串。
  • .httpBody - 将编码后的查询字符串设置为 URL 请求的 HTTP 主体。

带有 HTTP 主体编码请求的请求的 Content-Type HTTP 头字段设置为 application/x-www-form-urlencoded; charset=utf-8。由于尚未公布有关如何编码集合类型的规范，因此习惯于在数组值（如 foo[]=1&foo[]=2）的键上附加 []，并且对于嵌套字典值（如 foo[bar]=baz）将其键用方括号包围。

带有 URL 编码参数的 GET 请求
let parameters: Parameters = ["foo": "bar"]

// All three of these calls are equivalent
Alamofire.request("https://httpbin.org/get", parameters: parameters) // encoding defaults to `URLEncoding.default`
Alamofire.request("https://httpbin.org/get", parameters: parameters, encoding: URLEncoding.default)
Alamofire.request("https://httpbin.org/get", parameters: parameters, encoding: URLEncoding(destination: .methodDependent))

// https://httpbin.org/get?foo=bar
带有 URL 编码参数的 POST 请求
let parameters: Parameters = [
    "foo": "bar",
    "baz": ["a", 1],
    "qux": [
        "x": 1,
        "y": 2,
        "z": 3
    ]
]

// All three of these calls are equivalent
Alamofire.request("https://httpbin.org/post", method: .post, parameters: parameters)
Alamofire.request("https://httpbin.org/post", method: .post, parameters: parameters, encoding: URLEncoding.default)
Alamofire.request("https://httpbin.org/post", method: .post, parameters: parameters, encoding: URLEncoding.httpBody)

// HTTP body: foo=bar&baz[]=a&baz[]=1&qux[x]=1&qux[y]=2&qux[z]=3

JSON 编码

名为 JSONEncoding 的类型会创建参数对象的 JSON 表示形式，并将其设置为请求的 HTTP 主体。编码请求的 Content-Type HTTP 头字段设置为 application/json。

带有 JSON 编码参数的 POST 请求
let parameters: Parameters = [
    "foo": [1,2,3],
    "bar": [
        "baz": "qux"
    ]
]

// Both calls are equivalent
Alamofire.request("https://httpbin.org/post", method: .post, parameters: parameters, encoding: JSONEncoding.default)
Alamofire.request("https://httpbin.org/post", method: .post, parameters: parameters, encoding: JSONEncoding(options: []))

// HTTP body: {"foo": [1, 2, 3], "bar": {"baz": "qux"}}

属性列表编码

PropertyListEncoding 使用 PropertyListSerialization 来根据关联的格式和写入选项值创建参数对象的 plist 表示形式，并将其设置为请求的主体。编码请求的 Content-Type HTTP 头字段设置为 application/x-plist。

自定义编码

如果提供的 ParameterEncoding 类型不满足您的需求，您可以创建自己的自定义编码。以下是一个快速示例，说明您可以如何构建一个自定义的 JSONStringArrayEncoding 类型以将 JSON 字符串数组编码到一个 Request 之上。

struct JSONStringArrayEncoding: ParameterEncoding {
	private let array: [String]

    init(array: [String]) {
        self.array = array
    }

    func encode(_ urlRequest: URLRequestConvertible, with parameters: Parameters?) throws -> URLRequest {
        var urlRequest = try urlRequest.asURLRequest()

        let data = try JSONSerialization.data(withJSONObject: array, options: [])

        if urlRequest.value(forHTTPHeaderField: "Content-Type") == nil {
            urlRequest.setValue("application/json", forHTTPHeaderField: "Content-Type")
        }

        urlRequest.httpBody = data

        return urlRequest
    }
}

手动对 URLRequest 进行参数编码

可以将在制作网络请求之外使用 ParameterEncoding API。

let url = URL(string: "https://httpbin.org/get")!
var urlRequest = URLRequest(url: url)

let parameters: Parameters = ["foo": "bar"]
let encodedURLRequest = try URLEncoding.queryString.encode(urlRequest, with: parameters)

HTTP 头

支持直接在全局 request 方法中添加自定义 HTTP 头到 Request 中，这使得将常发生变化的 HTTP 头附加到 Request 上变得简单。

let headers: HTTPHeaders = [
    "Authorization": "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==",
    "Accept": "application/json"
]

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

对于不改变的 HTTP 头，建议在 URLSessionConfiguration 上设置它们，这样它们就自动应用于底层 URLSession 创建的任何 URLSessionTask。有关更多信息，请参阅会话管理器配置部分。

默认的 Alamofire SessionManager 为每个 Request 提供一组默认的头部。这包括

  • Accept-Encoding，默认为 gzip;q=1.0, compress;q=0.5，根据 RFC 7230 §4.2.3。
  • Accept-Language，默认为系统上最高 6 个首选语言，格式如下 en;q=1.0，根据 RFC 7231 §5.3.5。
  • User-Agent，其中包含有关当前应用程序的版本信息。例如：iOS Example/1.0 (com.alamofire.iOS-Example; build:1; iOS 10.0.0) Alamofire/4.0.0，根据 RFC 7231 §5.5.3。

如果您需要自定义这些头部信息，应创建一个自定义的 URLSessionConfiguration，更新 defaultHTTPHeaders 属性，并将配置应用于新的 SessionManager 实例。

认证

认证由系统框架级别的 URLCredential 和 URLAuthenticationChallenge 处理。

支持的认证方案

HTTP Basic 认证

在 Request 上的 authenticate 方法在适当的情况下会自动为 URLAuthenticationChallenge 提供一个 URLCredential

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

取决于您的服务器实现，可能还需要使用 Authorization 头部信息

let user = "user"
let password = "password"

var headers: HTTPHeaders = [:]

if let authorizationHeader = Request.authorizationHeader(user: user, password: password) {
    headers[authorizationHeader.key] = authorizationHeader.value
}

Alamofire.request("https://httpbin.org/basic-auth/user/password", headers: headers)
    .responseJSON { response in
        debugPrint(response)
    }

使用 URLCredential 进行认证

let user = "user"
let password = "password"

let credential = URLCredential(user: user, password: password, persistence: .forSession)

Alamofire.request("https://httpbin.org/basic-auth/\(user)/\(password)")
    .authenticate(usingCredential: credential)
    .responseJSON { response in
        debugPrint(response)
    }

请注意，当使用 URLCredential 进行认证时，如果服务器提供了挑战，底层 URLSession 实际上会发送两个请求。第一个请求不会包括凭证，这可能会触发服务器的挑战。然后挑战被 Alamofire 接收，凭证被添加，并通过底层 URLSession 重试请求。

将数据下载到文件

Alamofire 请求在从服务器获取数据时可以下载数据到内存或磁盘。到目前为止所有示例中都使用的是 Alamofire.request API，总是将服务器数据下载到内存中。对于较小的数据负载，这样做很高效，但对于较大的数据负载，由于下载可能耗尽整个应用程序的内存，因此非常糟糕。鉴于此，您也可以使用 Alamofire.download API 将服务器数据下载到磁盘上的临时文件中。

现在这只在 macOS 上有效。其他平台不允许在应用程序沙盒之外访问文件系统。有关在其他平台下载文件的说明，请参阅 下载文件目标 部分。

Alamofire.download("https://httpbin.org/image/png").responseData { response in
    if let data = response.result.value {
        let image = UIImage(data: data)
    }
}

如果您的应用程序在后台运行时需要下载数据，也应使用 Alamofire.download API。有关更多信息，请参阅 会话管理器配置 部分。

下载文件目标

您还可以提供一个 DownloadFileDestination 闭包将文件从临时目录移动到最终位置。在将临时文件实际移动到 destinationURL 之前，将执行闭包中指定的 DownloadOptions。目前支持的两个 DownloadOptions 是

  • .createIntermediateDirectories - 如果指定，为目的地 URL 创建中间目录。
  • .removePreviousFile - 如果指定，从目的地 URL 删除之前存在的文件。
let destination: DownloadRequest.DownloadFileDestination = { _, _ in
    let documentsURL = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask)[0]
    let fileURL = documentsURL.appendingPathComponent("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)
    }
}

您还可以使用建议的下载位置 API。

let destination = DownloadRequest.suggestedDownloadDestination(for: .documentDirectory)
Alamofire.download("https://httpbin.org/image/png", to: destination)

下载进度

很多时候，向用户报告下载进度是有帮助的。任何 DownloadRequest 都可以使用 downloadProgress API 报告下载进度。

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

downloadProgress API 还接受一个 queue 参数，该参数定义了下载进度闭包应该在哪个 DispatchQueue 上调用。

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

恢复下载

如果 DownloadRequest 被取消或中断，底层 URL 会话可能为活动 DownloadRequest 生成恢复数据。如果发生这种情况，恢复数据可以重新使用来从上次结束的地方重新启动 DownloadRequest。恢复数据可以通过下载响应访问，然后重新使用以尝试重新启动请求。

重要：在所有苹果平台最新版本（iOS 10、macOS 10.12、tvOS 10、watchOS 3）中，resumeData 在后台 URL 会话配置中存在问题。在 resumeData 生成逻辑中有一个根本的错误，导致数据写入错误，并且始终无法恢复下载。有关有关该错误及其可能的解决方案的更多信息，请参阅 Stack Overflow 上这篇帖子。

class ImageRequestor {
    private var resumeData: Data?
    private var image: UIImage?

    func fetchImage(completion: (UIImage?) -> Void) {
        guard image == nil else { completion(image) ; return }

        let destination: DownloadRequest.DownloadFileDestination = { _, _ in
            let documentsURL = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask)[0]
            let fileURL = documentsURL.appendingPathComponent("pig.png")

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

        let request: DownloadRequest

        if let resumeData = resumeData {
            request = Alamofire.download(resumingWith: resumeData)
        } else {
            request = Alamofire.download("https://httpbin.org/image/png")
        }

        request.responseData { response in
            switch response.result {
            case .success(let data):
                self.image = UIImage(data: data)
            case .failure:
                self.resumeData = response.resumeData
            }
        }
    }
}

将数据上传到服务器

当使用JSON或URL编码参数将相对较小的数据发送到服务器时，通常可以使用Alamofire.request API。如果您需要从文件URL或InputStream发送大量数据，那么您应该使用Alamofire.upload API。

如果您需要在进行后台操作时上传数据，也应该使用Alamofire.upload API。更多关于会话管理器配置的信息，请参阅会话管理器配置部分。

上传数据

let imageData = UIImagePNGRepresentation(image)!

Alamofire.upload(imageData, to: "https://httpbin.org/post").responseJSON { response in
    debugPrint(response)
}

上传一个文件

let fileURL = Bundle.main.url(forResource: "video", withExtension: "mov")

Alamofire.upload(fileURL, to: "https://httpbin.org/post").responseJSON { response in
    debugPrint(response)
}

上传多部分表单数据

Alamofire.upload(
    multipartFormData: { multipartFormData in
        multipartFormData.append(unicornImageURL, withName: "unicorn")
        multipartFormData.append(rainbowImageURL, withName: "rainbow")
    },
    to: "https://httpbin.org/post",
    encodingCompletion: { encodingResult in
    	switch encodingResult {
    	case .success(let upload, _, _):
            upload.responseJSON { response in
                debugPrint(response)
            }
    	case .failure(let encodingError):
    	    print(encodingError)
    	}
    }
)

上传进度

当用户等待上传完成时，有时显示上传进度对用户很有帮助。任何UploadRequest都可以使用uploadProgress和downloadProgress API报告上传进度和响应数据的下载进度。

let fileURL = Bundle.main.url(forResource: "video", withExtension: "mov")

Alamofire.upload(fileURL, to: "https://httpbin.org/post")
    .uploadProgress { progress in // main queue by default
        print("Upload Progress: \(progress.fractionCompleted)")
    }
    .downloadProgress { progress in // main queue by default
        print("Download Progress: \(progress.fractionCompleted)")
    }
    .responseJSON { response in
        debugPrint(response)
    }

统计指标

时间线

Alamofire在整个Request生命周期中收集时间信息，并创建一个Timeline对象，该对象作为响应类型的一个属性公开。

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

以下报告了以下Timeline信息

  • 延迟：0.428秒
  • 请求持续时间：0.428秒
  • 序列化持续时间：0.001秒
  • 总持续时间：0.429秒

URL会话任务指标

在iOS和tvOS 10以及macOS 10.12中，苹果引入了新的URLSessionTaskMetrics API。任务指标封装了有关请求和响应执行的一些出色的统计信息。该API与Timeline非常相似，但它提供了许多Alamofire无法计算更多的统计数据。可以通过任何响应类型访问这些指标。

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

请注意，这些API仅在iOS、tvOS 10和macOS 10.12上可用。因此，根据您的部署目标，您可能需要在可用性检查中使用这些

Alamofire.request("https://httpbin.org/get").responseJSON { response in
    if #available(iOS 10.0, *) {
        print(response.metrics)
    }
}

cURL 命令输出

调试平台问题可能会导致挫败感。幸运的是，Alamofire Request对象符合CustomStringConvertible和CustomDebugStringConvertible协议，以提供一些非常有帮助的调试工具。

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)

输出

$ curl -i \
    -H "User-Agent: Alamofire/4.0.0" \
    -H "Accept-Encoding: gzip;q=1.0, compress;q=0.5" \
    -H "Accept-Language: en;q=1.0,fr;q=0.9,de;q=0.8,zh-Hans;q=0.7,zh-Hant;q=0.6,ja;q=0.5" \
    "https://httpbin.org/get?foo=bar"

高级使用

Alamofire建立在URLSession和Foundation URL加载系统之上。为了充分利用此框架，建议您熟悉底层网络堆栈的概念和能力。

推荐阅读

会话管理器

像Alamofire.request这样的顶层便利方法使用了一个默认的Alamofire.SessionManager实例，该实例配置了默认的URLSessionConfiguration。

因此，以下两个语句是等效的

Alamofire.request("https://httpbin.org/get")
let sessionManager = Alamofire.SessionManager.default
sessionManager.request("https://httpbin.org/get")

应用程序可以创建用于后台和短暂会话的会话管理器，以及新的管理器，这些管理器可以自定义默认会话配置，例如默认头信息（httpAdditionalHeaders）或超时间隔（timeoutIntervalForRequest）。

使用默认配置创建会话管理器

let configuration = URLSessionConfiguration.default
let sessionManager = Alamofire.SessionManager(configuration: configuration)

使用后台配置创建会话管理器

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

使用短暂配置创建会话管理器

let configuration = URLSessionConfiguration.ephemeral
let sessionManager = Alamofire.SessionManager(configuration: configuration)

修改会话配置

var defaultHeaders = Alamofire.SessionManager.defaultHTTPHeaders
defaultHeaders["DNT"] = "1 (Do Not Track Enabled)"

let configuration = URLSessionConfiguration.default
configuration.httpAdditionalHeaders = defaultHeaders

let sessionManager = Alamofire.SessionManager(configuration: configuration)

强烈不建议用于Authorization或Content-Type头。取而代之，请使用顶层Alamofire.request API中的headers参数，以及URLRequestConvertible和ParameterEncoding。

会话代理

默认情况下，Alamofire SessionManager实例创建一个SessionDelegate对象来处理由底层URLSession生成的各种类型的代理回调。每个代理方法实现的实现处理最常见的使用案例，以便于抽象顶层API的复杂性。然而，高级用户可能会因各种原因需要覆盖默认功能。

覆盖闭包

自定义SessionDelegate行为的第一种方法是通过使用重载闭包。每个闭包都为您提供覆盖匹配的SessionDelegate API实现的功能，同时仍然可以使用其他所有API的默认实现。这使得定制委托功能子集变得很容易。以下是一些可用的重载闭包的示例。

/// Overrides default behavior for URLSessionDelegate method `urlSession(_:didReceive:completionHandler:)`.
open var sessionDidReceiveChallenge: ((URLSession, URLAuthenticationChallenge) -> (URLSession.AuthChallengeDisposition, URLCredential?))?

/// Overrides default behavior for URLSessionDelegate method `urlSessionDidFinishEvents(forBackgroundURLSession:)`.
open var sessionDidFinishEventsForBackgroundURLSession: ((URLSession) -> Void)?

/// Overrides default behavior for URLSessionTaskDelegate method `urlSession(_:task:willPerformHTTPRedirection:newRequest:completionHandler:)`.
open var taskWillPerformHTTPRedirection: ((URLSession, URLSessionTask, HTTPURLResponse, URLRequest) -> URLRequest?)?

/// Overrides default behavior for URLSessionDataDelegate method `urlSession(_:dataTask:willCacheResponse:completionHandler:)`.
open var dataTaskWillCacheResponse: ((URLSession, URLSessionDataTask, CachedURLResponse) -> CachedURLResponse?)?

以下是如何使用taskWillPerformHTTPRedirection来避免跳转到任何apple.com域的简短示例。

let sessionManager = Alamofire.SessionManager(configuration: URLSessionConfiguration.default)
let delegate: Alamofire.SessionDelegate = sessionManager.delegate

delegate.taskWillPerformHTTPRedirection = { session, task, response, request in
    var finalRequest = request

    if
        let originalRequest = task.originalRequest,
        let urlString = originalRequest.url?.urlString,
        urlString.contains("apple.com")
    {
        finalRequest = originalRequest
    }

    return finalRequest
}

子类化

覆盖默认的SessionDelegate实现的另一种方法是子类化它。子类化允许您完全自定义API的行为或为API创建代理，同时仍使用默认实现。创建代理允许您记录事件、发送通知、提供预和后钩子实现等。以下是一个快速示例，展示了如何子类化SessionDelegate并在发生重定向时记录消息。

class LoggingSessionDelegate: SessionDelegate {
    override func urlSession(
        _ session: URLSession,
        task: URLSessionTask,
        willPerformHTTPRedirection response: HTTPURLResponse,
        newRequest request: URLRequest,
        completionHandler: @escaping (URLRequest?) -> Void)
    {
        print("URLSession will perform HTTP redirection to request: \(request)")

        super.urlSession(
            session,
            task: task,
            willPerformHTTPRedirection: response,
            newRequest: request,
            completionHandler: completionHandler
        )
    }
}

一般来说，默认实现或重载闭包都应该提供所需的功能。子类化应仅作为最后手段。

重要的是要注意subdelegates在默认实现中被初始化和销毁。在子类化时，请务必注意不要引入内存泄漏。

请求

request、download、upload或stream方法的结果是DataRequest、DownloadRequest、UploadRequest和StreamRequest，它们都从Request继承。所有Request实例都是由拥有会话管理器创建的，并且永远不能直接初始化。

每个子类都有专门的函数，如authenticate、validate、responseJSON和uploadProgress，每个都返回调用实例，以方便方法链式调用。

请求可以被挂起、恢复和取消

  • suspend()：挂起底层任务和调度队列。
  • resume()：恢复底层任务和调度队列。如果拥有管理器未将startRequestsImmediately设置为true，则请求必须调用resume()才能启动。
  • cancel()：取消底层任务，生成一个错误并将其传递给任何注册的响应处理程序。

路由请求

随着应用程序的增长，在构建网络堆栈时采用常见模式是很重要的。该设计的一个重要部分是如何路由您的请求。Alamofire的URLConvertible和URLRequestConvertible协议以及Router设计模式就是为了帮助您实现这一点。

URLConvertible

采用URLConvertible协议的类型可用于构造URL，然后内部使用这些URL来构建URL请求。String、URL和URLComponents默认符合URLConvertible，允许它们中的任何一个作为url参数传递给request、upload和download方法。

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

let url = URL(string: urlString)!
Alamofire.request(url, method: .post)

let urlComponents = URLComponents(url: url, resolvingAgainstBaseURL: true)!
Alamofire.request(urlComponents, method: .post)

与Web应用程序进行重大交互的应用程序应鼓励自定义类型符合URLConvertible，这是一种方便的方式，可以将特定领域的模型映射到服务器资源。

类型安全的路由
extension User: URLConvertible {
    static let baseURLString = "https://example.com"

    func asURL() throws -> URL {
    	let urlString = User.baseURLString + "/users/\(username)/"
        return try urlString.asURL()
    }
}
let user = User(username: "mattt")
Alamofire.request(user) // https://example.com/users/mattt

URLRequestConvertible

采用URLRequestConvertible协议的类型可用于构建URL请求。URLRequest默认符合URLRequestConvertible，可以直接传递给request、upload和download方法（这是指定单个请求的定制HTTP体推荐的途径）。

let url = URL(string: "https://httpbin.org/post")!
var urlRequest = URLRequest(url: url)
urlRequest.httpMethod = "POST"

let parameters = ["foo": "bar"]

do {
    urlRequest.httpBody = try JSONSerialization.data(withJSONObject: parameters, options: [])
} catch {
    // No-op
}

urlRequest.setValue("application/json", forHTTPHeaderField: "Content-Type")

Alamofire.request(urlRequest)

鼓励与Web应用进行显著交互的应用，将自定义类型符合URLRequestConvertible作为确保请求端点一致性的方法。这种方法可以用来抽象服务器端的不一致性，提供类型安全的路由，以及管理认证凭据和其他状态。

API参数抽象
enum Router: URLRequestConvertible {
    case search(query: String, page: Int)

    static let baseURLString = "https://example.com"
    static let perPage = 50

    // MARK: URLRequestConvertible

    func asURLRequest() throws -> URLRequest {
        let result: (path: String, parameters: Parameters) = {
            switch self {
            case let .search(query, page) where page > 0:
                return ("/search", ["q": query, "offset": Router.perPage * page])
            case let .search(query, _):
                return ("/search", ["q": query])
            }
        }()

        let url = try Router.baseURLString.asURL()
        let urlRequest = URLRequest(url: url.appendingPathComponent(result.path))

        return try URLEncoding.default.encode(urlRequest, with: result.parameters)
    }
}
Alamofire.request(Router.search(query: "foo bar", page: 1)) // https://example.com/search?q=foo%20bar&offset=50
CRUD & 授权
import Alamofire

enum Router: URLRequestConvertible {
    case createUser(parameters: Parameters)
    case readUser(username: String)
    case updateUser(username: String, parameters: Parameters)
    case destroyUser(username: String)

    static let baseURLString = "https://example.com"

    var method: HTTPMethod {
        switch self {
        case .createUser:
            return .post
        case .readUser:
            return .get
        case .updateUser:
            return .put
        case .destroyUser:
            return .delete
        }
    }

    var path: String {
        switch self {
        case .createUser:
            return "/users"
        case .readUser(let username):
            return "/users/\(username)"
        case .updateUser(let username, _):
            return "/users/\(username)"
        case .destroyUser(let username):
            return "/users/\(username)"
        }
    }

    // MARK: URLRequestConvertible

    func asURLRequest() throws -> URLRequest {
    	let url = try Router.baseURLString.asURL()

        var urlRequest = URLRequest(url: url.appendingPathComponent(path))
        urlRequest.httpMethod = method.rawValue

        switch self {
        case .createUser(let parameters):
            urlRequest = try URLEncoding.default.encode(urlRequest, with: parameters)
        case .updateUser(_, let parameters):
            urlRequest = try URLEncoding.default.encode(urlRequest, with: parameters)
        default:
            break
        }

        return urlRequest
    }
}
Alamofire.request(Router.readUser("mattt")) // GET https://example.com/users/mattt

请求的适配和重试

如今大多数Web服务都位于某种认证系统之后。其中之一是OAuth。这通常涉及生成一个访问令牌，授权您的应用或用户调用各种受支持的Web服务。虽然创建这些初始访问令牌可能很费力，但令牌过期并需要获取新的令牌时可能更加复杂。这里有许多需要考虑的线程安全问题。

创建用于特定一组Web服务的线程安全认证系统变得更加容易，因此创建了一个RequestAdapter和RequestRetrier协议。

RequestAdapter

RequestAdapter协议允许检查和调整在SessionManager上每个Request在创建之前。使用适配器的一个非常具体的方法是在特定类型的认证之后，向请求中添加一个Authorization头。

class AccessTokenAdapter: RequestAdapter {
    private let accessToken: String

    init(accessToken: String) {
        self.accessToken = accessToken
    }

    func adapt(_ urlRequest: URLRequest) throws -> URLRequest {
        var urlRequest = urlRequest

        if let urlString = urlRequest.url?.absoluteString, urlString.hasPrefix("https://httpbin.org") {
            urlRequest.setValue("Bearer " + accessToken, forHTTPHeaderField: "Authorization")
        }

        return urlRequest
	}
}
let sessionManager = SessionManager()
sessionManager.adapter = AccessTokenAdapter(accessToken: "1234")

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

RequestRetrier

RequestRetrier协议允许在执行过程中遇到Error的Request被重试。当同时使用RequestAdapter和RequestRetrier协议时，可以为OAuth1、OAuth2、基本认证以及指数退避重试策略创建凭证刷新系统。可能性是无穷无尽的。下面是如何实现OAuth2访问令牌刷新流的示例。

免责声明：这不是一个全局的OAuth2解决方案。这仅仅是一个示例，展示了如何结合使用RequestAdapter和RequestRetrier来创建线程安全的刷新系统。

重申一遍，请不要复制此样本代码并将其放入生产应用程序中。这只是一种示例。每种认证系统都必须针对特定的平台和认证类型进行定制。

class OAuth2Handler: RequestAdapter, RequestRetrier {
    private typealias RefreshCompletion = (_ succeeded: Bool, _ accessToken: String?, _ refreshToken: String?) -> Void

    private let sessionManager: SessionManager = {
        let configuration = URLSessionConfiguration.default
        configuration.httpAdditionalHeaders = SessionManager.defaultHTTPHeaders

        return SessionManager(configuration: configuration)
    }()

    private let lock = NSLock()

    private var clientID: String
    private var baseURLString: String
    private var accessToken: String
    private var refreshToken: String

    private var isRefreshing = false
    private var requestsToRetry: [RequestRetryCompletion] = []

    // MARK: - Initialization

    public init(clientID: String, baseURLString: String, accessToken: String, refreshToken: String) {
        self.clientID = clientID
        self.baseURLString = baseURLString
        self.accessToken = accessToken
        self.refreshToken = refreshToken
    }

    // MARK: - RequestAdapter

    func adapt(_ urlRequest: URLRequest) throws -> URLRequest {
        if let urlString = urlRequest.url?.absoluteString, urlString.hasPrefix(baseURLString) {
            var urlRequest = urlRequest
            urlRequest.setValue("Bearer " + accessToken, forHTTPHeaderField: "Authorization")
            return urlRequest
        }

        return urlRequest
    }

    // MARK: - RequestRetrier

    func should(_ manager: SessionManager, retry request: Request, with error: Error, completion: @escaping RequestRetryCompletion) {
        lock.lock() ; defer { lock.unlock() }

        if let response = request.task?.response as? HTTPURLResponse, response.statusCode == 401 {
            requestsToRetry.append(completion)

            if !isRefreshing {
                refreshTokens { [weak self] succeeded, accessToken, refreshToken in
                    guard let strongSelf = self else { return }

                    strongSelf.lock.lock() ; defer { strongSelf.lock.unlock() }

                    if let accessToken = accessToken, let refreshToken = refreshToken {
                        strongSelf.accessToken = accessToken
                        strongSelf.refreshToken = refreshToken
                    }

                    strongSelf.requestsToRetry.forEach { $0(succeeded, 0.0) }
                    strongSelf.requestsToRetry.removeAll()
                }
            }
        } else {
            completion(false, 0.0)
        }
    }

    // MARK: - Private - Refresh Tokens

    private func refreshTokens(completion: @escaping RefreshCompletion) {
        guard !isRefreshing else { return }

        isRefreshing = true

        let urlString = "\(baseURLString)/oauth2/token"

        let parameters: [String: Any] = [
            "access_token": accessToken,
            "refresh_token": refreshToken,
            "client_id": clientID,
            "grant_type": "refresh_token"
        ]

        sessionManager.request(urlString, method: .post, parameters: parameters, encoding: JSONEncoding.default)
            .responseJSON { [weak self] response in
                guard let strongSelf = self else { return }

                if 
                    let json = response.result.value as? [String: Any], 
                    let accessToken = json["access_token"] as? String, 
                    let refreshToken = json["refresh_token"] as? String 
                {
                    completion(true, accessToken, refreshToken)
                } else {
                    completion(false, nil, nil)
                }

                strongSelf.isRefreshing = false
            }
    }
}
let baseURLString = "https://some.domain-behind-oauth2.com"

let oauthHandler = OAuth2Handler(
    clientID: "12345678",
    baseURLString: baseURLString,
    accessToken: "abcd1234",
    refreshToken: "ef56789a"
)

let sessionManager = SessionManager()
sessionManager.adapter = oauthHandler
sessionManager.retrier = oauthHandler

let urlString = "\(baseURLString)/some/endpoint"

sessionManager.request(urlString).validate().responseJSON { response in
    debugPrint(response)
}

将OAuth2Handler应用于作为adapter和retrier的SessionManager，它将通过自动刷新访问令牌并按失败顺序重试所有失败的请求来处理无效访问令牌错误。

如果您需要按创建顺序执行，可以通过任务ID对其进行排序。

上面的示例仅检查401响应代码，这并不十分健壮，但确实展示了如何检查无效访问令牌错误。在生产应用程序中，您希望检查realm和大多数情况下是www-authenticate头响应，尽管这取决于OAuth2的实现。

另一项重要说明是，此认证系统可以在多个会话管理器之间共享。例如，您可能需要为同一组Web服务使用default和ephemeral会话配置。上面的示例允许相同的oauthHandler实例在多个会话管理器之间共享，以管理单个刷新流程。

自定义响应序列化

Alamofire提供内置的数据、字符串、JSON和属性列表响应序列化。

Alamofire.request(...).responseData { (resp: DataResponse<Data>) in ... }
Alamofire.request(...).responseString { (resp: DataResponse<String>) in ... }
Alamofire.request(...).responseJSON { (resp: DataResponse<Any>) in ... }
Alamofire.request(...).responsePropertyList { resp: DataResponse<Any>) in ... }

这些响应包装反序列化值（数据、字符串、任意）或错误（网络错误、验证错误），以及元数据（URL请求、HTTP头、状态代码、指标、...）。

您有几种方法可以自定义所有这些响应元素。

响应映射

响应映射是生成自定义响应的最简单方法。它转换响应的值，同时保留可能发生的错误和元数据。例如，您可以将在一个 DataResponse<Any> 的响应转换为持有应用程序模型（例如 DataResponse<User>）的响应。您可以使用 DataResponse.map 方法执行响应映射。

Alamofire.request("https://example.com/users/mattt").responseJSON { (response: DataResponse<Any>) in
    let userResponse = response.map { json in
        // We assume an existing User(json: Any) initializer
        return User(json: json)
    }

    // Process userResponse, of type DataResponse<User>:
    if let user = userResponse.value {
        print("User: { username: \(user.username), name: \(user.name) }")
    }
}

当转换可能抛出错误时，请使用 flatMap。

Alamofire.request("https://example.com/users/mattt").responseJSON { response in
    let userResponse = response.flatMap { json in
        try User(json: json)
    }
}

响应映射非常适合您自定义的完成处理器。

@discardableResult
func loadUser(completionHandler: @escaping (DataResponse<User>) -> Void) -> Alamofire.DataRequest {
    return Alamofire.request("https://example.com/users/mattt").responseJSON { response in
        let userResponse = response.flatMap { json in
            try User(json: json)
        }

        completionHandler(userResponse)
    }
}

loadUser { response in
    if let user = response.value {
        print("User: { username: \(user.username), name: \(user.name) }")
    }
}

当映射/flatMap 闭包可能处理大量数据时，请确保您在主线程之外执行它。

@discardableResult
func loadUser(completionHandler: @escaping (DataResponse<User>) -> Void) -> Alamofire.DataRequest {
    let utilityQueue = DispatchQueue.global(qos: .utility)

    return Alamofire.request("https://example.com/users/mattt").responseJSON(queue: utilityQueue) { response in
        let userResponse = response.flatMap { json in
            try User(json: json)
        }

        DispatchQueue.main.async {
            completionHandler(userResponse)
        }
    }
}

map 和 flatMap 也可以用于 下载响应。

处理错误

在实现自定义响应序列化器或对象序列化方法之前，考虑如何处理可能发生的错误很重要。有两种基本选项：将现有错误原封不动地传递，在响应时处理；或将所有错误包装在应用程序特定的 Error 类型中。

例如，这里有一个简单的 BackendError 枚举，以后会在示例中使用。

enum BackendError: Error {
    case network(error: Error) // Capture any underlying Error from the URLSession API
    case dataSerialization(error: Error)
    case jsonSerialization(error: Error)
    case xmlSerialization(error: Error)
    case objectSerialization(reason: String)
}

创建自定义响应序列化器

Alamofire为字符串、JSON和属性列表提供了内置响应序列化，但也可以通过扩展 Alamofire.DataRequest 和 / 或 Alamofire.DownloadRequest 添加其他序列化。

例如，下面是如何使用 Ono 实现一个响应处理器的示例。

extension DataRequest {
    static func xmlResponseSerializer() -> DataResponseSerializer<ONOXMLDocument> {
        return DataResponseSerializer { request, response, data, error in
            // Pass through any underlying URLSession error to the .network case.
            guard error == nil else { return .failure(BackendError.network(error: error!)) }

            // Use Alamofire's existing data serializer to extract the data, passing the error as nil, as it has
            // already been handled.
            let result = Request.serializeResponseData(response: response, data: data, error: nil)

            guard case let .success(validData) = result else {
                return .failure(BackendError.dataSerialization(error: result.error! as! AFError))
            }

            do {
                let xml = try ONOXMLDocument(data: validData)
                return .success(xml)
            } catch {
                return .failure(BackendError.xmlSerialization(error: error))
            }
        }
    }

    @discardableResult
    func responseXMLDocument(
        queue: DispatchQueue? = nil,
        completionHandler: @escaping (DataResponse<ONOXMLDocument>) -> Void)
        -> Self
    {
        return response(
            queue: queue,
            responseSerializer: DataRequest.xmlResponseSerializer(),
            completionHandler: completionHandler
        )
    }
}

泛型响应对象序列化

可以使用泛型提供自动、类型安全的响应对象序列化。

protocol ResponseObjectSerializable {
    init?(response: HTTPURLResponse, representation: Any)
}

extension DataRequest {
    func responseObject<T: ResponseObjectSerializable>(
        queue: DispatchQueue? = nil,
        completionHandler: @escaping (DataResponse<T>) -> Void)
        -> Self
    {
        let responseSerializer = DataResponseSerializer<T> { request, response, data, error in
            guard error == nil else { return .failure(BackendError.network(error: error!)) }

            let jsonResponseSerializer = DataRequest.jsonResponseSerializer(options: .allowFragments)
            let result = jsonResponseSerializer.serializeResponse(request, response, data, nil)

            guard case let .success(jsonObject) = result else {
                return .failure(BackendError.jsonSerialization(error: result.error!))
            }

            guard let response = response, let responseObject = T(response: response, representation: jsonObject) else {
                return .failure(BackendError.objectSerialization(reason: "JSON could not be serialized: \(jsonObject)"))
            }

            return .success(responseObject)
        }

        return response(queue: queue, responseSerializer: responseSerializer, completionHandler: completionHandler)
    }
}
struct User: ResponseObjectSerializable, CustomStringConvertible {
    let username: String
    let name: String

    var description: String {
        return "User: { username: \(username), name: \(name) }"
    }

    init?(response: HTTPURLResponse, representation: Any) {
        guard
            let username = response.url?.lastPathComponent,
            let representation = representation as? [String: Any],
            let name = representation["name"] as? String
        else { return nil }

        self.username = username
        self.name = name
    }
}
Alamofire.request("https://example.com/users/mattt").responseObject { (response: DataResponse<User>) in
    debugPrint(response)

    if let user = response.result.value {
        print("User: { username: \(user.username), name: \(user.name) }")
    }
}

同样的方法也可以用来处理返回对象集合表示式的端点。

protocol ResponseCollectionSerializable {
    static func collection(from response: HTTPURLResponse, withRepresentation representation: Any) -> [Self]
}

extension ResponseCollectionSerializable where Self: ResponseObjectSerializable {
    static func collection(from response: HTTPURLResponse, withRepresentation representation: Any) -> [Self] {
        var collection: [Self] = []

        if let representation = representation as? [[String: Any]] {
            for itemRepresentation in representation {
                if let item = Self(response: response, representation: itemRepresentation) {
                    collection.append(item)
                }
            }
        }

        return collection
    }
}
extension DataRequest {
    @discardableResult
    func responseCollection<T: ResponseCollectionSerializable>(
        queue: DispatchQueue? = nil,
        completionHandler: @escaping (DataResponse<[T]>) -> Void) -> Self
    {
        let responseSerializer = DataResponseSerializer<[T]> { request, response, data, error in
            guard error == nil else { return .failure(BackendError.network(error: error!)) }

            let jsonSerializer = DataRequest.jsonResponseSerializer(options: .allowFragments)
            let result = jsonSerializer.serializeResponse(request, response, data, nil)

            guard case let .success(jsonObject) = result else {
                return .failure(BackendError.jsonSerialization(error: result.error!))
            }

            guard let response = response else {
                let reason = "Response collection could not be serialized due to nil response."
                return .failure(BackendError.objectSerialization(reason: reason))
            }

            return .success(T.collection(from: response, withRepresentation: jsonObject))
        }

        return response(responseSerializer: responseSerializer, completionHandler: completionHandler)
    }
}
struct User: ResponseObjectSerializable, ResponseCollectionSerializable, CustomStringConvertible {
    let username: String
    let name: String

    var description: String {
        return "User: { username: \(username), name: \(name) }"
    }

    init?(response: HTTPURLResponse, representation: Any) {
        guard
            let username = response.url?.lastPathComponent,
            let representation = representation as? [String: Any],
            let name = representation["name"] as? String
        else { return nil }

        self.username = username
        self.name = name
    }
}
Alamofire.request("https://example.com/users").responseCollection { (response: DataResponse<[User]>) in
    debugPrint(response)

    if let users = response.result.value {
        users.forEach { print("- \($0)") }
    }
}

安全

与服务器和Web服务通信时，使用安全的HTTPS连接是保护敏感数据的重要步骤。默认情况下，Alamofire将使用Apple的内置验证（由Security框架提供）评估服务器提供的证书链。虽然这保证了证书链有效，但它不能阻止中间人（MITM）攻击或其他潜在漏洞。为了减轻MITM攻击，处理敏感客户数据或财务信息的应用程序应使用ServerTrustPolicy提供的证书或公钥固定。

服务器信任策略

ServerTrustPolicy 枚举评估在通过安全的HTTPS连接连接到服务器时由 URLAuthenticationChallenge 提供的通常的服务器信任。

let serverTrustPolicy = ServerTrustPolicy.pinCertificates(
    certificates: ServerTrustPolicy.certificates(),
    validateCertificateChain: true,
    validateHost: true
)

有各种各样的服务器信任评估案例，让您完全控制验证过程。

  • performDefaultEvaluation：使用默认的服务器信任评估，同时允许您控制是否验证挑战提供的宿主。
  • pinCertificates：使用固定的证书来验证服务器信任。如果其中一个固定证书与服务器证书之一相匹配，则认为服务器信任有效。
  • pinPublicKeys：使用固定的公钥来验证服务器信任。如果其中一个固定公钥与服务器证书公钥之一相匹配，则认为服务器信任有效。
  • disableEvaluation：禁用所有评估，从而始终认为任何服务器信任都有效。
  • customEvaluation：使用关联的闭包来评估服务器信任的有效性，从而让您完全控制验证过程。请谨慎使用。

服务器信任策略管理器

ServerTrustPolicyManager 负责将服务器信任策略存储在特定主机的内部映射中。这允许Alamofire针对每个主机的不同服务器信任策略进行评估。

let serverTrustPolicies: [String: ServerTrustPolicy] = [
    "test.example.com": .pinCertificates(
        certificates: ServerTrustPolicy.certificates(),
        validateCertificateChain: true,
        validateHost: true
    ),
    "insecure.expired-apis.com": .disableEvaluation
]

let sessionManager = SessionManager(
    serverTrustPolicyManager: ServerTrustPolicyManager(policies: serverTrustPolicies)
)

请确保保留新的 SessionManager 实例的引用，否则当您的 sessionManager 被回收时，您的所有请求都将被取消。

这些服务器信任策略将导致以下行为

  • test.example.com 始终使用带有证书链和主机验证的证书固定，因此需要满足以下条件才能使 TLS 握手成功
    • 证书链必须有效。
    • 证书链必须包含其中一个已固定的证书。
    • 挑战主机必须与证书链中叶子的主机匹配。
  • insecure.expired-apis.com 从不评估证书链，总是会允许 TLS 握手成功。
  • 所有其他主机将使用 Apple 提供的默认评估。
子类化 Server Trust Policy Manager

如果您发现自己需要更灵活的服务器信任策略匹配行为（即通配符域名），则可以子类化 ServerTrustPolicyManager 并使用自己的自定义实现重写 serverTrustPolicyForHost 方法。

class CustomServerTrustPolicyManager: ServerTrustPolicyManager {
    override func serverTrustPolicy(forHost host: String) -> ServerTrustPolicy? {
        var policy: ServerTrustPolicy?

        // Implement your custom domain matching behavior...

        return policy
    }
}

验证主机

服务器信任策略 .performDefaultEvaluation、.pinCertificates 和 .pinPublicKeys 都接受一个 validateHost 参数。将值设置为 true 将会导致服务器信任评估验证证书中的主机名是否与挑战的主机名匹配。如果不匹配，评估将失败。将 validateHost 的值设置为 false 将仍然评估完整的证书链，但不会验证叶子的证书主机名。

建议在生产环境中始终将 validateHost 设置为 true。

验证证书链

使用 validateCertificateChain 参数，固定证书和公钥都有验证证书链的选项。将该值设置为 true，除了执行与已固定证书或公私钥的位比较外，还将评估完整的证书链。将值设置为 false 将跳过证书链验证，但仍然执行位比较。

在某些情况下，禁用证书链验证是有意义的。禁用验证最常见的使用案例是自签名证书和过期证书。在这两种情况下，评估都将失败，但位比较将仍然确保您从服务器接收到的证书是预期的。

建议在生产环境中始终将 validateCertificateChain 设置为 true。

应用传输安全性

在 iOS 9 中添加了应用传输安全性（ATS）之后，使用具有多个 ServerTrustPolicy 对象的自定义 ServerTrustPolicyManager 可能有无效。如果您连续看到 CFNetwork SSLHandshake failed (-9806) 错误，则可能是遇到了这个问题。Apple 的 ATS 系统会覆盖整个挑战系统，除非您在应用程序的 plist 中配置 ATS 设置以禁用足够多的设置来允许应用程序评估服务器信任。

如果您遇到这个问题（与自签名证书一起使用的可能性很高），可以通过向您的 Info.plist 添加以下内容来绕过这个问题。

<dict>
    <key>NSAppTransportSecurity</key>
    <dict>
        <key>NSExceptionDomains</key>
        <dict>
            <key>example.com</key>
            <dict>
                <key>NSExceptionAllowsInsecureHTTPLoads</key>
                <true/>
                <key>NSExceptionRequiresForwardSecrecy</key>
                <false/>
                <key>NSIncludesSubdomains</key>
                <true/>
                <!-- Optional: Specify minimum TLS version -->
                <key>NSTemporaryExceptionMinimumTLSVersion</key>
                <string>TLSv1.2</string>
            </dict>
        </dict>
    </dict>
</dict>

是否需要将 NSExceptionRequiresForwardSecrecy 设置为 NO 取决于您的 TLS 连接是否使用允许的加密套件。在某些情况下，需要将其设置为 NO。必须将 NSExceptionAllowsInsecureHTTPLoads 设置为 YES，以允许 SessionDelegate 接收挑战回调。一旦开始调用挑战回调，ServerTrustPolicyManager 将接管服务器信任评估。如果您尝试连接到仅支持小于 1.2 的 TLS 版本的宿主，则还需要指定 NSTemporaryExceptionMinimumTLSVersion。

建议在生产环境中始终使用有效的证书。

网络可达性

NetworkReachabilityManager 监听 WWAN 和 WiFi 网络接口的宿主和地址的可达性变化。

let manager = NetworkReachabilityManager(host: "www.apple.com")

manager?.listener = { status in
    print("Network Status Changed: \(status)")
}

manager?.startListening()

请记住在上面的示例中保留 manager，否则将不会报告状态变化。
此外，不要在host字符串中包含方案，否则可达性将无法正常使用。

当使用网络可达性来决定下一步应该如何操作时，有一些重要事项需要记住。

  • 不要使用可达性来确定是否应该发送网络请求。
    • 你应该始终发送它。
  • 当可达性恢复时，使用事件来重试失败的网络请求。
    • 即使网络请求可能仍然会失败，这也是重试它们的好时机。
  • 网络可达性状态可以用来确定网络请求可能失败的原因。
    • 如果网络请求失败，告诉用户因为离线而导致网络请求失败比提供更技术性的错误，如“请求超时”，更有用。

建议查看WWDC 2012 演讲 706，“网络最佳实践”以获取更多信息。

开放的雷达

以下雷达对 Alamofire 的当前实现有一定影响。

  • rdar://21349340 - 测试案例中由于免调用桥接问题导致的编译器抛出警告
  • rdar://26870455 - 在模拟器中背景 URL 会话配置不起作用
  • rdar://26849668 - 一些 URLProtocol API 没有正确处理 URLRequest

已解决雷达

以下雷达是在对 Alamofire 项目提出后经过一段时间解决的。

  • rdar://26761490 - Swift 字符串插值在常见用法中导致内存泄漏（在 2017 年 9 月 1 日 Xcode 9 测试版 6 中解决）。

常见问题解答

Alamofire 这个名字的由来是什么？

Alamofire 以阿拉莫火焰花命名，这种花是德克萨斯州的州花蓝bonnet的杂交变种。

Router 与 Request Adapter 中的哪些逻辑属于正确逻辑？

静态数据，如路径、参数和常用标头应属于Router。例如，可以根据身份验证系统更改值的Authorization头属于RequestAdapter。

将动态数据必须放入RequestAdapter的原因是为了支持重试操作。当请求被重试时，原始请求不会重建，这意味着将不会再次调用Router。再次调用RequestAdapter允许在重试请求之前更新原始请求上的动态数据。

致谢

Alamofire 由Alamofire 软件基金会拥有和维护。您可以通过 Twitter 跟踪他们@AlamofireSF，以获取项目更新和发布信息。

安全信息

如果您认为您已发现 Alamofire 的安全漏洞，您应尽快通过电子邮件报告给[email protected]。请不要将其发布到公共问题跟踪器。

捐赠

ASF 正在寻求筹集资金以正式注册为联邦非营利组织。注册将使我们成员获得一些法律保护，并允许我们将捐款用于免税。向 ASF 捐款将使我们能够

  • 支付登记为联邦非营利组织的法律费用
  • 支付保持非营利地位年度的法律费用
  • 支付我们的邮件服务器费用，以帮助我们处理所有问题和安全问题
  • 可能有资金为测试服务器，以便我们更容易测试边缘情况
  • 可能有资金为我们的项目全职工作开发者

Apache软件基金会（ASF）库的社区采用情况令人瞩目。我们对您对这些项目的热情和支持深感谦卑，并希望继续尽我们所能推动项目向前发展。感谢您的持续支持，Apache基金会将能够扩大其影响力，并为本基金会核心成员提供更好的法律保障。如果您在工作中使用我们任何库，请看看您的雇主是否愿意捐款。我们的初步目标是通过捐款筹集1000美元，以便整理所有法律事宜并启动这项运动。任何您今天能捐赠的金额，以帮助我们达成目标，都将受到我们的高度赞赏。

Click here to lend your support to: Alamofire Software Foundation and make a donation at pledgie.com !

许可

Alamofire软件以MIT许可证发布。有关详细信息，请参阅LICENSE。