Alamofire 中请求适配器与重试器的线程安全优化

在 Swift 并发编程中，Sendable 协议扮演着至关重要的角色，它确保了类型在多线程环境中的安全传递。Alamofire 作为 iOS/macOS 平台上广泛使用的网络请求库，其核心组件如请求适配器（RequestAdapter）和请求重试器（RequestRetrier）的线程安全性尤为重要。

问题背景

Alamofire 的请求适配器和重试器通过闭包实现自定义逻辑。请求适配器（AdaptHandler）允许在请求发送前修改 URLRequest，而请求重试器（RetryHandler）则决定请求失败后是否应该重试。这两个组件在处理网络请求时可能涉及多线程操作，因此需要确保其线程安全性。

技术分析

在 Swift 并发模型中，@Sendable 标记用于指示一个闭包可以安全地在不同并发域之间传递。当闭包被标记为 @Sendable 时，编译器会验证该闭包不会意外捕获非线程安全的可变状态。

Alamofire 5.10.0 版本中，虽然 AdaptHandler 和 RetryHandler 类型本身被标记为 @Sendable，但其内部的 completion 闭包却缺少这一关键标记。这种不完整的实现可能导致以下问题：

1. 当这些处理器在并发上下文中使用时，编译器无法保证 completion 闭包的线程安全性
2. 开发者可能无意中在这些闭包中捕获可变状态，引发潜在的线程安全问题
3. 与现代 Swift 并发代码（如 async/await）交互时可能出现意外行为

解决方案

Alamofire 团队在 5.10.1 版本中修复了这一问题，为 completion 闭包添加了 @Sendable 标记。更新后的类型定义如下：

// 请求适配器闭包
public typealias AdaptHandler = @Sendable (_ request: URLRequest,
                                         _ session: Session,
                                         _ completion: @escaping @Sendable (Result<URLRequest, any Error>) -> Void) -> Void

// 请求重试器闭包
public typealias RetryHandler = @Sendable (_ request: Request,
                                         _ session: Session,
                                         _ error: any Error,
                                         _ completion: @escaping @Sendable (RetryResult) -> Void) -> Void

这一改进带来了以下优势：

1. 完整的线程安全保证：现在整个调用链都受到 Sendable 检查的保护
2. 更好的并发兼容性：可以安全地在 Swift 并发环境中使用这些处理器
3. 更严格的编译器检查：帮助开发者及早发现潜在的线程安全问题

实际影响

对于开发者而言，这一变更意味着：

1. 当在 completion 闭包中捕获值时，编译器会强制检查这些值是否符合 Sendable 要求
2. 如果闭包中使用了非线程安全的类型，编译器会给出明确的错误提示
3. 在迁移到 Swift 并发代码时，这些处理器可以无缝集成

例如，以下代码现在会受到更严格的检查：

let nonSendableObject = NonThreadSafeClass()

let adapter: AdaptHandler = { request, session, completion in
    // 编译器会报错，因为 nonSendableObject 不符合 Sendable
    nonSendableObject.modifyRequest { modifiedRequest in
        completion(.success(modifiedRequest))
    }
}

最佳实践

在使用 Alamofire 的这些处理器时，建议：

1. 尽量在闭包中使用值类型或线程安全的引用类型
2. 避免捕获可变状态，如类的可变属性
3. 如果必须共享状态，考虑使用线程安全的包装器，如 @MainActor 或锁保护
4. 优先使用 Swift 并发中的 async/await 接口，它们天然具备更好的线程安全性

总结

Alamofire 对请求适配器和重试器的 @Sendable 标记的完善，体现了其对现代 Swift 并发编程的持续支持。这一改进不仅提升了库的线程安全性，也为开发者编写更健壮的并发代码提供了更好的保障。随着 Swift 并发模型的日益普及，这类细小的但关键的安全改进将变得越来越重要。