AFNetworking
一、简介
AFNetworking 是对iOS中网络请求方式 NSURLSession 的封装,之前有NSURLConnection,后面已经被废弃。
在分析AFNetworking之前先来介绍一下使用 NSURLSession 发起一次网络请求的步骤:
- 创建NSURLSessionCoftig对象
- 创建NSURLSession对象
- 创建task
- 调用resume开始执行请求
- 代理响应网络事件及数据
二、框架结构
这里分析4.0版本的结构。主要分为五个部分:
1、NSURLSession:网络通信模块,两个文件AFURLSessionManager,AFHTTPSessionManager。AFHTTPSessionManager继承与AFURLSessionManager
2、Reachability 网络状态监听,AFNetworkReachabilityManager
3、Security 网络通讯安全策略模块,AFSecurityPolicy
4、Serialization 序列化,AFURLResponseSerialization,AFURLRequestSerialization
5、UIKit 对于UIKit的扩展库
三、AFHTTPSessionManager 对象初始化过程,中间做了哪些事情
首先来看初始化AFHTTPSessionManager对象的过程,其中需要注意的是[AFHTTPSessionManager manager]方法并不是单例,调用的也是下面的方法返回。在AFHTTPSessionManager中主要做了 1、调用父类初始化方法,2、给URL加'/', 3、给requestSerializer、responseSerializer设置默认值
给url加'/'的目的应该是1、防重发 2、方便在url后面拼接参数。如get请求方式
- (instancetype)initWithBaseURL:(NSURL *)url
sessionConfiguration:(NSURLSessionConfiguration *)configuration
{
self = [super initWithSessionConfiguration:configuration];
if (!self) {
return nil;
}
// Ensure terminal slash for baseURL path, so that NSURL +URLWithString:relativeToURL: works as expected
if ([[url path] length] > 0 && ![[url absoluteString] hasSuffix:@"/"]) {
url = [url URLByAppendingPathComponent:@""];
}
self.baseURL = url;
self.requestSerializer = [AFHTTPRequestSerializer serializer];
self.responseSerializer = [AFJSONResponseSerializer serializer];
return self;
}
下面来看AFURLSessionManager初始化方法。这里就不贴代码了,需要的自己打开AF4.0源码看吧。主要步骤有:
- sessionConfiguration 属性持有 configuration ,若传入configuration为空,设置默认defaultSessionConfiguration。包含缓存策略,ID,超时时间 ...
- 初始化代理方法执行的队列operationQueue,并设置 maxConcurrentOperationCount 值为1。即串行执行
- responseSerializer 解析方式,
- securityPolicy 使用defaultPolicy初始化,https证书校验对象,用来校验服务端安全信任链接
- reachabilityManager 网络状态监听。
- mutableTaskDelegatesKeyedByTaskIdentifier 类型是NSMutableDictionary,key是NSURLSessionTask的唯一NSUInteger类型标识,value是对应的AFURLSessionManagerTaskDelgate对象
- lock ,NSLock类型锁创建,为了保证线程安全
- session对象创建,3.0版本是直接创建。4.0版本是懒加载形式创建,并使用@synchronized互斥锁保证只创建一次
- session 调用getTasksWithCompletionHandler方法获取 之前的task,创建AFURLSessionManagerTaskDelegate。绑定task,并加入mutableTaskDelegatesKeyedByTaskIdentifier字典中
manager的研究先到这里,里面各种配置的具体实现,暂时先不往深处介绍了,下面来看下request的实现方法
request方法解析
- (NSURLSessionDataTask *)dataTaskWithHTTPMethod:(NSString *)method
URLString:(NSString *)URLString
parameters:(nullable id)parameters
headers:(nullable NSDictionary *)headers
uploadProgress:(nullable void (^)(NSProgress *uploadProgress)) uploadProgress
downloadProgress:(nullable void (^)(NSProgress *downloadProgress)) downloadProgress
success:(nullable void (^)(NSURLSessionDataTask *task, id _Nullable responseObject))success
failure:(nullable void (^)(NSURLSessionDataTask * _Nullable task, NSError *error))failure
{
NSError *serializationError = nil;
NSMutableURLRequest *request = [self.requestSerializer requestWithMethod:method URLString:[[NSURL URLWithString:URLString relativeToURL:self.baseURL] absoluteString] parameters:parameters error:&serializationError];
for (NSString *headerField in headers.keyEnumerator) {
[request setValue:headers[headerField] forHTTPHeaderField:headerField];
}
if (serializationError) {
if (failure) {
dispatch_async(self.completionQueue ?: dispatch_get_main_queue(), ^{
failure(nil, serializationError);
});
}
return nil;
}
__block NSURLSessionDataTask *dataTask = nil;
dataTask = [self dataTaskWithRequest:request
uploadProgress:uploadProgress
downloadProgress:downloadProgress
completionHandler:^(NSURLResponse * __unused response, id responseObject, NSError *error) {
if (error) {
if (failure) {
failure(dataTask, error);
}
} else {
if (success) {
success(dataTask, responseObject);
}
}
}];
return dataTask;
}
1、这个过程主要是使用requestSerializer 调用requestWithMethod 或者 multipartFormRequestWithMethod 获取
NSMutableURLRequest 类型的 request 对象。
使用指定的HTTP method和URLString来构建一个NSMutableURLRequest对象实例,如果method是GET、HEAD、DELETE,那parameter将会被用来构建一个基于url编码的查询字符串(query url),并且这个字符串会直接加到request的url后面。对于其他的Method,比如POST/PUT,它们会根据parameterEncoding属性进行编码,而后加到request的http body上。
- (NSMutableURLRequest *)requestWithMethod:(NSString *)method
URLString:(NSString *)URLString
parameters:(id)parameters
error:(NSError *__autoreleasing *)error
在上面这个方法里设置了request的 请求方法,url,遍历mutableObservedChangedKeyPaths中设置的属性并给Request赋值,这里居然用了KVO。之前版本要遍历AFHTTPRequestSerializerObservedKeyPaths()。现在版本直接遍历mutableObservedChangedKeyPaths,一大进步,之前就感觉这个设置很奇怪,终于修改了。
调用[mutableRequest setValue:value forHTTPHeaderField:field]方法设置请求头相关信息。
非HTTPMethodsEncodingParametersInURI的请求先判断request的Content-Type是否设置了,如果没有,就默认设置为application/x-www-form-urlencoded。
在方法 multipartFormRequestWithMethod 中比 requestWithMethod 多了个参数为formData 的 block 对象参数。在方法体里面对formData 进行拼接。然后通过block传出去。此处设计与Masonry框架中block使用方式相同,可以放一块研究一下。
2、调用 dataTaskWithRequest 方法,使用上面的 request 生成 task 对象。
NSURLSessionDataTask *dataTask = [self.session dataTaskWithRequest:request];
[self addDelegateForDataTask:dataTask uploadProgress:uploadProgressBlock downloadProgress:downloadProgressBlock completionHandler:completionHandler];
我要是没记错的话,3.0版本的时候在这里是用一个串行队列创建dataTask,现在串行队列相关代码找不到了。用串行队列来解决iOS8 的一个bug,可能现在已经不用适配iOS8吧
addDelegateForDataTask 方法将初始化一个 AFURLSessionManagerTaskDelegate 对象,delegate 弱引用又持有了 manager, 打破闭环。在delegate中有 进度,回调,存储数据的mutableDate等属性。
在addDelegateForDataTask 中调用 setDelegate:forTask 将task 和 delegate 绑定到一起。
在setDelegate:forTask 方法中 1、将delegate存入字典,以taskid作为key,说明每个task都有各自的代理; 2、设置两个NSProgress的变量 - uploadProgress和downloadProgress,给session task添加了两个KVO事件
设置这两个NSProgress对应的cancel、pause和resume这三个状态,正好对应session task的cancel、suspend和resume三个状态
当NSURLSessionTask调用resume函数时,会postNotificationName:AFNSURLSessionTaskDidResumeNotification,从而执行taskDidResume:方法
在 taskDidResume: 方法中会判断task是否是当前manager管理的,是的话会发送通知AFNetworkingTaskDidResumeNotification
3、task调用resume 执行
resume 方法被 使用 method_exchangeImplementations交换为 af_resume方法。内部发送了AFNSURLSessionTaskDidResumeNotification 通知。