ArtSignProSdk 0.1.0

ArtSignProSdk 0.1.0

×

测试已测试✗
语言语言 SwiftSwift
许可证 MIT
发布最后发布2016年12月
SwiftSwift 版本3.0
SPM支持 SPM✗

由[AbelHu]维护。

 
依赖
Alamofire>= 0
Kingfisher>= 0
EZSwiftExtensions>= 0
SwiftyJSON>= 0
CryptoSwift>= 0
SwiftSpinner>= 0
Toast-Swift>= 0
M13Checkbox>= 0
IQKeyboardManager>= 0
AutoLayoutTextViews>= 0
 

ArtSignProSdk 0.1.0

  • 作者
  • AbelHu

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 上提问。
  • 如果 发现了错误，请提出一个问题。
  • 如果您 有功能请求，请提出一个问题。
  • 如果您 想要贡献，请提交一个拉取请求。

安装

手动安装

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

嵌入式框架

  • 打开终端，使用 cd 进入您的顶层项目目录，然后运行以下命令（如果您的项目不是一个 git 仓库）

    $ git init

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

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

  • 打开新的 Alamofire 文件夹，并将 Alamofire.xcodeproj 拖至您的应用程序 Xcode 项目的 Project Navigator 中。

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

  • 在 Project Navigator 中选择 Alamofire.xcodeproj 并验证部署目标与您的应用程序目标匹配。

  • 接下来，在 Project Navigator 中选择您的应用程序项目（蓝色项目图标）以导航到目标配置窗口，并在侧边栏中的“Targets”标题下选择应用程序目标。
  • 在窗口顶部的选项卡栏中，打开“General”面板。
  • 在“Embedded Binaries”部分下点击 + 按钮。

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

    您可以选择哪个 Products 文件夹无关紧要，但您选择的是顶层还是底层的 Alamofire.framework 就很重要了。

  • 对于 iOS 选择顶层的 Alamofire.framework，对于 OS X 选择底层的之一。

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

  • 这就完成了！

    Alamofire.framework 将自动添加为目标依赖，链接框架和嵌入式框架，这通常是您在模拟器和设备上需要构建的所有内容。

使用方法

发起请求

import Alamofire

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

响应处理

在 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 上，以在 Request 完成后执行。而不是阻塞执行以等待服务器的响应，指定一个形式为クロージャ的回调来处理已接收到的响应。请求的结果仅在响应闭包的作用域内可用。所有基于响应或从服务器接收到的数据的执行都必须在响应闭包内进行。

在 Alamofire 中，网络操作是 异步的。对于不熟悉概念的程序员来说，异步编程可能是烦恼的来源，但这样做有很多 很好的理由。

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

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

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

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

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

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

没有任何响应处理器会对返回的 HTTPURLResponse 进行任何验证。

例如，响应状态码位于 400..<499 和 500..<599 范围内时，不会自动触发 Error。Alamofire 使用 响应验证 方法链来实现这一点。

响应处理器

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

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

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

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

响应数据处理器

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

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

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

响应字符串处理器

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

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

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

响应 JSON 处理器

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

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

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

所有 JSON 序列化都由框架中的 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将任何完成的请求视为成功的，无论响应内容如何。如果响应状态码或不支持的MIME类型不可接受，在响应处理器之前调用validate将生成错误。

手动验证

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

可以将这些值作为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-encoded查询字符串，将其设置为或追加到任何现有的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体。编码请求的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提供一组默认的头部。这包括

  • 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始终将服务器数据下载到内存中。这对于较小的数据负载来说 efficiency非常好，但是如果数据量较大，下载可能会导致应用程序耗尽内存。正因为如此，您还可以使用Alamofire.download API将服务器数据下载到硬盘上的临时文件。

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

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

下载文件目标

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

  • .createIntermediateDirectories - 如果指定，为目标URL创建中间目录。
  • .removePreviousFile - 如果指定，从目标URL删除旧文件。
