AFNetworking 是一个令人愉快的 iOS 和 Mac OS X 的网络库。它是建立在 Foundation URL 加载系统之上,扩展了 Cocoa 中的强大高级网络抽象。它具有模块化架构,具有设计精良,功能丰富的 API,非常易于使用。
然而,或许最重要的特性是使用和贡献 AFNetworking 的开发者的惊人的社区。AFNetworking 为一些最受欢迎和好评的 iPhone、iPad 和 Mac 应用程序提供支持。
为您的下一个项目选择 AFNetworking,或者迁移您的现有项目——您将为此感到高兴!
如何开始
- 下载 AFNetworking 并尝试包含的 Mac 和 iPhone 示例应用程序
- 阅读 "入门" 指南、常见问题 或 Wiki 上的其他文章
- 查看 文档 以全面了解 AFNetworking 中所有可用的 API
- 阅读 AFNetworking 3.0 迁移指南,了解 2.0 到 3.0 的架构变更概述
沟通
- 如果您 需要帮助,使用 Stack Overflow。 (标签为 'afnetworking')
- 如果您想 提出一个一般性问题,使用 Stack Overflow。
- 如果您 发现了一个 bug,并且可以提供可靠的复现步骤,打开一个 issue。
- 如果您 有一个功能请求,打开一个 issue。
- 如果您 想要贡献,提交一个 pull request。
安装
AFNetworking 支持多种方法在项目中安装库。
使用 CocoaPods 进行安装
CocoaPods 是 Objective-C 的依赖项管理器,它自动化和简化了在项目中使用 AFNetworking 等第三方库的过程。有关更多信息,请参阅"入门指南"。您可以使用以下命令安装它:
$ gem install cocoapods
要构建 AFNetworking 3.0.0+,需要 CocoaPods 0.39.0+。
Podfile
要使用 CocoaPods 将 AFNetworking 集成到您的 Xcode 项目中,请在您的 Podfile
中指定它。
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'
target 'TargetName' do
pod 'AFNetworking', '~> 3.0'
end
然后,运行以下命令:
$ pod install
使用 Carthage 进行安装
Carthage 是一个集中的依赖项管理器,它构建您的依赖关系并为您提供二进制框架。
您可以使用以下命令通过 Homebrew 安装 Carthage:
$ brew update
$ brew install carthage
要将 AFNetworking 集成到您的 Xcode 项目中使用 Carthage,请在您的 Cartfile
中指定它。
github "AFNetworking/AFNetworking" ~> 3.0
运行 carthage
构建框架,然后将构建好的 AFNetworking.framework
拖到您的 Xcode 项目中。
需求
AFNetworking 版本 | 最低 iOS 目标 | 最低 macOS 目标 | 最低 watchOS 目标 | 最低 tvOS 目标 | 备注 |
---|---|---|---|---|---|
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+。子规格 NSURLSession 需要 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 | 不适用 | 不适用 |
(OS X项目必须支持64位现代Cocoa运行时)。
使用Swift进行编程?尝试使用Alamofire以获得更传统的API集合。
架构
NSURLSession
AFURLSessionManager
AFHTTPSessionManager
序列化
AFHTTPRequestSerializer
AFJSONRequestSerializer
AFPropertyListRequestSerializer
AFHTTPResponseSerializer
AFJSONResponseSerializer
AFXMLParserResponseSerializer
AFXMLDocumentResponseSerializer
(Mac OS X)AFPropertyListResponseSerializer
AFImageResponseSerializer
AFCompoundResponseSerializer
附加功能
AFSecurityPolicy
AFNetworkReachabilityManager
用法
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证书添加到您的应用可以帮助您防止中间人攻击和其他漏洞。处理敏感客户数据或金融信息的应用程序被强烈建议将所有通信路由为配置并启用的HTTPS连接,并启用SSL固定。
允许无效的SSL证书
AFHTTPSessionManager *manager = [AFHTTPSessionManager manager];
manager.securityPolicy.allowInvalidCertificates = YES; // not recommended for production
单元测试
AFNetworking在Tests子目录中包含一系列单元测试。可以通过在您想测试的平台框架上执行测试操作来简单地运行这些测试。
鸣谢
AFNetworking由Alamofire软件基金会拥有和维护。
AFNetworking最初由Scott Raymond和Mattt Thompson在开发iPhone上的Gowalla时创建。
AFNetworking的标志由Alan Defibaugh设计。
最重要的是,感谢AFNetworking的不断增长的贡献者名单。
安全披露
如果您认为您已识别出AFNetworking的安全漏洞,应立即通过电子邮件报告给[email protected]。请勿将其发布到公共问题跟踪器。
许可证
AFNetworking在MIT许可证下发布。有关详细信息,请参阅LICENSE。