AFNetworking 是一个为 iOS、macOS、watchOS 和 tvOS 提供出色网络功能的库。它基于 Foundation URL 加载系统，扩展了 Cocoa 中内置的强大高级网络抽象。它具有模块化架构，具有精心设计的、功能丰富的 API，使用起来非常愉快。
然而，所有功能中最重要的是，它拥有一个令人惊叹的开发者社区，他们每天都在使用和贡献 AFNetworking。AFNetworking 为一些最受欢迎和广受好评的 iPhone、iPad 和 Mac 应用程序提供支持。
如何开始
- 下载 AFNetworking 并尝试示例应用程序
- 阅读 "如何开始" 指南，常见问题解答 或 Wiki 上的其他文章
通讯
- 如果您 需要帮助，请使用 Stack Overflow。（标签 'afnetworking'）
- 如果您想要 提出一般问题，请使用 Stack Overflow。
- 如果您 发现了错误，并能提供可靠地重现它的步骤，请打开一个问题。
- 如果您 有功能请求，请打开一个问题。
- 如果您 想要贡献力量，请提交一个 pull request。
安装
AFNetworking支持多种方法将库安装到项目中。
使用CocoaPods进行安装
要在Xcode项目中使用CocoaPods集成AFNetworking，在您的Podfile中指定它。
pod 'AFNetworking', '~> 4.0'使用Swift Package Manager进行安装
一旦设置好Swift包，添加AFNetworking作为依赖项就像在您的Package.swift的dependencies值中添加它一样简单。
dependencies: [
.package(url: "https://github.com/AFNetworking/AFNetworking.git", .upToNextMajor(from: "4.0.0"))
]注意：AFNetworking的Swift包不包括其UIKit扩展。
使用Carthage进行安装
Carthage是一个去中心化的依赖管理工具，它构建依赖性并提供二进制框架。要集成AFNetworking，请在您的Cartfile中添加以下内容。
github "AFNetworking/AFNetworking" ~> 4.0
需求
| AFNetworking版本 | 最低iOS目标 | 最低macOS目标 | 最低watchOS目标 | 最低tvOS目标 | 备注 |
|---|---|---|---|---|---|
| 4.x | iOS 9 | macOS 10.10 | watchOS 2.0 | tvOS 9.0 | 需要Xcode 11+。 |
| 3.x | iOS 7 | OS X 10.9 | watchOS 2.0 | tvOS 9.0 | 需要Xcode 7+。已移除NSURLConnectionOperation支持。 |
| 2.6 -> 2.6.3 | iOS 7 | OS X 10.9 | watchOS 2.0 | 不适用 | 需要Xcode 7+。 |
| 2.0 -> 2.5.4 | iOS 6 | OS X 10.8 | 不适用 | 不适用 | 需要Xcode 5+。《code>NSURLSession subspec需要iOS 7或OS X 10.9。 |
| 1.x | iOS 5 | Mac OS X 10.7 | 不适用 | 不适用 | |
| 0.10.x | iOS 4 | Mac OS X 10.6 | 不适用 | 不适用 |
（macOS项目必须支持64位现代Cocoa运行时）。
正在用Swift编程？尝试使用Alamofire以获得更传统的API集合。
架构
NSURLSession
AFURLSessionManagerAFHTTPSessionManager
序列化
<AFURLRequestSerialization>AFHTTPRequestSerializerAFJSONRequestSerializerAFPropertyListRequestSerializer
<AFURLResponseSerialization>AFHTTPResponseSerializerAFJSONResponseSerializerAFXMLParserResponseSerializerAFXMLDocumentResponseSerializer(macOS)AFPropertyListResponseSerializerAFImageResponseSerializerAFCompoundResponseSerializer
附加功能
AFSecurityPolicyAFNetworkReachabilityManager
使用方法
AFURLSessionManager
AFURLSessionManager 根据指定的 NSURLSessionConfiguration 对象创建并管理一个 NSURLSession 对象，该对象遵循 <NSURLSessionTaskDelegate>、<NSURLSessionDataDelegate>、<NSURLSessionDownloadDelegate> 和 <NSURLSessionDelegate>。
创建下载任务
NSURLSessionConfiguration *configuration = [NSURLSessionConfiguration defaultSessionConfiguration];
AFURLSessionManager *manager = [[AFURLSessionManager alloc] initWithSessionConfiguration:configuration];
NSURL *URL = [NSURL URLWithString:@"http://example.com/download.zip"];
NSURLRequest *request = [NSURLRequest requestWithURL:URL];
NSURLSessionDownloadTask *downloadTask = [manager downloadTaskWithRequest:request progress:nil destination:^NSURL *(NSURL *targetPath, NSURLResponse *response) {
NSURL *documentsDirectoryURL = [[NSFileManager defaultManager] URLForDirectory:NSDocumentDirectory inDomain:NSUserDomainMask appropriateForURL:nil create:NO error:nil];
return [documentsDirectoryURL URLByAppendingPathComponent:[response suggestedFilename]];
} completionHandler:^(NSURLResponse *response, NSURL *filePath, NSError *error) {
NSLog(@"File downloaded to: %@", filePath);
}];
[downloadTask resume];创建上传任务
NSURLSessionConfiguration *configuration = [NSURLSessionConfiguration defaultSessionConfiguration];
AFURLSessionManager *manager = [[AFURLSessionManager alloc] initWithSessionConfiguration:configuration];
NSURL *URL = [NSURL URLWithString:@"http://example.com/upload"];
NSURLRequest *request = [NSURLRequest requestWithURL:URL];
NSURL *filePath = [NSURL fileURLWithPath:@"file://path/to/image.png"];
NSURLSessionUploadTask *uploadTask = [manager uploadTaskWithRequest:request fromFile:filePath progress:nil completionHandler:^(NSURLResponse *response, id responseObject, NSError *error) {
if (error) {
NSLog(@"Error: %@", error);
} else {
NSLog(@"Success: %@ %@", response, responseObject);
}
}];
[uploadTask resume];创建带有进度的多部分请求上传任务
NSMutableURLRequest *request = [[AFHTTPRequestSerializer serializer] multipartFormRequestWithMethod:@"POST" URLString:@"http://example.com/upload" parameters:nil constructingBodyWithBlock:^(id<AFMultipartFormData> formData) {
[formData appendPartWithFileURL:[NSURL fileURLWithPath:@"file://path/to/image.jpg"] name:@"file" fileName:@"filename.jpg" mimeType:@"image/jpeg" error:nil];
} error:nil];
AFURLSessionManager *manager = [[AFURLSessionManager alloc] initWithSessionConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration]];
NSURLSessionUploadTask *uploadTask;
uploadTask = [manager
uploadTaskWithStreamedRequest:request
progress:^(NSProgress * _Nonnull uploadProgress) {
// This is not called back on the main queue.
// You are responsible for dispatching to the main queue for UI updates
dispatch_async(dispatch_get_main_queue(), ^{
//Update the progress view
[progressView setProgress:uploadProgress.fractionCompleted];
});
}
completionHandler:^(NSURLResponse * _Nonnull response, id _Nullable responseObject, NSError * _Nullable error) {
if (error) {
NSLog(@"Error: %@", error);
} else {
NSLog(@"%@ %@", response, responseObject);
}
}];
[uploadTask resume];创建数据任务
NSURLSessionConfiguration *configuration = [NSURLSessionConfiguration defaultSessionConfiguration];
AFURLSessionManager *manager = [[AFURLSessionManager alloc] initWithSessionConfiguration:configuration];
NSURL *URL = [NSURL URLWithString:@"http://httpbin.org/get"];
NSURLRequest *request = [NSURLRequest requestWithURL:URL];
NSURLSessionDataTask *dataTask = [manager dataTaskWithRequest:request completionHandler:^(NSURLResponse *response, id responseObject, NSError *error) {
if (error) {
NSLog(@"Error: %@", error);
} else {
NSLog(@"%@ %@", response, responseObject);
}
}];
[dataTask resume];请求序列化
请求序列化器根据URL字符串创建请求，将参数编码为查询字符串或HTTP正文。
NSString *URLString = @"http://example.com";
NSDictionary *parameters = @{@"foo": @"bar", @"baz": @[@1, @2, @3]};查询字符串参数编码
[[AFHTTPRequestSerializer serializer] requestWithMethod:@"GET" URLString:URLString parameters:parameters error:nil];GET http://example.com?foo=bar&baz[]=1&baz[]=2&baz[]=3
URL表单参数编码
[[AFHTTPRequestSerializer serializer] requestWithMethod:@"POST" URLString:URLString parameters:parameters error:nil];POST http://example.com/
Content-Type: application/x-www-form-urlencoded
foo=bar&baz[]=1&baz[]=2&baz[]=3
JSON参数编码
[[AFJSONRequestSerializer serializer] requestWithMethod:@"POST" URLString:URLString parameters:parameters error:nil];POST http://example.com/
Content-Type: application/json
{"foo": "bar", "baz": [1,2,3]}
网络可达性管理器
AFNetworkReachabilityManager 监视WWAN和WiFi网络接口的可达性。
- 请不要使用可达性来决定是否发送原始请求。
- 你应该尝试发送它。
- 你可以使用可达性来确定何时应该自动重试请求。
- 即使它仍然可能失败，当从可达性通知中得知连接可用时，是一个重试的好时机。
- 网络可达性是一个用于确定请求可能失败原因的有用工具。
- 在网络请求失败后，告诉用户他们离线，比给他们一个更技术更准确的错误，如“请求超时”，要好。
另请参阅 WWDC 2012会议 706，“网络最佳实践”。
共享网络可达性
[[AFNetworkReachabilityManager sharedManager] setReachabilityStatusChangeBlock:^(AFNetworkReachabilityStatus status) {
NSLog(@"Reachability: %@", AFStringFromNetworkReachabilityStatus(status));
}];
[[AFNetworkReachabilityManager sharedManager] startMonitoring];安全策略
AFSecurityPolicy 评估服务器信任度，针对安全连接中的固定X.509证书和公钥。
将固定的SSL证书添加到您的应用程序有助于防止中间人攻击和其他漏洞。处理敏感客户数据或金融信息的应用程序强烈建议通过配置并启用了SSL固定的HTTPS连接进行所有通信。
允许无效的SSL证书
AFHTTPSessionManager *manager = [AFHTTPSessionManager manager];
manager.securityPolicy.allowInvalidCertificates = YES; // not recommended for production单元测试
AFNetworking在Tests子目录中包含一系列单元测试。您可以简单执行平台框架上的测试操作来运行这些测试。
致谢
AFNetworking归Alamofire Software Foundation所有和维护。
AFNetworking最初由Scott Raymond和Mattt Thompson在开发iPhone应用Gowalla时创建。
AFNetworking的标志由Alan Defibaugh设计。
最重要的是，感谢AFNetworking不断壮大的贡献者名单。
安全披露
如果您认为发现了AFNetworking的安全漏洞，请尽快通过电子邮件报告给 [email protected]。请不要将其发布到公共问题跟踪器。
许可协议
AFNetworking采用MIT许可证发布。有关详情，请参阅LICENSE。