let destination: DownloadRequest.DownloadFileDestination = { _, _ in
    let documentsURL = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask)[0]
    let fileURL = documentsURL.appendPathComponent("pig.png")

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

Alamofire.download(urlString, to: destination).response { response in
    print(response)

    if response.error == nil, let imagePath = response.destinationURL?.path {
        let image = UIImage(contentsOfFile: imagePath)
    }
}

您还可以使用建议的下载目标API。

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

下载进度

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

Alamofire.download("https://httpbin.org/image/png")
    .downloadProgress { progress in
        print("Download Progress: \(progress.fractionCompleted)")
    }
    .responseData { response in
        if let data = response.result.value {
            let image = UIImage(data: data)
        }
    }

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

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

Alamofire.download("https://httpbin.org/image/png")
    .downloadProgress(queue: utilityQueue) { progress in
        print("Download Progress: \(progress.fractionCompleted)")
    }
    .responseData { response in
        if let data = response.result.value {
            let image = UIImage(data: data)
        }
    }

恢复下载

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

重要：在所有苹果平台（iOS 10、macOS 10.12、tvOS 10、watchOS 3）的最新版本中，背景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 Session 任务指标

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

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

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

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

cURL命令输出

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

自定义字符串可转换

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

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

自定义调试字符串可转换

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

输出结果

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

高级使用方法

Alamofire建立基于《URLSession》和Foundation URL异步加载系统。为了最大限度地利用此框架，建议您熟悉底层网络堆栈的概念和能力。

推荐阅读

会话管理器

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

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

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

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

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

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

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

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

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

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

修改会话配置

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

let configuration = URLSessionConfiguration.default
configuration.httpAdditionalHeaders = defaultHeaders

let sessionManager = Alamofire.SessionManager(configuration: configuration)

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

会话代理

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

覆盖闭包

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

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

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

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

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

以下是如何使用 taskWillPerformHTTPRedirection 来避免遵循指向任何 apple.com 域的重新定向的简短示例。

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

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

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

    return finalRequest
}

子类化

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

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

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

一般来说，默认实现或覆盖闭包应该提供所需的所有功能。只有在万不得已的情况下才应使用子类化。

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

请求

请求、下载、上传、流方法的执行结果分别是DataRequest、DownloadRequest、UploadRequest和StreamRequest，它们都继承自Request。所有的Request实例都是由所属会话管理器创建的，不能直接初始化。

每个子类都有专门的例如authenticate、validate、responseJSON和uploadProgress等方法，这些方法都会返回调用者的实例，以便于方法链的调用。

请求可以被暂停、恢复和取消

  • suspend()：暂停底层的任务和派遣队列。
  • resume()：恢复底层的任务和派遣队列。如果所属管理器未将startRequestsImmediately设置为true，请求必须调用resume()以启动。
  • cancel()：取消底层的任务，生成一个错误，并将其传递给任何注册的响应处理器。

请求路由

随着应用规模的不断扩大，在构建网络堆栈时采用通用模式非常重要。这部分设计的一个重要方面是请求的路由方式。Alamofire的URLConvertible和URLRequestConvertible协议以及Router设计模式就是为了帮助开发者实现这些。

URLConvertible

采用URLConvertible协议的类型可用来构建URL，这些URL然后将被用于构建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)

鼓励与Web应用有重大交互的应用拥有自定义类型服从URLConvertible协议，作为将领域特定模型映射到服务器资源的便捷方式。

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

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

URLRequestConvertible

采用URLRequestConvertible协议的类型可用来构建URL请求。默认情况下，URLRequest服从URLRequestConvertible协议，允许它直接传递给request、upload和download方法（这是指定单个请求自定义HTTP主体的推荐方式）。

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

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

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

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

Alamofire.request(urlRequest)

