AlamofireDomain 4.1

AlamofireDomain 4.1

×

测试已测试✓
语言语言 SwiftSwift
许可证 MIT
发布日期最近发布2016年11月
SwiftSwift 版本3.0
SPM支持 SPM✓

由 李建堂 维护。

AlamofireDomain 4.1

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.11+ / tvOS 9.0+ / watchOS 2.0+
  • Xcode 8.0+
  • Swift 3.0+

迁移指南

交流

  • 如果您 需要帮助，请在 Stack Overflow 上提问。（标签“alamofire”）
  • 如果您想 提问一些基本问题，请在 Stack Overflow 上提问。
  • 如果您 发现了一个错误，请提交一个议题。
  • 如果您 有一个功能请求，请提交一个议题。
  • 如果您 想进行贡献，提交一个 pull 请求。

安装

手动

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

内嵌框架

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

    $ git init

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

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

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

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

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

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

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

    您可以选择哪个“产品”文件夹并不重要，但您选择的是顶部的 Alamofire.framework 还是底部的 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 中，处理一个请求的 Response，涉及将响应处理程序链接到 Request。

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 (DefaultDownloadResponse) -> 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 Validation 链式方法来实现这一点。

响应处理器

response 处理程序不会评估响应数据。它只是直接从前端代理处转发所有信息。它是 Alamofire 使用 cURL 执行请求的等效功能。

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 将使用 Servers 从 HTTPURLResponse 中指定的文本编码。如果服务器响应无法确定文本编码，它将默认为 .isoLatin1。

响应 JSON 处理器

responseJSON 处理程序使用 responseJSONSerializer 将服务器返回的 Data 转换为使用指定的 JSONSerialization.ReadingOptions 的 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...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 主体编解码请求的内容类型 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正文。编码请求的HTTP头Content-Type字段设置为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表示，根据相关的格式和写入选项值，设置为由请求正文。编码请求的HTTP头Content-Type字段设置为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
    }
}

Manual Parameter Encoding of a 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方法直接支持向Request添加自定义HTTP头。这使得很容易将HTTP头附加到一个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提供一组默认的HTTP头。这些包括

  • 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。

如果您需要自定义这些头，应创建自定义的URLSessionManagerConfiguration，更新defaultHTTPHeaders属性，并将该配置应用于新的SessionManager实例。

身份验证

身份验证在系统框架级别由URLCredential和URLAuthenticationChallenge处理。

支持的认证方案：

HTTP基本认证

在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将服务器数据下载到硬盘上的临时文件。

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）中，resumeData在后台URL会话配置中被破坏。在恢复数据生成逻辑中存在一个底层错误，数据写入不正确，并且总是无法恢复下载。有关此错误和可能的解决方案的更多信息，请参阅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中，Apple引入了新的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、URLRequestConvertible和ParameterEncoding中使用相应的headers参数。

会话代理

默认情况下，一个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是默认实现中初始化和销毁的。在子类化时要小心，以免引入内存泄漏。

请求

请求、下载、上传或流方法的返回结果为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方法。

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(.post, URLComponents)

鼓励与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)) // ?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 /users/mattt

调整和重试请求

如今，大多数网络服务都后接某种类型的认证系统。其中之一就是OAuth。这通常涉及生成访问令牌，允许您的应用程序或用户调用各种受支持的网络服务。虽然创建这些初始访问令牌可能非常耗时，但当访问令牌过期且需要获取新的令牌时，可能会更加复杂。有许多线程安全问题需要考虑。

RequestAdapter和RequestRetrier协议的创建使得为特定网络服务创建线程安全的认证系统变得更加容易。

请求适配器

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 urlRequest.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 协议允许重试在执行过程中遇到错误的 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 url = urlRequest.url, url.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: String] {
                    completion(true, json["access_token"], json["refresh_token"])
                } 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 的适配器和重试器应用，它将自动刷新访问令牌并按相同的顺序重试所有失败请求以处理无效访问令牌错误。

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

上述示例仅检查 401 响应代码，这远远不够强大，但确实展示了如何检查无效访问令牌错误。在生产应用程序中，您可能希望检查 realm 并且很可能是 www-authenticate 响应头，尽管这取决于 OAuth2 实现。

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

自定义响应序列化

处理错误

在实现自定义响应序列化器或对象序列化方法之前，必须考虑如何处理可能发生的任何错误。有两种基本选项：传输现有错误而不进行修改，以在响应时进行处理；或将所有错误包裹在应用程序特定的 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安全框架提供的内置验证方式评估服务器提供的证书链。虽然这保证了证书链的有效性，但它并不能防止中间人攻击（MITM）或其他潜在的风险。为了减轻MITM攻击的风险，处理敏感客户数据或财务信息的应用程序应使用ServerTrustPolicy提供的证书或公钥固定。

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提供的默认评估。
子类化服务器信任策略管理器

如果您发现自己需要更灵活的服务器信任策略匹配行为（即通配符域名），则需要子类化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。为了允许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，否则将不会报告状态变化。

在利用网络可达性来决定下一步操作时，有一些重要的注意事项。

  • 请不要使用可达性来决定是否发送网络请求。
    • 您应该始终发送请求。

  • 当可达性恢复时，使用事件来重试失败的网络请求。
    • 尽管网络请求可能仍然失败，但这是一个重试请求的好时机。

  • 网络可达状态可以用来判断网络请求失败的原因。
    • 如果网络请求失败，告诉用户是因为离线而不是更技术性的错误（如“请求超时”）更有用。

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

开放雷达

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

  • rdar://21349340 - 测试案例中因免费桥接问题导致的编译器抛出警告
  • rdar://26761490 - Swift字符串插值导致常见使用中的内存泄漏
  • rdar://26870455 - 在模拟器中，后台URL会话配置不起作用
  • rdar://26849668 - 一些URLProtocol API未能正确处理URLRequest

常见问题解答（FAQ）

Alamofire名字的来源是什么？

Alamofire的名字来自Alamo Fire花，这是德克萨斯州官方州花蓝bonnet的杂交品种。

路由器与请求适配器中应包含哪些逻辑？

简单、静态的数据，如路径、参数和常用头部应包含在Router中。动态数据，如基于认证系统的Authorization头部，其值可以根据认证系统更改，应包含在RequestAdapter中。

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

致谢

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

安全披露

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

捐赠

ASF希望筹集资金以正式注册为联邦非营利组织。注册将使我们成员获得一些法律保护，并允许我们将捐赠缴纳税款。捐赠给ASF将使我们能够

  • 支付联邦非营利组织注册的合法费用
  • 支付维持非营利组织良好状态的年度法律费用
  • 为我们的邮件服务器付费，帮助我们跟踪所有问题和安全问题
  • 可能资助测试服务器，使我们更容易测试边缘情况
  • 可能资助开发者全职工作在我们的一些项目上

Apache软件基金会(Apache Software Foundation, ASF)库在社区中的应用非常广泛。我们非常感激大家对项目的热情支持，并想尽一切可能推动项目发展。有了您们的持续支持，ASF将能够扩大其影响力，并为核心成员提供更好的法律保护。如果您的雇主对捐赠感兴趣，请使用我们的库。我们的初始目标是筹集1000美元，以便将我们的法律事务规范化并启动这一活动。您今天捐赠的任何金额都将极大地帮助实现我们的目标。

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

许可协议

Alamofire遵循MIT许可协议。请参考LICENSE文件以获取详细信息。