AFNetworking 是 Objective-C 中用于网络请求的第三方框架,我们一般使用它来封装网络请求,这篇文章记录了阅读 AFNetworking(Version 3.1.0) 源码的笔记,简单的研究了它的实现细节。
AFHTTPSessionManager
AFHTTPSessionManager 继承自 AFURLSessionManager,主要是提供了一系列对外暴露的属性和方法,如下图:
可以看出对外暴露的有:
三个属性:baseURL
、requestSerializer
、responseSerializer
三个初始化方法:
+ (instancetype)manager
- (instancetype)initWithBaseURL:(nullable NSURL *)url
- (instancetype)initWithBaseURL:(nullable NSURL *)url
sessionConfiguration:(nullable NSURLSessionConfiguration *)configuration
还有一系列请求方法:GET
、HEAD
、POST
、PUT
、PATCH
、DELETE
。
初始化与请求方法
其中所有的初始化方法,最后都到initWithBaseURL:
方法里来初始化对象,需要注意的是默认 response 是 JSON 类型的。
- (instancetype)initWithBaseURL:(NSURL *)url
sessionConfiguration:(NSURLSessionConfiguration *)configuration
{
...
self.baseURL = url;
// 默认的 request 和 response
self.requestSerializer = [AFHTTPRequestSerializer serializer];
self.responseSerializer = [AFJSONResponseSerializer serializer];
return self;
}
而所有的请求方法,GET
、HEAD
、POST
、PUT
、PATCH
、DELETE
等最终都是调用的 dataTaskWithHTTPMethod:
方法创建 task,区别是传递的method名称不同,方法体如下:
NSError *serializationError = nil;
// 创建 NSMutableURLRequest
NSMutableURLRequest *request = [self.requestSerializer requestWithMethod:method URLString:[[NSURL URLWithString:URLString relativeToURL:self.baseURL] absoluteString] parameters:parameters error:&serializationError];
...处理构建 request 产生的错误
// 创建 dataTask
__block NSURLSessionDataTask *dataTask = nil;
dataTask = [self dataTaskWithRequest:request
uploadProgress:uploadProgress
downloadProgress:downloadProgress
completionHandler:^(NSURLResponse * __unused response, id responseObject, NSError *error) {
...
}];
return dataTask;
其中先创建 request,再根据 request 创建 dataTask。
NSSecureCoding
@interface AFHTTPSessionManager : AFURLSessionManager <NSSecureCoding, NSCopying>
可以看出 AFHTTPSessionManager 实现了 NSSecureCoding 和 NSCoding 协议,其中 NSSecureCoding 是基于 NSCoding 协议。
NSSecureCoding 是苹果在 iOS6 中引入的一个新协议,基于NSCoding。简单的说就是在数据归档过程加了数据类型检验,相对更安全一点,使用起来需要多实现一个方法:
@protocol NSSecureCoding <NSCoding>
@required
+ (BOOL)supportsSecureCoding;
@end
小结
总的来说 AFHTTPSessionManager 只是在 AFURLSessionManager 的基础上做了一层包装。
AFURLSessionManager
AFURLSessionManager 可以说是 AFNetworking 的核心类,相应的其内部实现也复杂许多,先来看一张图:
AFURLSessionManager.m 内部除了 AFURLSessionManager 的实现外,还包含两个自定义类的实现,AFURLSessionManagerTaskDelegate 主要为 task 提供进度管理功能,_AFURLSessionTaskSwizzling 则是修改 NSURLSessionTask 的 resume
和 suspend
方法,这里还是先从 AFURLSessionManager 初始化开始。
初始化
AFURLSessionManager 的初始化在initWithSessionConfiguration:
方法里进行了一系列的配置:
// 默认为 defaultSessionConfiguration
if (!configuration) {
configuration = [NSURLSessionConfiguration defaultSessionConfiguration];
}
self.sessionConfiguration = configuration;
// 初始化代理队列
self.operationQueue = [[NSOperationQueue alloc] init];
self.operationQueue.maxConcurrentOperationCount = 1;
// 初始化 session
self.session = [NSURLSession sessionWithConfiguration:self.sessionConfiguration delegate:self delegateQueue:self.operationQueue];
// 初始化 response 序列,默认为 JSON
self.responseSerializer = [AFJSONResponseSerializer serializer];
// AFSecurityPolicy 是 AFNetworking 用来保证 HTTP 请求安全的类,它被 AFURLSessionManager 持有
self.securityPolicy = [AFSecurityPolicy defaultPolicy];
#if !TARGET_OS_WATCH
self.reachabilityManager = [AFNetworkReachabilityManager sharedManager];
#endif
// 初始化用来存放 AFURLSessionManagerTaskDelegate 的字典
self.mutableTaskDelegatesKeyedByTaskIdentifier = [[NSMutableDictionary alloc] init];
// 初始化 NSLock
self.lock = [[NSLock alloc] init];
self.lock.name = AFURLSessionManagerLockName;
...为已有的 task 设置代理
创建 NSURLSessionTask
创建 NSURLSessionTask 的方法有以下三种:
dataTaskWithRequest:
uploadTaskWithRequest:
downloadTaskWithRequest:
这里以 dataTaskWithRequest:
方法为例,可以看出其是用 NSURLSession 的 dataTaskWithRequest:
方法创建出 dataTask。
__block NSURLSessionDataTask *dataTask = nil;
// 解决iOS8之前的一个bug
url_session_manager_create_task_safely(^{
// 用NSURLSession创建NSURLSessionDataTask
dataTask = [self.session dataTaskWithRequest:request];
});
// 给data task添加了一个AFURLSessionManagerTaskDelegate
// 主要为 task 提供进度管理功能
[self addDelegateForDataTask:dataTask uploadProgress:uploadProgressBlock downloadProgress:downloadProgressBlock completionHandler:completionHandler];
return dataTask;
需要注意的是在创建完 dataTask 之后,又通过 addDelegateForDataTask:
方法给 dataTask 添加了一个 AFURLSessionManagerTaskDelegate,这个 delegate 主要为 dataTask 提供上传下载的进度管理功能。
NSURLSession 相关的代理方法
@interface AFURLSessionManager : NSObject <NSURLSessionDelegate, NSURLSessionTaskDelegate, NSURLSessionDataDelegate, NSURLSessionDownloadDelegate, NSSecureCoding, NSCopying>
AFURLSessionManager 遵循并实现了一系列 NSURLSession 相关的代理方法,不过 AFURLSessionManager 为所有的代理协议都提供了对应的 block 接口,这样不让用户自己实现相关方法,对外只暴露出 block。这里举个🌰:
- (void)URLSession:(NSURLSession *)session
didBecomeInvalidWithError:(NSError *)error
{
if (self.sessionDidBecomeInvalid) {
self.sessionDidBecomeInvalid(session, error);
}
[[NSNotificationCenter defaultCenter] postNotificationName:AFURLSessionDidInvalidateNotification object:session];
}
可以看出在以上方法中,用户只需要调用这个 block, 就可以用来处理session无效的情况,这么做隐藏了细节,简化了调用。
AFURLSessionManagerTaskDelegate
AFURLSessionManagerTaskDelegate 继承自 NSObject,主要作用是为 dataTask 提供进度管理功能。
需要注意的是在 AFURLSessionManagerTaskDelegate 的 setupProgressForTask
方法中将 NSProgress 和 NSURLSessionTask 进行了状态绑定,代码如下:
/*
上传的totalUnitCount就对应期望发送(send)的数据大小,下载任务的就对应期望接收(receive)的数据大小。
接着就是设置这两个NSProgress对应的cancel、pause和resume这三个状态,正好对应session task的cancel、suspend和resume三个状态
*/
self.uploadProgress.totalUnitCount = task.countOfBytesExpectedToSend;
self.downloadProgress.totalUnitCount = task.countOfBytesExpectedToReceive;
[self.uploadProgress setCancellable:YES];
[self.uploadProgress setCancellationHandler:^{
__typeof__(weakTask) strongTask = weakTask;
[strongTask cancel];
}];
[self.uploadProgress setPausable:YES];
[self.uploadProgress setPausingHandler:^{
__typeof__(weakTask) strongTask = weakTask;
[strongTask suspend];
}];
if ([self.uploadProgress respondsToSelector:@selector(setResumingHandler:)]) {
[self.uploadProgress setResumingHandler:^{
__typeof__(weakTask) strongTask = weakTask;
[strongTask resume];
}];
}
[self.downloadProgress setCancellable:YES];
[self.downloadProgress setCancellationHandler:^{
__typeof__(weakTask) strongTask = weakTask;
[strongTask cancel];
}];
[self.downloadProgress setPausable:YES];
[self.downloadProgress setPausingHandler:^{
__typeof__(weakTask) strongTask = weakTask;
[strongTask suspend];
}];
if ([self.downloadProgress respondsToSelector:@selector(setResumingHandler:)]) {
[self.downloadProgress setResumingHandler:^{
__typeof__(weakTask) strongTask = weakTask;
[strongTask resume];
}];
}
// 给两个progress添加KVO NSProgress的fractionCompleted属性(任务已经完成的比例,取值为0~1)
[self.downloadProgress addObserver:self
forKeyPath:NSStringFromSelector(@selector(fractionCompleted))
options:NSKeyValueObservingOptionNew
context:NULL];
[self.uploadProgress addObserver:self
forKeyPath:NSStringFromSelector(@selector(fractionCompleted))
options:NSKeyValueObservingOptionNew
context:NULL];
_AFURLSessionTaskSwizzling
_AFURLSessionTaskSwizzling
的唯一功能就是修改 NSURLSessionTask 的 resume
和 suspend
方法,使用 af_resume
、af_suspend
替换原有的实现,主要实现是在 +load
方法中实现了 method swizzling。
总结
本文只列举了一些主要的知识点,详细的可以看源码注释。