MSUtility 0.3.1

MSUtility 0.3.1

×

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

由Mohammad Shaker维护。

 
依赖
Alamofire>= 0
SwiftyJSON>= 0
SVProgressHUD>= 0
SCLAlertView>= 0
NitroUIColorCategories>= 0
JVFloatLabeledTextField>= 0
DZNEmptyDataSet>= 0
 

MSUtility 0.3.1

  • 由
  • Mohammad Shaker

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集成到项目中。

嵌入式框架

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

    $ git init

  • 通过运行以下命令将Alamofire添加为git submodule

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

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

    它应该嵌套在应用程序的蓝色项目图标下方。它是在所有其他Xcode组之上还是之下无关紧要。

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

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

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

    您可以选择哪个“Products”文件夹无关紧要，但您选择的顶部或底部的Alamofire.framework则很重要。

  • 请选择顶部的 Alamofire.framework（用于iOS）和底部的（用于OS X）。

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

  • 就这样！

    Alamofire.framework 会自动在复制文件构建阶段被添加为目标依赖库、链接框架和嵌入框架，这正是您在模拟器和设备上构建所需要的一切。

使用说明

发起请求

import Alamofire

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

响应处理

处理使用 Alamofire 发起的 Request 的 Response 涉及到将响应处理程序链接到 Request 上。

Alamofire.request("https://httpbin.org/get").responseJSON { response in
    print(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 上，以便在请求完成时执行一次。而不是在等待从服务器收到响应时阻塞执行，我们指定了一个以闭包形式存在的 回调 来处理接收到的响应。请求的结果仅在响应闭包的作用域内可用。任何基于响应或从服务器接收到的数据进行执行的执行必须在响应闭包内完成。

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 会话代理转发所有信息。它是使用 cURL 执行请求的 Alamofire 等效物。

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。如果未发生错误并且返回了数据，那么响应的 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 处理器将服务器返回的 Data 转换为具有指定编码的 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-encoded 查询字符串，将其设置为或追加到任何现有 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方法直接支持向Request添加自定义HTTP头。这使得可以轻松地将HTTP头附加到可能不断变化的Request。

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

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

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

默认的Alamofire SessionManager为每个Request提供了一组默认的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。

如果您需要自定义这些标头，应创建一个自定义的 URLSessionConfiguration，更新 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 将服务器数据下载到磁盘上的临时文件。

目前这只能在 macOS 上工作。其他平台不允许在您的应用沙盒之外访问文件系统。要在其他平台上下载文件，请参阅Download File Destination部分。

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

如果您需要在您的应用程序处于后台时下载数据，也应使用 Alamofire.download API。有关更多信息，请参阅Session Manager Configurations部分。

下载文件目标

您还可以提供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。恢复数据可以通过下载响应来访问，然后在尝试重新启动请求时重用。

重要提醒：在最新的所有Apple平台上（iOS 10、macOS 10.12、tvOS 10、watchOS 3），背景URL会话配置中的resumeData存在问题。在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中，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上可用。因此，根据您的部署目标，您可能需要在可访问性检查中使用这些功能。

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 加载系统之上。为了充分利用这个框架，建议您熟悉底层网络堆栈的概念和能力。

推荐阅读

Session 管理员

顶层方便的方法，如 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 将用于内部构建 URL 请求。String、URL 和 URLComponents 默认遵守 URLConvertible，允许这些之一作为 url 参数传递到 request、upload 和 download 方法。

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

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

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

鼓励与网络应用程序有重大交互的应用程序让自定义类型遵守 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)

鼓励与网络应用程序有重大交互的应用程序让自定义类型遵守 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。这通常涉及生成一个访问令牌，允许你的应用程序或用户调用多种受支持的Web服务。虽然创建这些初始访问令牌可能相当费力，但当你需要刷新访问令牌时可能更加复杂。有许多线程安全问题需要考虑。

创建RequestAdapter和RequestRetrier协议是为了使为特定的一组Web服务创建线程安全的身份验证系统变得更加容易。

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协议允许在执行过程中遇到错误而无法完成的请求被重试。当同时使用RequestAdapter和RequestRetrier协议时，你可以为OAuth1、OAuth2、Basic Auth甚至指数退避重试策略创建凭证刷新系统。可能性无限。以下是如何实现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，它将自动刷新访问令牌并按相同顺序重试所有失败请求，以处理无效访问令牌错误。

如果你需要按创建顺序执行它们，你可以根据它们的任务ID对它们进行排序。

上述示例仅检查了401响应代码，这并不足够强大，但展示了如何检查无效访问令牌错误。在生产应用中，你希望检查realm和最有可能的www-authenticate头，尽管这取决于OAuth2的特定实现。

另一个重要注意事项是，这个身份验证系统可以在多个会话管理器之间共享。例如，你可能需要对同一组Web服务使用default和ephemeral会话配置。上述示例允许相同的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 中 App 传输安全（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>

是否需要将 NSExceptionRequirementsForwardSecurity 设置为 NO 取决于您的 TLS 连接是否使用受允许的加密套件。在某些情况下，需要将其设置为 NO。要允许 SessionDelegate 接收挑战回调，必须将 NSException AllowsInsecureHTTPLoads 设置为 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 会话 706，“网络最佳实践”以获取更多信息。

公开雷达

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

  • rdar://21349340 - 由于测试案例中的 toll-free bridging 问题，编译器发出警告
  • rdar://26761490 - Swift 字符串插值导致常见使用中出现内存泄漏
  • rdar://26870455 - 模拟器中不工作后台 URL Session 配置
  • rdar://26849668 - 一些 URLProtocol API 没有正确处理 URLRequest

常见问题解答

Alamofire 的名字来源是什么？

Alamofire 以 兰果花命名，它是德克萨斯州官方州花蓝bonnet 的杂交品种。

Router 与 Request Adapter 中应包含哪些逻辑？

例如路径、参数和常见头部的简单静态数据应包含在 Router 中。例如，根据身份验证系统可更改值的 Authorization 头部等动态数据应包含在 RequestAdapter 中。

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

致谢

Alamofire 由 Alamofire 软件基金会 拥有和维护。您可以通过 Twitter 关注他们的项目更新和发布情况：@AlamofireSF。

安全披露

如果您认为在 Alamofire 中发现了一个安全漏洞，请尽快通过电子邮件报告给 [email protected]。请不要将它发布在公开的 issue 跟踪系统中。

捐赠

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。