AFNetworking 3.0
原文链接:AFNetworking 3.0 Migration Guide
AFNetworking 3.0 是AFNetworking最新发行的版本,一款在 iOS & Mac OS X 下都另开发者喜爱的网络库。为了这个库可维持性发展,3.0 删除了所有支持现在已废弃的 NSURLConnection 的API。如果您的工程之前使用过这些 API,建议您升级到基于NSURLSession的 API,当然这不是必须的,根据自己的情况定。本指南将会指导您完成这一过程。(PS:AFNetworking最新的版本已经更新到3.1.0,详细文档见 AFNetworking 3.1.0)
新的需求环境:iOS 7, Mac OS X 10.9, watchOS 2, tvOS 9, & Xcode 7
AFNetworking 3.0 已正式支持 iOS 7+, Mac OS X 10.9+, watchOS 2+, tvOS 9, and Xcode 7。如果你想使用最新的 AFNetworking 库替换旧版本的库,请移步 README 查看兼容信息。
NSURLConnection的API已废弃
AFNetworking 1.0 是建立在 NSURLConnection
基础上的,AFNetworking 2.0 开始使用基于 NSURLConnection API基础功能,或着基于新的NSURLSession API 的功能。AFNetworking 3.0现在是专门建立在 NSURLSession 顶层的,这降低了维护负担,同时允许支持苹果为 NSURLSession 提供的任何额外的增强的特性。在Xcode 7,NSURLConnection API 已经被苹果官方弃用。然而API函数将继续使用不会受影响,只不过再也不会添加新的功能了,苹果建议所有基于网络的功能在未来都能使用 NSURLSession。
AFNetworking 2.x 系列将继续获得关键的bug修复和安全补丁,但是没有新的功能将被添加进去。Alamofire Software Foundation建议,所有项目将来都要迁移到基于 NSURLSession API。
被移除的类
3.0 被移除的类有:
• AFURLConnectionOperation
• AFHTTPRequestOperation
• AFHTTPRequestOperationManager
被更换的类
下述基于 NSURLConnection 内部实现的类,使用 NSURLSession 时都被重构了:
• UIImageView+AFNetworking
• UIWebView+AFNetworking.h
• UIButton+AFNetworking.h
迁移
AFHTTPRequestOperationManager 基本代码
AFHTTPRequestOperationManager ->AFHTTPSessionManager。
在这些类中有些组件是可重用的,包括:
¶ securityPolicy
¶ requestSerializer
¶ responseSerializer
下述是一个迁移到AFHTTPSessionManager的简单示例。
注意到 HTTP 返回的是 NSURLSessionTask 而不
是 AFHTTPRequestOperation,success and failure blocks 传的参数是 NSURLSessionTask 而不是 AFHTTPRequestOperation
AFNetworking 2.x
AFHTTPRequestOperationManager *manager = [AFHTTPRequestOperationManager manager];
[manager GET:@"请求的url" parameters:nil success:^(AFHTTPRequestOperation *operation, id responseObject) {
NSLog(@"成功");
} failure:^(AFHTTPRequestOperation *operation, NSError*error) {
NSLog(@"失败");
}];
AFNetworking 3.x
AFHTTPSessionManager *manager = [AFHTTPSessionManager manager];
[manager GET:@"http://example.com/resources.json" parameters:nil progress:nil success:^(NSURLSessionTask *task, id responseObject) {
NSLog(@"JSON: %@", responseObject);
} failure:^(NSURLSessionTask *operation, NSError *error) {
NSLog(@"Error: %@", error);
}];
AFHTTPRequestOperation 基本代码
不像 NSURLConnection 对象,这个对象共享了会话管理,缓存策略,cookie存储和URL 协议,而 NSURLSession 对象可以独立的配置这些。一旦会话被特定的配置初始化,他可以分派任务来获取数据,上传或者下载文件。
AFNetworking 2.0,影响了AFHTTPRequestOperation,他有可能会创建一个没有额外开销的单一请求来获取远程数据。NSURLSession 需要稍微多点的开销,为了获得请求本身功能的访问入口。
未来,创建一个单一的请求需要创建一个 AFHTTPSessionManager ,紧接着要创建一个任务并开启这个任务。
AFNetworking 2.x
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];
AFNetworking 3.x
NSURL *URL = [NSURL URLWithString:@"http://example.com/resources/123.json"];
AFHTTPSessionManager *manager = [AFHTTPSessionManager manager];
[manager GET:URL.absoluteString parameters:nil progress:nil success:^(NSURLSessionTask *task, id responseObject) {
NSLog(@"JSON: %@", responseObject);
} failure:^(NSURLSessionTask *operation, NSError *error) {
NSLog(@"Error: %@", error);
}];
注意到,NSURLSession 不是建立在 NSOperation 。
如果你有一个应用程序,很大程度上
依赖于AFURLConnectionOperation NSOperation 方面,那么恭喜你中枪了,你的程序可能会需要额外的重构以便用 NSOperation 的基础方法封装 AFHTTPSessionManager 。
跟踪进度条
AFNetworking 3.0 使用 NSProgress 为 NSURLSessionTasks 跟踪进度。除了基于 AFURLSessionManager 的上传和下载任务 和 基于 AFHTTPSessionManager 的GET和POST方法的 block 便利方法之外,AFURLSessionManager 也为每个任务暴露了辅助方法以便访问 NSProgress 对象:
¶ uploadProgressForTask:
¶ downloadProgressForTask:
使用 KVO,如果响应包含 Content-Length 头,那么每个任务的进度都可以被跟踪。AFNetworking 3.0中关于 progress 更多变化的额外信息请查看 #3187 。
UIKit 迁移
图片下载已经被遵循 AlamofireImage 架构的
新类 AFImageDownloader 重构。UIButton和UIImageView 分类实现将图片下载的责任委托给这个类,并且暴露一些共享的参数用来允许自定义下载,从类接口下载远程图像的实际方法保持不变。
UIWebView类已经被使用一个共享的网络请求 AFHTTPSessionManager 重构。
UIAlertView 分类被移除
AFNetworking 3.0 已经废除了UIAlertView分类,并且未来也没打算支持UIAlertController。