本篇文章介绍传说中的 AFN 框架的使用
AFNetworking是iOS开发中最广泛使用的开源项目之一,是最活跃最有影响力的开源项目之一。
源自一个LBS项目,成功代替了ASIHTTPRequest成为了主流的网络解决方案。
AFN将NSURLConnection与NSOperation结合(内部使用GCD),并在2.0版本开始兼容NSURLSession
使用AFN发送请求可以使用两种方式:
AFHTTPRequestOperationManager和AFURessionManager
如果是数据任务推荐使用第一种,如果是下载/上传任务推荐使用第二种
这个类的对象,能够非常方便的创建并发起各种HTTP请求
对象的创建:
+ (instancetype)manager
1)发起GET请求:
- (nullable AFHTTPRequestOperation *)GET:(NSString *)URLString parameters:(nullable id)parameters success:(nullable void ( ^ ) ( AFHTTPRequestOperation *operation , id responseObject ))success failure:(nullable void ( ^ ) ( AFHTTPRequestOperation *operation , NSError *error ))failure
参数URLString:请求的url
参数parameters:参数字典,GET请求的参数可以放在URL中也可以放在这里
使用@{key1:value1, key2:value2, ...} 代理 key1=value1&key2=value2&...
参数success:请求成功时,执行的block
参数failure:请求失败时,执行的block
返回值:AFHTTPRequestOperation请求任务对象
如:
或将参数放在parameters参数上
2)发起POST请求
- (nullable AFHTTPRequestOperation *)POST:(NSString *)URLString parameters:(nullable id)parameters success:(nullable void ( ^ ) ( AFHTTPRequestOperation *operation , id responseObject ))success failure:(nullable void ( ^ ) ( AFHTTPRequestOperation *operation , NSError *error ))failure
如:
功能一:完成请求对象的功能
使用AFHTTPRequestOperationManager发送请求参数是NSURL而不是NSURLRequest;之前介绍过,NSURLRequest中并不仅仅是NSURL,还可以:设置请求头参数、设置缓存策略、设置请求超时等
这些功能由请求对象的序列化工具对象完成
功能二:请求的参数自动序列化
除了完成这些本属于NSURLRequest的任务外,还能实现将请求的参数(URL参数及请求体参数)进行序列化,由于很少服务器上请求要求传递JSON/XML数据,所以这个功能很少使用
父类:AFHTTPRequestSerializer
子类:AFJSONRequestSerializer(默认) AFPropertyListRequestSerializer ...
1)设置请求头的参数
- (void)setValue:(nullable NSString *)valueforHTTPHeaderField:(NSString *)field
- (nullable NSString *)valueForHTTPHeaderField:(NSString *)field
@property (readonly, nonatomic, strong) NSDictionary *HTTPRequestHeaders
如:发送GET请求获得用户信息,要求传入header参数 Authorization=tokenID xxxxxx
2)设置缓存策略
@property (nonatomic, assign) NSURLRequestCachePolicy cachePolicy
3)通过序列化工具,可以设置请求超时
@property (nonatomic, assign) NSTimeInterval timeoutInterval
功能一:将响应数据反序列化
也就是说,如果接受到一个JSON数据,它能帮助我们直接反序列化为OC基本数据对象
功能二:通过一些属性的设定,可以限制接收哪些想要的响应数据
父类:AFHTTPResponseSerializer
子类:AFJSONResponseSerializer AFPropertyListResponseSerializer AFImageResponseSerializer
AFXMLParserResponseSerializer AFXMLDocumentResponseSerializer
默认是AFJSONResponseSerializer,因为大多数的请求都是JSON类型
1)设置能够正确接收的响应数据类型(MIMETYPE):
@property (nonatomic, copy, nullable) NSSet *acceptableContentTypes
2)设置能够正确接收的状态码:
@property (nonatomic, copy, nullable) NSIndexSet *acceptableStatusCodes
提供了对NSURLSession操作的封装
创建数据任务:
- (NSURLSessionDataTask *)dataTaskWithRequest:(NSURLRequest *)request completionHandler:(nullable void ( ^ ) ( NSURLResponse *response , id responseObject , NSError *error ))completionHandler
manager的属性:
// 完成block执行所在任务队列
@property (nonatomic, strong, nullable) dispatch_queue_t completionQueue
// 请求执行所在任务队列
@property (readonly, nonatomic, strong) NSOperationQueue *operationQueue
// 响应对象的序列化工具
@property (nonatomic, strong) id responseSerializer
...
下载任务及上传任务在后面的文章介绍
用于方便地管理状态栏上的网络活动指示器
获得全局对象:
+ (instancetype)sharedManager
网络活动指示器的显示状态:
@property (nonatomic, assign, getter=isEnabled) BOOL enabled
@property (readonly, nonatomic, assign) BOOL isNetworkActivityIndicatorVisible
为了方便正确地控制指示器状态,在管理对象中包含一个整型的引用计数,当>0时显示,==0时不显示
在发起网络请求前,使用下面的方法,对引用计数+1:
- (void)incrementActivityCount
在完成网络请求后,使用下面的方法,对引用计数-1:
- (void)decrementActivityCount
用于检测网络的可达性,如:
[[AFNetworkReachabilityManager sharedManager] startMonitoring];
[[AFNetworkReachabilityManager sharedManager] setReachabilityStatusChangeBlock:^(AFNetworkReachabilityStatus status) {
switch (status) {
case AFNetworkReachabilityStatusNotReachable:
NSLog(@"无网络"); break;
case AFNetworkReachabilityStatusReachableViaWiFi:
NSLog(@"WiFi网络”); break;
case AFNetworkReachabilityStatusReachableViaWWAN:
NSLog(@"无线网络”); break;
default:
break;
}
}];
AFN框架和SDWebImage类似,也提供了很多UI控件的分类
所有的单例都是用dispatch_once创建,保证只执行一次
block中对self关键字的访问,如代码段:
__weak __typeof(self)weakSelf = self;
self.backgroundTaskIdentifier = [application beginBackgroundTaskWithExpirationHandler:^{
__strong __typeof(weakSelf)strongSelf = weakSelf;
}];
第一个weakSelf是为了block中不持有self,避免出现循环引用
第二个strongSelf是为了保证在block执行过程中,这个self不会被释放
AFURLRequestOperation继承自NSOperation,描述网络请求任务对象
管理着NSURLConnection,并实现了其代理方法
AFHTTPRequestOperation又是AFURLRequestOperation的子类
包含请求任务成功或失败时需要执行的block(实际上这些block是在代理方法中被调用)
AFHTTPRequestOperationManager用于快速创建AFHTTPRequestOperation并添加到任务队列中
AFURLRequestSerialization用于帮助构建NSURLRequest
格式化参数:
一般我们请求都会按key=value的方式带上各种参数,GET方法参数直接加在URL上,POST方法放在body上,NSURLRequest没有封装好这个参数的解析,只能我们自己拼好字符串。AFNetworking提供了接口,让参数可以是NSDictionary, NSArray, NSSet这些类型,再由内部解析成字符串后赋给NSURLRequest。
转化过程大致是这样的: