CGT_Pod_Demo 8.0

CGT_Pod_Demo 8.0

测试已测试
Lang语言 Obj-CObjective C
许可证 MIT
Released最后发布2016年4月

Rahul Bansal 维护。



 
依赖
AFNetworking~> 2.5
AFNetworking+AutoRetry>= 0
MBProgressHUD>= 0
Reachability>= 0
 

  • 作者
  • Rahul Bansal

AFNetworking 是一个用于 iOS 和 Mac OS X 的出色网络库。它建立在 Foundation URL 加载系统之上,扩展了 Cocoa 中内置的强大而高级的网络抽象。它具有模块化架构,API 设计得当,特性丰富,使用起来非常愉快。

然而,最重要的功能也许是无与伦比的开发者社区,他们每天都在使用并贡献 AFNetworking。AFNetworking 为 iPhone、iPad 和 Mac 上的许多最受欢迎和备受欢迎的 APP 提供了动力。

选择 AFNetworking 作为您下一个项目的库,或者将现有项目迁移过来——您会为您的选择而感到高兴的!

如何开始

通讯

  • 如果您 需要帮助,请使用 Stack Overflow。(标签 'afnetworking')
  • 如果您想 提出一个一般性问题,请使用 Stack Overflow
  • 如果您 发现了错误并且可以提供可靠地重现它的步骤,请打开一个问题。
  • 如果您 有功能请求,请打开一个问题。
  • 如果您 想要做出贡献,请提交一个 pull request。

Podfile

platform :ios, '7.0'
pod "AFNetworking", "~> 2.0"

要求

AFNetworking 版本 最低 iOS 目标 最低 OS X 目标 备注
2.x iOS 6 OS X 10.8 需要 Xcode 5。需要 iOS 7 或 OS X 10.9 的子特定 NSURLSession
1.x iOS 5 Mac OS X 10.7
0.10.x iOS 4 Mac OS X 10.6

(OS X项目必须支持带有现代Cocoa运行时的64位)。

用Swift编程?尝试Alamofire,它提供了一组更传统的API。

架构

NSURLConnection

  • AFURLConnectionOperation
  • AFHTTPRequestOperation
  • AFHTTPRequestOperationManager

NSURLSession (iOS 7 / Mac OS X 10.9)

  • AFURLSessionManager
  • AFHTTPSessionManager

序列化

  • <AFURLRequestSerialization>
    • AFHTTPRequestSerializer
    • AFJSONRequestSerializer
    • AFPropertyListRequestSerializer
  • <AFURLResponseSerialization>
    • AFHTTPResponseSerializer
    • AFJSONResponseSerializer
    • AFXMLParserResponseSerializer
    • AFXMLDocumentResponseSerializer (Mac OS X)
    • AFPropertyListResponseSerializer
    • AFImageResponseSerializer
    • AFCompoundResponseSerializer

附加功能

  • AFSecurityPolicy
  • AFNetworkReachabilityManager

用法

HTTP请求操作管理器

AFHTTPRequestOperationManager封装了通过HTTP与Web应用程序通信的常见模式,包括请求创建、响应序列化、网络可达性监控和安全,以及请求操作管理。

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多部分请求

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

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

URL表单参数编码

[[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

JSON参数编码

[[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网络接口域和地址的可达性。

  • 不要使用可达性来判断是否应该发送原始请求。
    • 你应该尝试发送它。
  • 你可以使用可达性来判断何时应该自动重试请求。
    • 尽管它可能还会失败,但当有可达性通知连通性可用时,再次尝试是合适的时间。
  • 网络可达性是确定请求失败原因的有用工具。
    • 在网络请求失败后,告知用户他们线下比提供更技术但准确的错误信息,如“请求超时”要好。

另请参阅WWDC 2012会议706,“网络最佳实践”。.

共享网络可达性

[[AFNetworkReachabilityManager sharedManager] setReachabilityStatusChangeBlock:^(AFNetworkReachabilityStatus status) {
    NSLog(@"Reachability: %@", AFStringFromNetworkReachabilityStatus(status));
}];

[[AFNetworkReachabilityManager sharedManager] startMonitoring];

HTTP管理器可达性

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连接路由所有通信。

允许无效SSL证书

AFHTTPRequestOperationManager *manager = [AFHTTPRequestOperationManager manager];
manager.securityPolicy.allowInvalidCertificates = YES; // not recommended for production

AFHTTPRequestOperation

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 Tests”和“OS X Tests”方案执行测试套件。

从命令行运行测试

测试还可以从命令行或持续集成环境中运行。在运行命令行测试之前,需要安装xcpretty实用程序

$ gem install xcpretty

安装xcpretty后,可以使用rake test执行套件。

鸣谢

AFNetworking由< obtains and manages the software foundation..

AFNetworking最初由Scott RaymondMattt Thompson在开发iPhone上的Gowalla时创建。

AFNetworking的logo是由Alan Defibaugh设计的。

最重要的是,感谢AFNetworking不断增长的贡献者名单.

安全漏洞披露

如果您认为已发现AFNetworking的安全漏洞,请尽快通过电子邮件[email protected]报告。请不要在公开的问题跟踪器上发布。

许可协议

AFNetworking是在MIT许可协议下发布的。详细内容请参阅LICENSE。