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

Created at: 2014-07-31 13:56:19
Language: Swift
License: MIT

Alamofire: Elegant Networking in Swift

迅速 平台 兼容可可豆荚 迦太基兼容 Swift Package Manager 斯威夫特论坛

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

特征

  • [x] 可链接的请求/响应方法
  • [x] Swift Concurrency Support 回到 iOS 13、macOS 10.15、tvOS 13 和 watchOS 6。
  • [x] 组合支持
  • [x] 网址/JSON 参数编码
  • [x] 上传文件 / 数据 / 流 / 多部分表单数据
  • [x] 使用请求或恢复数据下载文件
  • [x] 身份验证
    URLCredential
  • [x] HTTP 响应验证
  • [x] 上传和下载进度关闭与进度
  • [x] cURL 命令输出
  • [x] 动态调整和重试请求
  • [x] TLS 证书和公钥固定
  • [x] 网络可达性
  • [x] 全面的单元和集成测试覆盖范围
  • [x] 完整文档

快速编写请求!

Alamofire的紧凑语法和广泛的功能集允许在几行代码中编写具有自动重试等强大功能的请求。

// Automatic String to URL conversion, Swift concurrency support, and automatic retry.
let response = await AF.request("https://httpbin.org/get", interceptor: .retryPolicy)
                       // Automatic HTTP Basic Auth.
                       .authenticate(username: "user", password: "pass")
                       // Caching customization.
                       .cacheResponse(using: .cache)
                       // Redirect customization.
                       .redirect(using: .follow)
                       // Validate response code and Content-Type.
                       .validate()
                       // Produce a cURL command for the request.
                       .cURLDescription { description in
                         print(description)
                       }
                       // Automatic Decodable support with background parsing.
                       .serializingDecodable(DecodableType.self)
                       // Await the full response with metrics and a parsed body.
                       .response
// Detailed response description for easy debugging.
debugPrint(response)

组件库

为了使Alamofire专注于核心网络实现,Alamofire软件基金会创建了额外的组件库,为Alamofire生态系统带来了额外的功能。

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

要求

平台 最低 Swift 版本 安装 地位
iOS 10.0+ / macOS 10.12+ / tvOS 10.0+ / watchOS 3.0+ 5.6 CocoaPods迦太基Swift Package ManagerManual 经过全面测试
Linux目录 仅最新 Swift Package Manager 构建但不受支持
窗户 仅最新 Swift Package Manager 构建但不受支持
人造人 仅最新 Swift Package Manager 构建但不受支持

Linux 和 Windows 上的已知问题

Alamofire建立在Linux,Windows和Android上,但是底层缺少功能和许多问题,这些问题阻碍了全部功能并可能导致崩溃。其中包括:

swift-corelibs-foundation

  • ServerTrustManager
    关联的证书功能不可用,因此没有证书固定,也没有客户端证书支持。
  • 各种 HTTP 身份验证方法可能会崩溃,包括 HTTP Basic 和 HTTP 摘要。如果响应包含服务器质询,则可能会发生崩溃。
  • 通过和关联的 API 进行缓存控制不可用,因为不会调用基础委托方法。
    CachedResponseHandler
  • URLSessionTaskMetrics
    从不聚集。

由于这些问题,Alamofire在Linux,Windows和Android上不受支持。请向 Swift 错误报告器的任何崩溃。

迁移指南

通信

安装

可可豆荚

CocoaPods 是 Cocoa 项目的依赖管理器。有关使用和安装说明,请访问他们的网站。要使用 CocoaPods 将 Alamofire 集成到你的 Xcode 项目中,请在你的 :

Podfile

pod 'Alamofire'

迦太基

Carthage是一个去中心化的依赖管理器,它构建你的依赖并为你提供二进制框架。要使用迦太基将Alamofire集成到Xcode项目中,请在:

Cartfile

github "Alamofire/Alamofire"

Swift Package Manager

The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the

swift
compiler.

Once you have your Swift package set up, adding Alamofire as a dependency is as easy as adding it to the

dependencies
value of your
Package.swift
.

dependencies: [
    .package(url: "https://github.com/Alamofire/Alamofire.git", .upToNextMajor(from: "5.8.0"))
]

Manually

