AFNetWorking-WithoutUIKit
AFNetworking 是一款功能强大的网络访问库,适用于 iOS、macOS、watchOS 和 tvOS。它基于 Foundation URL 加载系统,扩展了 Cocoa 中内置的高层网络抽象。它具有模块化架构,拥有精心设计的API,功能丰富,易于使用。
然而,最重要的功能可能是由使用和贡献 AFNetworking 的庞大开发者社区。AFNetworking 为一些在 iPhone、iPad 和 Mac 上最受欢迎和好评的应用程序提供支持。
选择 AFNetworking 作为您下一个项目的工具,或迁移现有的项目,您将乐在其中!
如何开始使用
- 下载 AFNetworking 并尝试包含的 Mac 和 iPhone 示例应用程序
- 阅读 "开始使用" 指南,常见问题解答 或 Wiki 上的其他文章
- 请查看 文档 了解 AFNetworking 中所有可用的 API
- 阅读 AFNetworking 3.0 迁移指南 了解从 2.0 版本到架构变更的概述
通讯
- 如果您 需要帮助,请使用 Stack Overflow。 (标签 'afnetworking')
- 如果您想Stack Overflow上的通用问题,请使用它。
- 如果您发现了一个真实的错误并且能够提供可靠复现步骤,请 在问题中录入该错误。
- 如果您有一个功能请求,请 在问题中提出该请求。
- 如果您希望做出贡献,请提交一个 请求。
安装
AFNetworking支持多种方法将库安装在项目中。
使用CocoaPods安装
CocoaPods 是一个用于Objective-C的依赖关系管理器,它简化了在项目中使用AFNetworking等第三方库的过程。有关更多信息,请参阅“入门”指南。使用以下命令安装CocoaPods:
$ gem install cocoapods
CocoaPods 0.39.0+是需要构建AFNetworking 3.0.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
要使用Carthage将AFNetworking集成到您的Xcode项目中,请在您的
github "AFNetworking/AFNetworking" ~> 3.0
运行carthage
构建框架,然后将构建好的
需求
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` 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
AFURLSessionManager
AFHTTPSessionManager
序列化
<AFURLRequestSerialization>
AFHTTPRequestSerializer
AFJSONRequestSerializer
AFPropertyListRequestSerializer
<AFURLResponseSerialization>
AFHTTPResponseSerializer
AFJSONResponseSerializer
AFXMLParserResponseSerializer
AFXMLDocumentResponseSerializer
(macOS)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网络接口的域和地址的可达性。
- 不要使用可达性来决定是否发送原始请求。
- 你应该尝试发送它。
- 你可以使用可达性来确定何时自动重试请求。
- 即使它可能仍然失败,连接可用的可达性通知是一个重试请求的好时机。
- 网络可达性是用来确定请求失败原因的有用工具。
- 在网络请求失败后,告诉用户他们处于离线状态,比给他们一个更技术但更准确错误,如“请求超时”,要好。
共享网络可达性
[[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 软件基金会 拥有和维护。
AFNetworking 最初由 Scott Raymond 和 Mattt Thompson 在开发 iPhone 版 Gowalla 时创建。
AFNetworking 的标志由 Alan Defibaugh 设计。
最重要的是,感谢 AFNetworking 的贡献者名单正在不断增长。
安全公告
如果您认为您已发现AFNetworking的安全漏洞,请尽快通过电子邮件报告,发送至 [邮箱地址受保护]。请勿将其发布到公共问题跟踪器。
许可证
AFNetworking在MIT许可证下发布。有关详细信息,请参阅LICENSE。