鼓励与Web应用有重大交互的应用拥有自定义类型服从URLRequestConvertible协议，以确保请求端点的统一性。这种方法可以用来抽象服务器端的不一致性，提供类型安全的路由，并管理认证凭据和其他状态。

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

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

    // MARK: URLRequestConvertible

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

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

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

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

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

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

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

    // MARK: URLRequestConvertible

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

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

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

        return urlRequest
    }
}
Alamofire.request(Router.readUser("mattt")) // GET /users/mattt

调整和重试请求

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

为了简化特定一组网络服务的线程安全认证系统的创建，创建了 RequestAdapter 和 RequestRetrier 协议。

RequestAdapter

RequestAdapter 协议允许在创建之前对通过 SessionManager 发送的每个 Request 进行检查和适配。使用适配器的一种非常具体的方法是在经过某种类型的认证后，向请求中添加一个 Authorization 标头。

class AccessTokenAdapter: RequestAdapter {
    private let accessToken: String

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

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

        if 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: Any], 
                    let accessToken = json["access_token"] as? String, 
                    let refreshToken = json["refresh_token"] as? String 
                {
                    completion(true, accessToken, refreshToken)
                } else {
                    completion(false, nil, nil)
                }

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

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

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

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

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

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

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

上面的示例仅检查响应代码为 401，但这远不足以稳健，但它确实演示了如何检查无效访问令牌错误。在实际应用中，您可能会想要检查 realm，以及很可能是 www-authenticate 响应头，尽管这取决于 OAuth2 的实现。

另一个重要的注意事项是，这个认证系统可以在多个会话管理器之间共享。例如，您可能需要为同一组网络服务同时使用 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的子类化

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

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

        // Implement your custom domain matching behavior...

        return policy
    }
}

验证宿主

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

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

验证证书链

配置证书和公钥的固定都提供了使用 validateCertificateChain 参数验证证书链的选项。通过将此值设置为 true，除了对固定的证书或公钥执行字节相等性检查之外，还将评估完整的证书链。将值设置为 false 将跳过证书链验证，但仍然执行字节相等性检查。

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

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

应用传输安全

在 iOS 9 中添加了应用传输安全 (ATS) 之后，使用具有多个 ServerTrustPolicy 对象的自定义 ServerTrustPolicyManager 可能没有任何效果。如果您多次看到 CFNetwork SSLHandshake failed (-9806) 错误，则可能遇到此问题。除非您在应用的 plst 脚本中配置 ATS 设置以禁用足够的功能来允许应用评估服务器信任，否则 Apple 的 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场会议，“网络最佳实践”获取更多信息。

打开雷达

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

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

常见问题解答 (FAQ)

Alamofire 名称的由来是什么？

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

该将哪种逻辑放在 Router 和 Request Adapter 中？

简单的静态数据，如路径、参数和常见的头，应该放在 Router 中。需要根据身份验证系统更改值（如 Authorization 头）的动态数据属于 RequestAdapter。

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

致谢

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

安全披露

如果您认为您已经发现了与 Alamofire 相关的安全漏洞，请立即通过电子邮件报告，发送至[email protected]。请勿将其发布到公共问题跟踪器。

捐款

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

  • 支付注册为联邦非营利组织所需的律师费
  • 支付保持非营利组织良好状态的年度律师费
  • 支付我们邮件服务器的费用，以帮助我们处理所有问题和安全问题
  • 可能为测试服务器提供资金，以便我们更容易测试边缘情况
  • 可能资助开发者全职参与我们的某个项目

ASF库在社区中的采用令人瞩目。我们对您对项目表现出的热情深感谦卑，并希望继续尽我们所能推动项目发展。在您的持续支持下，ASF将能够扩大其影响力，并为核心成员提供更好的法律保障。如果您在工作中使用了我们的库，看看您的雇主是否感兴趣进行捐赠。我们的初步目标是筹集1000美元，以完善所有法律条款，并启动这次活动。您今天能捐出任何金额以帮助我们实现目标，都将是极大的帮助。

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

许可协议

Alamofire遵循MIT许可协议。有关详细信息，请参阅LICENSE。