SGFoundation 1.0.0

SGFoundation 1.0.0

×

测试已测试✗
Lang语言 Obj-CObjective C
许可证 MIT
发布上次发布2017年2月
SwiftSwift 版本3.0

由 Originalix 维护。

SGFoundation 1.0.0

  • 作者
  • Lix

Alamofire: Elegant Networking in Swift

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

特性

  • [x] 可链式请求/响应方法
  • [x] URL/JSON/plist 参数编码
  • [x] 上传文件/数据/流/多部分表单数据
  • [x] 使用请求或暂停数据下载文件
  • [x] 使用 URLCredential 进行认证
  • [x] HTTP 响应验证
  • [x] 带进度条的上传下载进度闭包
  • [x] cURL 命令输出
  • [x] 动态调整和重试请求
  • [x] TLS 证书和公开密钥锁定
  • [x] 网络可达性
  • [x] 完备的单元和集成测试覆盖率
  • [x] 完整文档

组件库

为了使 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.1+
  • Swift 3.0+

迁移指南

通讯

  • 如果您 需要帮助，请使用 Stack Overflow。 (标签‘alamofire’)
  • 如果您想 提出一个一般性问题，请使用 Stack Overflow。
  • 如果您 发现了错误，请打开一个问题。
  • 如果您 有功能请求，请打开一个问题。
  • 如果您 希望贡献，请提交一个拉取请求。

安装

Swift 包管理器

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

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

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

手动安装

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

嵌入式框架

  • 打开 Terminal，使用 cd 命令进入您的顶级项目目录，然后执行以下命令（如果您的项目未初始化为 Git 仓库）

    $ git init

  • 运行以下命令将 Alamofire 添加为 Git 子模块：

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

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

    它应该出现在您的应用程序蓝色项目图标之下。它是在所有其他 Xcode 组之上还是之下并不重要。

  • 在项目导航器中选择 Alamofire.xcodeproj，并核实部署目标匹配您的应用程序目标。

  • 接下来，在项目导航器（蓝色项目图标）中选择您的应用程序项目，导航到目标配置窗口，并在侧边的“目标”标题下选择应用程序目标。
  • 在此窗口的选项卡栏中，打开“通用”面板。
  • 在“嵌入式二进制文件”部分下点击 + 按钮。

  • 您将看到两个不同的 Alamofire.xcodeproj 文件夹，每个文件夹中都有一个嵌套在“Products”文件夹中的 Alamofire.framework 两个不同版本。

    您可以选择哪个“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")

响应处理

通过将响应处理程序链到 Request，可以处理使用 Alamofire 制作的 Request 的 Response。

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

