CRUD 1.1.5

CRUD 1.1.5

×

测试已测试✓
Lang语言 SwiftSwift
许可证 BSD
发布上次发布2016 年 10 月
SPM支持 SPM✗

由 Alexandr Zalutskiy 维护。

 
依赖
Gloss~> 1.0.0
Alamofire~> 4.0.1
时间~> 2.0.0
 

CRUD 1.1.5

  • 作者
  • Alexander Zalutskiy

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

特点

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

组件库

为了使 Alamofire 专注于核心网络实现，Alamofire 软件基金会创建了额外的组件库，

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

要求

  • iOS 9.0+ / macOS 10.11+ / tvOS 9.0+ / watchOS 2.0+
  • Xcode 8.0+
  • Swift 3.0+

迁移指南

沟通

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

安装

手动安装

如果您不希望使用上述依赖管理器之一，您可以手动将 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 文件夹，每个文件夹中都有两个不同的 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处理在Alamofire中完成的Request的响应涉及到将响应处理器链接到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)")
    }
}

在上面的例子中，一旦Request完成，就将responseJSON处理器附加到要执行的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处理器不评估任何响应数据。它仅将所有信息直接从URL会话代理传递。这是Alamofire使用cURL执行Request的等效操作。

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

    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，并且值为类型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转换为由指定的JSONSerialization.ReadingOptions定义的Any类型。如果没有错误发生并且服务器数据成功地序列化到一个JSON对象中，则响应Result将为.success，且值为类型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"])
    .response { 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"
}

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

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头字段Content-Type设置为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类型来在Request上编码JSON字符串数组的一个快速示例。

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。

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

身份验证

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

支持的认证方案

HTTP基本认证

在 Request 上的 authenticate 方法会在适当的时候自动提供一个 URLCredential 给 URLAuthenticationChallenge

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.result.isSuccess, 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 session可能会为活动中的DownloadRequest生成恢复数据。如果发生这种情况，恢复数据可以重新用于从上次位置重新启动DownloadRequest。恢复数据可以通过下载响应访问，然后在尝试重新启动请求时重新使用。

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。任务指标封装了有关请求和响应执行的某些非常好的统计信息。与Timeline非常相似，但它提供了更多Alamofire无法计算的统计数据。可以通过任何响应类型访问这些指标。

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

需要注意的重要一点是，这些API仅在iOS和tvOS 10以及macOS 10.12中可用。因此，根据您的部署目标，您可能需要在使用这些API时添加availability检查。

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

cURL命令输出

调试平台问题可能会很沮丧。幸运的是，Alamofire的Request对象遵守了Both the CustomStringConvertible和CustomDebugStringConvertible协议，从而提供了一些非常有用的调试工具。

自定义StringConvertible

let request = Alamofire.request("https://httpbin.org/ip")

print(request)
// GET https://httpbin.org/ip (200)

自定义DebugStringConvertible

let request = Alamofire.request("https://httpbin.org/get", parameters: ["foo": "bar"])
debugPrint(request)

输出

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

高级用法

Alamofire基于URLSession和Foundation URL加载系统构建。为了最大限度地发挥此框架的优势，建议您熟悉底层网络堆栈的概念和功能。

推荐阅读

会话管理器

顶级便利方法，如Alamofire.request，使用Alamofire.SessionManager的默认实例，该实例使用默认的URLSessionConfiguration进行配置。

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

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

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

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

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

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

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

使用瞬时配置创建会话管理者

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

修改会话配置

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

let configuration = URLSessionConfiguration.default
configuration.httpAdditionalHeaders = defaultHeaders

let sessionManager = Alamofire.SessionManager(configuration: configuration)

不推荐用于Authorization或Content-Type头信息。相反，使用顶级Alamofire.request API的headers参数，以及分别使用URLRequestConvertible和ParameterEncoding。

会话代理

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

覆盖闭包

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

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

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

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

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

以下是一个如何使用taskWillPerformHTTPRedirection来避免跟随到任何apple.com域的重定向的简短示例。

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

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

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

    return finalRequest
}

继承

另一种覆盖默认实现的SessionDelegate的方法是继承它。继承允许您完全自定义API的行为，或者创建API的代理并仍然使用默认实现。创建代理允许您记录事件，发布通知，提供预和后挂钩的实现等。以下是一个快速示例，说明如何继承SessionDelegate并在发生重定向时记录一条信息。

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

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