If you prefer not to use any of the aforementioned dependency managers, you can integrate Alamofire into your project manually.

Embedded Framework

  • Open up Terminal,

    cd
    into your top-level project directory, and run the following command "if" your project is not initialized as a git repository:

    $ git init
  • Add Alamofire as a git submodule by running the following command:

    $ git submodule add https://github.com/Alamofire/Alamofire.git
  • Open the new

    Alamofire
    folder, and drag the
    Alamofire.xcodeproj
    into the Project Navigator of your application's Xcode project.

    It should appear nested underneath your application's blue project icon. Whether it is above or below all the other Xcode groups does not matter.

  • Select the

    Alamofire.xcodeproj
    in the Project Navigator and verify the deployment target matches that of your application target.

  • Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the "Targets" heading in the sidebar.

  • In the tab bar at the top of that window, open the "General" panel.

  • Click on the

    +
    button under the "Embedded Binaries" section.

  • You will see two different

    Alamofire.xcodeproj
    folders each with two different versions of the
    Alamofire.framework
    nested inside a
    Products
    folder.

    It does not matter which

    Products
    folder you choose from, but it does matter whether you choose the top or bottom
    Alamofire.framework
    .

  • Select the top

    Alamofire.framework
    for iOS and the bottom one for macOS.

    You can verify which one you selected by inspecting the build log for your project. The build target for

    Alamofire
    will be listed as
    Alamofire iOS
    ,
    Alamofire macOS
    ,
    Alamofire tvOS
    , or
    Alamofire watchOS
    .

  • And that's it!

    The

    Alamofire.framework
    is automagically added as a target dependency, linked framework and embedded framework in a copy files build phase which is all you need to build on the simulator and a device.

Contributing

Before contributing to Alamofire, please read the instructions detailed in our contribution guide.

Open Radars

The following radars have some effect on the current implementation of Alamofire.

  • rdar://21349340
    - Compiler throwing warning due to toll-free bridging issue in the test case
  • rdar://26870455
    - Background URL Session Configurations do not work in the simulator
  • rdar://26849668
    - Some URLProtocol APIs do not properly handle
    URLRequest

Resolved Radars

The following radars have been resolved over time after being filed against the Alamofire project.

  • rdar://26761490
    - Swift string interpolation causing memory leak with common usage.
    • (Resolved): 9/1/17 in Xcode 9 beta 6.
  • rdar://36082113
    -
    URLSessionTaskMetrics
    failing to link on watchOS 3.0+
    • (Resolved): Just add
      CFNetwork
      to your linked frameworks.
  • FB7624529
    -
    urlSession(_:task:didFinishCollecting:)
    never called on watchOS
    • (Resolved): Metrics now collected on watchOS 7+.

FAQ

What's the origin of the name Alamofire?

Alamofire is named after the Alamo Fire flower, a hybrid variant of the Bluebonnet, the official state flower of Texas.

捐赠

Alamofire is owned and maintained by the Alamofire Software Foundation. You can follow them on Twitter at @AlamofireSF for project updates and releases.

Security Disclosure

If you believe you have identified a security vulnerability with Alamofire, you should report it as soon as possible via email to security@alamofire.org. Please do not post it to a public issue tracker.

Sponsorship

The ASF is looking to raise money to officially stay registered as a federal non-profit organization. Registering will allow Foundation members to gain some legal protections and also allow us to put donations to use, tax-free. Sponsoring the ASF will enable us to:

  • Pay our yearly legal fees to keep the non-profit in good status
  • Pay for our mail servers to help us stay on top of all questions and security issues
  • Potentially fund test servers to make it easier for us to test the edge cases
  • Potentially fund developers to work on one of our projects full-time

The community adoption of the ASF libraries has been amazing. We are greatly humbled by your enthusiasm around the projects and want to continue to do everything we can to move the needle forward. With your continued support, the ASF will be able to improve its reach and also provide better legal safety for the core members. If you use any of our libraries for work, see if your employers would be interested in donating. Any amount you can donate, whether once or monthly, to help us reach our goal would be greatly appreciated.

Sponsor Alamofire

Supporters

MacStadium provides Alamofire with a free, hosted Mac mini.

由 MacStadium 提供支持

License

Alamofire is released under the MIT license. See LICENSE for details.