测试已测试 | ✗ |
语语言 | Obj-CObjective C |
许可证 | MIT |
发布最后一次发布 | 2016 年 8 月 |
由 gaoxiao228 维护。
AFNetworking 是一个令人愉悦的 iOS 和 Mac OS X 网络库。它建立在 Foundation URL 加载系统之上,扩展了 Cocoa 内置的强大高级网络抽象。它拥有精心设计的、功能丰富的 API,使用起来非常愉快。
然而,所有特性中最重要的是,AFNetworking 拥有令人叹为观止的开发者社区,他们每天都在使用和贡献 AFNetworking。AFNetworking 为 iPhone、iPad 和 Mac 上的一些最受欢迎和备受好评的应用程序提供了支持。
为您的下一个项目选择 AFNetworking,或将现有项目迁移到 AFNetworking——您会为此感到高兴的!
CocoaPods 是 Objective-C 的依赖项管理器,它自动化并简化了将第三方库(如 AFNetworking)添加到项目中的过程。有关更多信息,请参阅 "入门"指南。
platform :ios, '7.0'
pod "AFNetworking", "~> 2.0"
AFNetworking 版本 | 最小 iOS 目标 | 最小 OS X 目标 | 注意 |
---|---|---|---|
2.x | 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 位 Modern Cocoa 运行时)。
使用 Swift 进行编程?试试 Alamofire,它可以提供更传统的一组 API。
AFURLConnectionOperation
AFHTTPRequestOperation
AFHTTPRequestOperationManager
AFURLSessionManager
AFHTTPSessionManager
<AFURLRequestSerialization>
AFHTTPRequestSerializer
AFJSONRequestSerializer
AFPropertyListRequestSerializer
<AFURLResponseSerialization>
AFHTTPResponseSerializer
AFJSONResponseSerializer
AFXMLParserResponseSerializer
AFXMLDocumentResponseSerializer
(Mac OS X)AFPropertyListResponseSerializer
AFImageResponseSerializer
AFCompoundResponseSerializer
AFSecurityPolicy
AFNetworkReachabilityManager
AFHTTPRequestOperationManager
封装了通过 HTTP 与网络应用程序通信的常见模式,包括请求创建、响应序列化、网络可达性监控和安全,以及请求操作管理。
GET
请求AFHTTPRequestOperationManager *manager = [AFHTTPRequestOperationManager manager];
[manager GET:@"http://example.com/resources.json" parameters:nil success:^(AFHTTPRequestOperation *operation, id responseObject) {
NSLog(@"JSON: %@", responseObject);
} failure:^(AFHTTPRequestOperation *operation, NSError *error) {
NSLog(@"Error: %@", error);
}];
POST
URL-Form-Encoded 请求AFHTTPRequestOperationManager *manager = [AFHTTPRequestOperationManager manager];
NSDictionary *parameters = @{@"foo": @"bar"};
[manager POST:@"http://example.com/resources.json" parameters:parameters success:^(AFHTTPRequestOperation *operation, id responseObject) {
NSLog(@"JSON: %@", responseObject);
} failure:^(AFHTTPRequestOperation *operation, NSError *error) {
NSLog(@"Error: %@", error);
}];
POST
Multi-Part 请求AFHTTPRequestOperationManager *manager = [AFHTTPRequestOperationManager manager];
NSDictionary *parameters = @{@"foo": @"bar"};
NSURL *filePath = [NSURL fileURLWithPath:@"file://path/to/image.png"];
[manager POST:@"http://example.com/resources.json" parameters:parameters constructingBodyWithBlock:^(id<AFMultipartFormData> formData) {
[formData appendPartWithFileURL:filePath name:@"image" error:nil];
} success:^(AFHTTPRequestOperation *operation, id responseObject) {
NSLog(@"Success: %@", responseObject);
} failure:^(AFHTTPRequestOperation *operation, NSError *error) {
NSLog(@"Error: %@", error);
}];
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]];
NSProgress *progress = nil;
NSURLSessionUploadTask *uploadTask = [manager uploadTaskWithStreamedRequest:request progress:&progress completionHandler:^(NSURLResponse *response, id responseObject, NSError *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://example.com/upload"];
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
[[AFHTTPRequestSerializer serializer] requestWithMethod:@"POST" URLString:URLString parameters:parameters];
POST http://example.com/
Content-Type: application/x-www-form-urlencoded
foo=bar&baz[]=1&baz[]=2&baz[]=3
[[AFJSONRequestSerializer serializer] requestWithMethod:@"POST" URLString:URLString parameters:parameters];
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));
}];
NSURL *baseURL = [NSURL URLWithString:@"http://example.com/"];
AFHTTPRequestOperationManager *manager = [[AFHTTPRequestOperationManager alloc] initWithBaseURL:baseURL];
NSOperationQueue *operationQueue = manager.operationQueue;
[manager.reachabilityManager setReachabilityStatusChangeBlock:^(AFNetworkReachabilityStatus status) {
switch (status) {
case AFNetworkReachabilityStatusReachableViaWWAN:
case AFNetworkReachabilityStatusReachableViaWiFi:
[operationQueue setSuspended:NO];
break;
case AFNetworkReachabilityStatusNotReachable:
default:
[operationQueue setSuspended:YES];
break;
}
}];
[manager.reachabilityManager startMonitoring];
AFSecurityPolicy
评估服务器信任与安全连接上的固定 X.509 证书和公钥。
将固定 SSL 证书添加到您的应用程序可以帮助防止中间人攻击和其他漏洞。强烈建议处理敏感客户数据或财务信息的应用程序使用已配置和启用 SSL 固定的 HTTPS 连接进行所有通信。
AFHTTPRequestOperationManager *manager = [AFHTTPRequestOperationManager manager];
manager.securityPolicy.allowInvalidCertificates = YES; // not recommended for production
AFHTTPRequestOperation
是一个用于 HTTP 或 HTTPS 协议请求的 AFURLConnectionOperation
的子类。它封装了可接受的状态代码和内容类型的概念,这些决定了请求的成功或失败。
虽然通常使用 AFHTTPRequestOperationManager
来处理请求是最好的方法,但也可以单独使用 AFHTTPRequestOperation
。
AFHTTPRequestOperation
进行 GET
NSURL *URL = [NSURL URLWithString:@"http://example.com/resources/123.json"];
NSURLRequest *request = [NSURLRequest requestWithURL:URL];
AFHTTPRequestOperation *op = [[AFHTTPRequestOperation alloc] initWithRequest:request];
op.responseSerializer = [AFJSONResponseSerializer serializer];
[op setCompletionBlockWithSuccess:^(AFHTTPRequestOperation *operation, id responseObject) {
NSLog(@"JSON: %@", responseObject);
} failure:^(AFHTTPRequestOperation *operation, NSError *error) {
NSLog(@"Error: %@", error);
}];
[[NSOperationQueue mainQueue] addOperation:op];
NSMutableArray *mutableOperations = [NSMutableArray array];
for (NSURL *fileURL in filesToUpload) {
NSURLRequest *request = [[AFHTTPRequestSerializer serializer] multipartFormRequestWithMethod:@"POST" URLString:@"http://example.com/upload" parameters:nil constructingBodyWithBlock:^(id<AFMultipartFormData> formData) {
[formData appendPartWithFileURL:fileURL name:@"images[]" error:nil];
}];
AFHTTPRequestOperation *operation = [[AFHTTPRequestOperation alloc] initWithRequest:request];
[mutableOperations addObject:operation];
}
NSArray *operations = [AFURLConnectionOperation batchOfRequestOperations:@[...] progressBlock:^(NSUInteger numberOfFinishedOperations, NSUInteger totalNumberOfOperations) {
NSLog(@"%lu of %lu complete", numberOfFinishedOperations, totalNumberOfOperations);
} completionBlock:^(NSArray *operations) {
NSLog(@"All operations in batch complete");
}];
[[NSOperationQueue mainQueue] addOperations:operations waitUntilFinished:NO];
AFNetworking 在 Tests 子目录中包含一系列单元测试。要运行单元测试,您必须通过 CocoaPods 安装测试依赖项。
$ cd Tests
$ pod install
安装测试依赖项后,您可以通过 Xcode 中的 'iOS 测试' 和 'OS X 测试' 方案执行测试套件。
测试也可以从命令行或持续集成环境中运行。在从命令行运行测试之前,需要安装 xcpretty
工具。
$ gem install xcpretty
安装 xcpretty
后,您可以通过 rake test
命令执行整个测试套件。
AFNetworking 由 Alamofire 软件基金会 所有并维护。
AFNetworking 最初由 Scott Raymond 和 Mattt Thompson 在开发Gowalla for iPhone 时创建。
AFNetworking 的标志由 Alan Defibaugh 设计。
最重要的是,感谢 AFNetworking 的不断增长的贡献者名单。
如果您认为您已发现AFNetworking的安全漏洞,请尽快通过电子邮件报告,电子邮箱地址为:[email protected]。请勿将其发布到公开问题跟踪器。
AFNetworking遵循MIT许可证发布。详情请查看LICENSE。