一般来说，默认实现或覆盖闭包都应该提供所需的功能。继承应该仅作为最后的手段使用。

需要注意的是，subdelegates是在默认实现中初始化和销毁的。在继承时要注意不要引入内存泄漏。

请求

请求、下载、上传或流方法的结果是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(.post, URLComponents)

与网络应用程序进行大量交互的应用程序应鼓励自定义类型符合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)) // ?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

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

RequestRetrier 协议允许在执行时遇到 Error 的 Request 被重试。当同时使用 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 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 的 adapter 和 retrier 时，它会通过自动刷新访问令牌并按相同的顺序重试所有失败的请求来处理无效访问令牌错误。

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

上述示例仅检查 401 响应状态码，而这远远不够健壮，但它确实展示了如何检查无效访问令牌错误。在生产应用程序中，您可能还需要检查 realm 以及很可能是 www-authenticate 头部响应，尽管这取决于 OAuth2 的实现。

另一个重要的注意事项是，此认证系统可以在多个会话管理器之间共享。例如，您可能需要为同一组网络服务同时使用 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将使用Security框架提供的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将跳过证书链验证，但仍将执行字节相等性检查。

在某些情况下，禁用证书链验证是有意义的。最常见的是禁用验证的自签名和过期证书。在这两种情况下，评估都会失败，但字节相等性检查将保证您从服务器接收到的证书是您预期的。

建议在 production environment 中将validateCertificateChain始终设置为true。

应用传输安全(App Transport Security, ATS)

随着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>

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

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

网络可达性

NetworkReachabilityManager监听wwan和wifi网络接口上的主机和地址的可达性变化。

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

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

manager?.startListening()

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

在使用网络可达性确定下一步操作时，有一些重要事项需要记住。

  • 不要使用可达性来判断是否应该发送网络请求。
    • 您应该始终发送它。
  • 当到达性恢复时，请使用该事件重新尝试失败的您通过网络请求。
    • 即使网络请求仍然可能会失败，但这是一个重试它们的良好时刻。
  • 网络可达性状态可以用于判断网络请求失败的原因。
    • 如果网络请求失败，告知用户网络请求失败是因为离线状态比告知更技术性的错误，如“请求超时”，更加有用。

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

Open Radars

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

  • rdar://21349340 - 测试案例中由于通行桥接引起的编译时警告
  • rdar://26761490 - Swift字符串插值在常见用法中造成内存泄漏
  • rdar://26870455 - 模拟器中的后台URL Session配置不起作用
  • rdar://26849668 - 一些URLProtocol API没有正确处理URLRequest

常见问题（FAQ）

Alamofire名字的由来是什么？

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

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

路径、参数和常用头部的简单、静态数据属于Router。基于认证系统值的变量，如Authorization头，属于RequestAdapter。

将动态数据放在RequestAdapter中的原因是支持重试操作。当Request重试时，原始请求不会重建，这意味着不会再次调用Router。再次调用RequestAdapter以在重试Request之前更新原始请求中的动态数据。

致谢

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

安全披露

如果您认为您已经确定Alamofire的安全漏洞，请通过电子邮件尽快报告。请勿在公开问题跟踪器上发布。

捐赠

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

  • 支付登记为联邦非营利组织的法律费用
  • 支付保持非营利组织良好状态的一年法律费用
  • 支付我们的邮件服务器费用，帮助我们处理所有问题和安全问题
  • 可能为测试服务器提供资金，以便我们更容易测试边缘案例
  • 可能为开发人员提供资金，以全职工作于我们的一项项目

Apache 软件基金会的库在社区中的采纳率令人印象深刻。我们对您对项目的热情深感谦卑，希望继续尽我们所能推动项目向前发展。有了您的持续支持，ASF 将能扩大其影响力，并为核心成员提供更好的法律保障。如果您在工作中使用到我们的库，看看您的雇主是否感兴趣捐赠。我们的目标是筹集 1000 美元，以便我们能做好一切法律准备并启动这项活动。任何您今天能够捐赠的数额，以帮助我们实现目标，都将受到高度赞赏。

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

许可证

Alamofire 采用 MIT 许可证发布。请参见 LICENSE 文件获取详细信息。