AFNetworking - GitHub README翻译
AFNetworking是一个基于iOS和Mac OS X的备受人们喜爱的网络类库。它是建立在 Foundation URL Loading System之上，将高层网络进行强有力的扩展抽象成了Cocoa。它有一个精心设计的模块结构、各种易用且功能丰富的API。
然而最令人吃惊的不是AFNetworking的这些特点，而是每天都有开发者使用并维护着。AFNetworking应用在iPhone、iPad、mac的App上。
为你下一个项目选择AFNetworking或者将他移植到现有的项目中都会是你受益匪浅。
怎么开始
- 下载AFNetworking并且在mac和iPhone上尝试一些示例App
- 读入门指南、常见问题的解答、或其wiki上的相关文章
- 查看AFNetworking文档中所有可用的API
- 阅读概述AFNetworking从2.0到3.0结构变化的迁移指南
交流
- 如果你需要帮助，用Stack Overflow。
- 如果你想要问问题，用Stack Overflow。
- 如果你发现了一个bug并且可以提供操作步骤复现它，公布这个问题
- 如果你有一个指定的需求，公布它
- 如果你想要投稿，提交一个pull请求
安装
AFNetworking支持在一个项目中安装的多种方法
用Cocoapods安装
CocoaPods依赖objective - c管理,自动化和简化的过程像AFNetworking在你的项目使用第三方库。有关更多信息,请参见“入门”指南。你可以用下面的命令安装:
$ gem install cocoapods
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到你的工程中，指定你的Cartfile文件
github "AFNetworking/AFNetworking" ~> 3.0
运行Carthage 构建framework并且拖动AFNetworking的framework到你的工程中
要求
| AFNetworking 版本 | iOS最低系统 | OS X 最低系统 | watchOS 最低系统 | tvOS 最低系统 | 注释 |
|---|---|---|---|---|---|
| 3.x | iOS 7 | OS X 10.9 | watchOS 2.0 | tvOS 9.0 | 必需xcode7以上 ；NSURLConnectionOperation已经被删除了 |
| 2.6 -> 2.6.3 | iOS 7 | OS X 10.9 | watchOS 2.0 | n/a | 必需xcode7以上 |
| 2.0 -> 2.5.4 | iOS 6 | OS X 10.8 | n/a | n/a | 必需xcode5 以上 |
| 1.x | iOS 5 | Mac OS X 10.7 | n/a | n/a | n/a |
| 0.10.x | iOS 4 | Mac OS X 10.6 | n/a | n/a | n/a |
架构
NSURLSession
- AFURLSessionManager
- AFHTTPSessionManager
Serialization
- <AFURLRequestSerialization>
- AFHTTPRequestSerializer
- AFJSONRequestSerializer
- AFPropertyListRequestSerializer
- <AFURLResponseSerialization>
- AFHTTPResponseSerializer
- AFJSONResponseSerializer
- AFXMLParserResponseSerializer
- AFXMLDocumentResponseSerializer (Mac OS X)
- AFPropertyListResponseSerializer
- AFImageResponseSerializer
- AFCompoundResponseSerializer
Additional Functionality
- AFSecurityPolicy
- AFNetworkReachabilityManager
用法
AFURLSessionManager
AFURLSessionManager创建并管理一个NSURLSession对象，基于一个指定的NSURLSessionConfiguration对象，这个对象要遵循以下协议<NSURLSessionTaskDelegate>, <NSURLSessionDataDelegate>, <NSURLSessionDownloadDelegate>, and <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的body
NSString *URLString = @"http://example.com";
NSDictionary *parameters = @{@"foo": @"bar", @"baz": @[@1, @2, @3]};
查找字符参数编码
[[AFHTTPRequestSerializer serializer] requestWithMethod:@"GET" URLString:URLString parameters:parameters error:nil];
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 监测域名以及IP地址的畅通性，对于WWAN以及WiFi的网络接口都管用。
- 不要用网络可用来确定原始请求是否应该被发送。
- 你可以用网络可用决定当一个请求是否应该自动重试。
- 网络可用性是一个有用的工具来决定一个请求可能会失败的原因。
分享网络可用性
[[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包括一套单元测试中的测试子目录。这些测试可以在平台上运行简单地执行测试活动你想测试框架。
工作人员
AFNetworking 是由Alamofire Software Foundation 所有并维护
AFNetworking 最初是由Scott Raymond和 Mattt Thompson在Gowalla for iPhone 的开发中创建的
AFNetworking的logo是由Alan Defibaugh设计的
最后 谢谢所有为AFNetworking做出贡献的人
安全信息披露
如果你相信你已经确定了一个与AFNetworking安全漏洞,你应该报告尽快通过电子邮件至security@alamofire.org。请不要发布到一个公共问题跟踪器。
证书
AFNetworking MIT许可下发布。有关详细信息,请参阅许可证。
PS:翻译完感觉更不像人话了 哈哈
GitHub原文网址:https://github.com/AFNetworking/AFNetworking