在上面的示例中，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..<499 和 500..<599 范围的响应状态代码不会自动触发一个 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 将服务器返回的 Data 转换为 Any 类型，使用指定的 JSONSerialization.ReadingOptions。如果没有出错并且服务器数据成功序列化为 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...299 范围内，并且响应的 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", parameters: parameters)
Alamofire.request("https://httpbin.org/post", parameters: parameters, encoding: URLEncoding.default)
Alamofire.request("https://httpbin.org/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 = urlRequest.urlRequest

        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，这使得向经常改变的 Request 添加HTTP头变得容易。

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.appendPathComponent("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(directory: .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）的最新版本中，对于背景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.appendPathComponent("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 = UIPNGRepresentation(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上可用。因此，根据您的部署目标，可能需要在可用性检查中使用这些API。

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.default.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 请求。String、URL 和 URLComponents 默认遵守 URLConvertible，允许它们中的任何一个被用作 request、upload 和 download 方法中的 url 参数。

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)

鼓励与应用程序在重大方面交互的应用程序拥有自定义类型，该类型遵守 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

调整和重试请求

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

创建了 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 作为 SessionManager 的 adapter 和 retrier 应用，它将自动通过刷新访问令牌并按失败的顺序重试所有失败的请求来处理无效访问令牌的错误。

如果您需要它们按创建的顺序执行，可以按任务标识符对它们进行排序。

上述示例只检查了 401 响应代码，这并不足够强大，但展示了如何检查无效访问令牌错误。在生产应用程序中，可能会检查 realm 和可能大多数情况下是 www-authenticate 响应头，尽管这取决于 OAuth2 实现。

另一个重要的注意事项是，此认证系统可以在多个会话管理器之间共享。例如，您可能需要为同一组网络服务同时使用默认和临时会话配置。上述示例允许相同的oauthHandler实例在多个会话管理器之间共享，以管理单个刷新过程。

自定义响应序列化

处理错误

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

例如，以下是一个将在后续示例中使用的简单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将使用由Security框架提供的Apple内置验证来评估由服务器提供的证书链。虽然这保证了证书链是有效的，但它不能防止中间人(MITM)攻击或其他潜在漏洞。为了缓解MITM攻击，处理敏感客户数据或财务信息的应用程序应使用由ServerTrustPolicy提供的证书或公钥固定。

服务器信任策略

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

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

有许多不同的服务器信任评估案例，这些案例可以完全控制验证过程。

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

服务器信任策略管理器

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

let serverTrustPolicies: [String: ServerTrustPolicy] = [
    "test.example.com": .pinCertificates(
        certificates: ServerTrustPolicy.certificatesInBundle(),
        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提供的默认评估。
子类化服务器信任策略管理器

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

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系统会覆盖整个挑战系统，除非您在应用的有效负载文件（Info.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。为了允许 SessionDelegate 接收挑战回调，必须将 NSExceptionAllowsInsecureHTTPLoads 设置为 YES。一旦调用挑战回调，ServerTrustPolicyManager 将接管服务器信任评估。如果您正在尝试连接仅支持 TLS 1.2 以下版本的宿主，可能还需要指定 NSTemporaryExceptionMinimumTLSVersion。

在生产环境中始终使用有效的证书是推荐的。

网络可达性

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

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

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

manager?.startListening()

请确保在上面的示例中保留 manager，否则不会报告任何状态变化。

使用网络可达性确定下一步要做什么时，有一些重要的事项需要记住。

  • 不要使用 Reachability 来确定是否发送网络请求。
    • 您应该 始终发送它。

  • 当可达性恢复时，使用事件重试失败的网络请求。
    • 即使网络请求可能仍然失败，这也是重试它们的好时机。

  • 网络可达性状态可以用来确定为何网络请求可能失败。
    • 如果网络请求失败，最好是告知用户网络请求因离线而导致失败，而不是更技术性的错误，例如“请求超时”。

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

开放雷达

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

  • rdar://21349340 - 测试案例中由于免提桥接问题导致的编译器警告
  • rdar://26761490 - Swift 字符串插值导致常用情况下的内存泄漏
  • rdar://26870455 - 背景URL会话配置在模拟器中不工作
  • rdar://26849668 - 一些 URLProtocol API 没有正确处理 URLRequest

常见问题解答（FAQ）

Alamofire 命名的由来是什么？

Alamofire 以 Alamo 火花 命名，这是一种德克萨斯州官方州花蓝bonnet 的杂交变种。

在 Router 和 Request Adapter 中应该包含哪些逻辑？

简单的静态数据，如路径、参数和常见头信息属于 Router。动态数据，如可能基于认证系统值变化的 Authorization 头信息属于 RequestAdapter。

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

致谢

Alamofire 由 Alamofire 软件基金会 拥有和维护。您可以在推特上关注他们，获取项目更新和发布信息：@AlamofireSF。

安全公告

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

捐赠

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

  • 支付注册为联邦非营利组织所需的法律费用
  • 支付保持非营利组织良好状态的年度法律费用
  • 支付我们的邮件服务器费用，以帮助我们就所有问题和安全问题保持领先
  • 有可能资助测试服务器，以便我们更容易地进行边缘情况测试
  • 有可能资助开发者全职参与我们的项目之一

ASF 库在社区中的采用率非常高。我们对大家对项目的热情感到非常谦卑，并希望继续尽一切可能推动事物发展。在您的持续支持下，ASF 将能够扩大其影响力，并为核心成员提供更好的法律保障。如果您在工作中使用了我们的任何库，请看看您的工作单位是否会对捐赠感兴趣。我们的初步目标是筹集 1000 美元，以整理所有法律事务并启动这一运动。任何今天可以捐赠以帮助我们实现目标的钱都将非常受欢迎。

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

许可

Alamofire 在 MIT 许可下发布。有关详细信息，请参阅 LICENSE。