AFNetworking 的核心类是 AFHTTPSessionManager,负责各类 HTTP 请求的发起和处理,它继承自 AFURLSessionManager,是各类请求的直接执行者。javascript
初始化方法主要接收 baseURL 和 sessionConfiguration 两个参数。java
其中对于 baseURL,初始化方法进行了以下判断json
if ([[url path] length] > 0 && ![[url absoluteString] hasSuffix:@"/"]) {
url = [url URLByAppendingPathComponent:@""];
}
复制代码
这样判断的缘由是,对于一个形如 "www.baidu.com/foo" 格式的 baseURL,若是末尾不带正斜杠,则当调用 URLWithString:relativeToURL: 方法,对诸如 "text" 的 path 添加完整路径时,会获得 ""www.baidu.com/text" 的结果,因此须要调用 URLByAppendingPathComponent
,这个方法的说明讲到了若是原始 url 非空字符串且末尾不带正斜杠,而新的 url 开头也不带正斜杠,则方法会在中间插入正斜杠。数组
If the original URL does not end with a forward slash and pathComponent does not begin with a forward slash, a forward slash is inserted between the two parts of the returned URL, unless the original URL is the empty string.缓存
对于 configuration,AFHTTPSessionManager 交给了父类 AFURLSessionManager 执行,具体操做包含以下服务器
- (instancetype)initWithSessionConfiguration:(NSURLSessionConfiguration *)configuration {
self = [super init];
if (!self) {
return nil;
}
if (!configuration) {
configuration = [NSURLSessionConfiguration defaultSessionConfiguration];
}
self.sessionConfiguration = configuration;
// 初始化操做队列,并设置为串行队列
self.operationQueue = [[NSOperationQueue alloc] init];
self.operationQueue.maxConcurrentOperationCount = 1;
// 默认的响应序列化器为 JSON 序列化器
self.responseSerializer = [AFJSONResponseSerializer serializer];
// 初始化 SSL 所需的 securityPolicy
self.securityPolicy = [AFSecurityPolicy defaultPolicy];
#if !TARGET_OS_WATCH
self.reachabilityManager = [AFNetworkReachabilityManager sharedManager];
#endif
// task 的 id 做为 key,代理对象做为 value
self.mutableTaskDelegatesKeyedByTaskIdentifier = [[NSMutableDictionary alloc] init];
self.lock = [[NSLock alloc] init];
self.lock.name = AFURLSessionManagerLockName;
__weak typeof(self) weakSelf = self;
// 获取全部的 task,设置一遍 delegate
[self.session getTasksWithCompletionHandler:^(NSArray *dataTasks, NSArray *uploadTasks, NSArray *downloadTasks) {
__strong typeof(weakSelf) strongSelf = weakSelf;
for (NSURLSessionDataTask *task in dataTasks) {
[strongSelf addDelegateForDataTask:task uploadProgress:nil downloadProgress:nil completionHandler:nil];
}
for (NSURLSessionUploadTask *uploadTask in uploadTasks) {
[strongSelf addDelegateForUploadTask:uploadTask progress:nil completionHandler:nil];
}
for (NSURLSessionDownloadTask *downloadTask in downloadTasks) {
[strongSelf addDelegateForDownloadTask:downloadTask progress:nil destination:nil completionHandler:nil];
}
}];
return self;
}
复制代码
对于序列化器,AFHTTPSessionManager 初始化方法里也指定了默认对象。cookie
// 请求序列化器用 AFHTTPRequestSerializer,响应序列化器用 AFJSONResponseSerializer
self.requestSerializer = [AFHTTPRequestSerializer serializer];
self.responseSerializer = [AFJSONResponseSerializer serializer];
复制代码
这里以 GET 为例,发起一次 GET 请求的具体过程能够分为发起请求和处理响应两步,下面详细说明。网络
AFHTTPSessionManager 支持建立 GET、HEAD、POST、PUT、PATCH、DELETE 等请求,其中 GET 请求支持如下方法发起session
- (nullable NSURLSessionDataTask *)GET:(NSString *)URLString
parameters:(nullable id)parameters
success:(nullable void (^)(NSURLSessionDataTask *task, id _Nullable responseObject))success
failure:(nullable void (^)(NSURLSessionDataTask * _Nullable task, NSError *error))failure DEPRECATED_ATTRIBUTE;
- (nullable NSURLSessionDataTask *)GET:(NSString *)URLString
parameters:(nullable id)parameters
progress:(nullable void (^)(NSProgress *downloadProgress))downloadProgress
success:(nullable void (^)(NSURLSessionDataTask *task, id _Nullable responseObject))success
failure:(nullable void (^)(NSURLSessionDataTask * _Nullable task, NSError *error))failure DEPRECATED_ATTRIBUTE;
- (nullable NSURLSessionDataTask *)GET:(NSString *)URLString
parameters:(nullable id)parameters
headers:(nullable NSDictionary <NSString *, NSString *> *)headers
progress:(nullable void (^)(NSProgress *downloadProgress))downloadProgress
success:(nullable void (^)(NSURLSessionDataTask *task, id _Nullable responseObject))success
failure:(nullable void (^)(NSURLSessionDataTask * _Nullable task, NSError *error))failure;
复制代码
最终调用到的方法都是第三个方法,在这个方法里 HTTPSessionManager 建立了一个 HTTP 类型的 dataTask,并发起请求。并发
- (NSURLSessionDataTask *)GET:(NSString *)URLString
parameters:(id)parameters
headers:(nullable NSDictionary <NSString *, NSString *> *)headers
progress:(void (^)(NSProgress * _Nonnull))downloadProgress
success:(void (^)(NSURLSessionDataTask * _Nonnull, id _Nullable))success
failure:(void (^)(NSURLSessionDataTask * _Nullable, NSError * _Nonnull))failure
{
NSURLSessionDataTask *dataTask = [self dataTaskWithHTTPMethod:@"GET"
URLString:URLString
parameters:parameters
headers:headers
uploadProgress:nil
downloadProgress:downloadProgress
success:success
failure:failure];
[dataTask resume];
return dataTask;
}
复制代码
而在 dataTaskWithHTTPMethod 方法里,则作了如下事情
- (NSURLSessionDataTask *)dataTaskWithHTTPMethod:(NSString *)method
URLString:(NSString *)URLString
parameters:(id)parameters
headers:(NSDictionary <NSString *, NSString *> *)headers
uploadProgress:(nullable void (^)(NSProgress *uploadProgress)) uploadProgress
downloadProgress:(nullable void (^)(NSProgress *downloadProgress)) downloadProgress
success:(void (^)(NSURLSessionDataTask *, id))success
failure:(void (^)(NSURLSessionDataTask *, NSError *))failure
{
NSError *serializationError = nil;
// 1. 设置 request 属性以及参数
NSMutableURLRequest *request = [self.requestSerializer requestWithMethod:method URLString:[[NSURL URLWithString:URLString relativeToURL:self.baseURL] absoluteString] parameters:parameters error:&serializationError];
// 2. 设置 header
for (NSString *headerField in headers.keyEnumerator) {
[request addValue:headers[headerField] forHTTPHeaderField:headerField];
}
// 3. 序列化失败回调
if (serializationError) {
if (failure) {
dispatch_async(self.completionQueue ?: dispatch_get_main_queue(), ^{
failure(nil, serializationError);
});
}
return nil;
}
// 4. 传给 URLSessionManager 建立 dataTask
__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;
}
复制代码
requestWithMethod:URLString:parameters:error:
方法主要作了建立和配置 Request 的工做,具体来讲包括
其中能设置的 request 具体做用以下
具体到 AFNetworking 中,是利用了 KVO 特性,将一系列 set 方法手动触发 KVO,而后对于触发过设置方法的属性,均加入到了mutableObservedChangedKeyPaths 集合中,建立 request 时会针对设置过的属性,设置相对应的属性
for (NSString *keyPath in AFHTTPRequestSerializerObservedKeyPaths()) {
// 只有设置过此属性,才会触发 KVO,mutableObservedChangedKeyPaths 这个 set 里才有此属性
if ([self.mutableObservedChangedKeyPaths containsObject:keyPath]) {
[mutableRequest setValue:[self valueForKeyPath:keyPath] forKey:keyPath];
}
}
复制代码
编码参数用到了 AFURLRequestSerialization 协议类的 requestBySerializingRequest:withParameters:error:
方法,而 HTTPSessionManager 用到的 AFHTTPRequestSerializer 则实现了此方法,主要作了几件事
首先是设置一些默认 header,目前包含如下两个键值对
{
"Accept-Language" = "en;q=1";
"User-Agent" = "iOS Example/1.0 (iPhone; iOS 11.3; Scale/3.00)";
}
复制代码
其次是编码 query,AFNetworking 接受的字典类型的参数做为编码 query 的数据,编码过程以下
NSString *query = nil;
if (parameters) {
if (self.queryStringSerialization) {
NSError *serializationError;
query = self.queryStringSerialization(request, parameters, &serializationError);
if (serializationError) {
if (error) {
*error = serializationError;
}
return nil;
}
} else {
switch (self.queryStringSerializationStyle) {
case AFHTTPRequestQueryStringDefaultStyle:
// 序列化 query 参数
query = AFQueryStringFromParameters(parameters);
break;
}
}
}
复制代码
能够看到这里提供了一个 block 参数 queryStringSerialization,它能够支持外部设置,从而将编码序列化工做交给外部处理。AFNetworking 内部则使用了 AFQueryStringFromParameters 方法来编码参数,下面是它的实现
NSString * AFQueryStringFromParameters(NSDictionary *parameters) {
NSMutableArray *mutablePairs = [NSMutableArray array];
for (AFQueryStringPair *pair in AFQueryStringPairsFromDictionary(parameters)) {
// 将字典参数打平成一层AFQueryStringPair,进行url编码后,放入数组
[mutablePairs addObject:[pair URLEncodedStringValue]];
}
return [mutablePairs componentsJoinedByString:@"&"];
}
NSArray * AFQueryStringPairsFromDictionary(NSDictionary *dictionary) {
return AFQueryStringPairsFromKeyAndValue(nil, dictionary);
}
NSArray * AFQueryStringPairsFromKeyAndValue(NSString *key, id value) {
NSMutableArray *mutableQueryStringComponents = [NSMutableArray array];
// 按照 description 正序排序
NSSortDescriptor *sortDescriptor = [NSSortDescriptor sortDescriptorWithKey:@"description" ascending:YES selector:@selector(compare:)];
if ([value isKindOfClass:[NSDictionary class]]) {
NSDictionary *dictionary = value;
// Sort dictionary keys to ensure consistent ordering in query string, which is important when deserializing potentially ambiguous sequences, such as an array of dictionaries
for (id nestedKey in [dictionary.allKeys sortedArrayUsingDescriptors:@[ sortDescriptor ]]) {
id nestedValue = dictionary[nestedKey];
if (nestedValue) {
// 字典类型的参数,须要转为 dicName[key] = value 形式
[mutableQueryStringComponents addObjectsFromArray:AFQueryStringPairsFromKeyAndValue((key ? [NSString stringWithFormat:@"%@[%@]", key, nestedKey] : nestedKey), nestedValue)];
}
}
} else if ([value isKindOfClass:[NSArray class]]) {
NSArray *array = value;
for (id nestedValue in array) {
// 数组类型的参数,须要转为 arrayName[] = value 形式
[mutableQueryStringComponents addObjectsFromArray:AFQueryStringPairsFromKeyAndValue([NSString stringWithFormat:@"%@[]", key], nestedValue)];
}
} else if ([value isKindOfClass:[NSSet class]]) {
NSSet *set = value;
for (id obj in [set sortedArrayUsingDescriptors:@[ sortDescriptor ]]) {
// 集合类型的参数,直接取出元素添加到 query
[mutableQueryStringComponents addObjectsFromArray:AFQueryStringPairsFromKeyAndValue(key, obj)];
}
} else {
// 最终遍历到字符串类型参数截止
[mutableQueryStringComponents addObject:[[AFQueryStringPair alloc] initWithField:key value:value]];
}
return mutableQueryStringComponents;
}
复制代码
经过深度优先遍历,将字典内全部元素均转化为 AFQueryStringPair 对象后,每一个对象调用自身的 URLEncodedStringValue 方法,实现编码
- (NSString *)URLEncodedStringValue {
if (!self.value || [self.value isEqual:[NSNull null]]) {
return AFPercentEscapedStringFromString([self.field description]);
} else {
return [NSString stringWithFormat:@"%@=%@", AFPercentEscapedStringFromString([self.field description]), AFPercentEscapedStringFromString([self.value description])];
}
}
复制代码
而这里具体编码工做是由 AFPercentEscapedStringFromString 方法完成,在这个方法里,AFNetworking 首先将系统提供的 URLQueryAllowedCharacterSet 集合中的 #[] 三个字符去除了,意味着这三个字符也须要参与编码。而后以每 50 个字符为一个单元,调用 stringByAddingPercentEncodingWithAllowedCharacters 方法进行编码处理。
为了不对完整的 emoji 进行错误的截断,这里还用到了 rangeOfComposedCharacterSequencesForRange 方法获取完整的子字符串,而不是 substringToIndex 方法获取字符串。
编码后的字符,经过 & 字符链接起来后,就将被加入到 request 中,其中对于 GET、HEAD、DELETE 方法,也就是 HTTPMethodsEncodingParametersInURI 属性包含的方法,须要将参数补到 url 末尾,而对于其余方法,则直接加入到 body 中
if ([self.HTTPMethodsEncodingParametersInURI containsObject:[[request HTTPMethod] uppercaseString]]) {
if (query && query.length > 0) {
// url 有 query 和无 query 时须要区别处理
mutableRequest.URL = [NSURL URLWithString:[[mutableRequest.URL absoluteString] stringByAppendingFormat:mutableRequest.URL.query ? @"&%@" : @"?%@", query]];
}
} else {
// #2864: an empty string is a valid x-www-form-urlencoded payload
if (!query) {
query = @"";
}
// request 没设置 Content-Type 时,设置为默认的 application/x-www-form-urlencoded
if (![mutableRequest valueForHTTPHeaderField:@"Content-Type"]) {
[mutableRequest setValue:@"application/x-www-form-urlencoded" forHTTPHeaderField:@"Content-Type"];
}
[mutableRequest setHTTPBody:[query dataUsingEncoding:self.stringEncoding]];
}
复制代码
设置 header 就是遍历传入的 headers 字典,加入到 request 的 headerField 中便可。
对于序列化过程当中出现的错误,实际上就是 queryStringSerialization 外部编码出现的错误能够走 failure 回调,结束这次请求。
URLSessionManager 持有了建立 dataTask 所需的 NSURLSession 对象,所以须要最后由 URLSessionManager 建立对应的 task,它所作的工做以下
__block NSURLSessionDataTask *dataTask = nil;
url_session_manager_create_task_safely(^{
// 利用 request 建立一个 dataTask
dataTask = [self.session dataTaskWithRequest:request];
});
[self addDelegateForDataTask:dataTask uploadProgress:uploadProgressBlock downloadProgress:downloadProgressBlock completionHandler:completionHandler];
return dataTask;
复制代码
除了建立 task 之外,URLSessionManager 须要对每个 task 设置它的代理对象,具体在 addDelegateForDataTask 方法里,这个方法的实现以下
// 建立代理对象
AFURLSessionManagerTaskDelegate *delegate = [[AFURLSessionManagerTaskDelegate alloc] initWithTask:dataTask];
delegate.manager = self;
// 传入回调
delegate.completionHandler = completionHandler;
dataTask.taskDescription = self.taskDescriptionForSessionTasks;
// 将 task 与其代理对象的键值对加入到 mutableTaskDelegatesKeyedByTaskIdentifier
// 并监听 task 启动和挂起通知
[self setDelegate:delegate forTask:dataTask];
// 设置进度回调
delegate.uploadProgressBlock = uploadProgressBlock;
delegate.downloadProgressBlock = downloadProgressBlock;
复制代码
能够看到 URLSessionManager 对象其实并未细致到每个 task 进行控制和处理,更可能是对 task 的汇聚和管理,具体的回调、更新、异常处理都在每个 task 对应的代理对象中实现。
AFNetworking 3.0 内部使用的网络 API 是 URLSession,它有一系列的回调方法,涵盖 SSL 创建、发送数据、收到响应行、收到响应实体、异常处理和结束请求等关键过程,具体又分为如下几个协议类
GET 请求主要关注 NSURLSessionDataDelegate 方法,当收到数据时,系统会回调 URLSessionManager 的 URLSession:dataTask:didReceiveData:
方法,缘由是初始化 URLSessionManager 时,session 的代理对象设置的就是 URLSessionManager。
这个方法的实现很简单,主要作了如下工做
具体以下
{
// 查找 task 对应的 delegate
AFURLSessionManagerTaskDelegate *delegate = [self delegateForTask:dataTask];
// 回调给代理对象同名方法
[delegate URLSession:session dataTask:dataTask didReceiveData:data];
// manager 类统一回调
if (self.dataTaskDidReceiveData) {
self.dataTaskDidReceiveData(session, dataTask, data);
}
}
复制代码
而对于每个 task 的代理对象 AFURLSessionManagerTaskDelegate 类,也要实现一个同名方法,这个方法具体作的事情是将收到的数据汇聚到一个 NSData 中
{
self.downloadProgress.totalUnitCount = dataTask.countOfBytesExpectedToReceive;
self.downloadProgress.completedUnitCount = dataTask.countOfBytesReceived;
[self.mutableData appendData:data];
}
复制代码
这里就有两个问题了,其一是每个 task 总会结束,结束后它的代理对象也就没有意义须要销毁,其二是,数据什么时候才能结束添加并最终回调给调用者。其实这些都在 NSURLSessionTaskDelegate 协议的 URLSession:task:didCompleteWithError:
中,仍然像上面同样,首先系统会回调到 URLSessionManager 中,在这里 Manager 找到 task 的代理对象,调用它的同名方法
{
// 获取代理对象
AFURLSessionManagerTaskDelegate *delegate = [self delegateForTask:task];
// delegate may be nil when completing a task in the background
if (delegate) {
// 回调同名方法
[delegate URLSession:session task:task didCompleteWithError:error];
// 从 mutableTaskDelegatesKeyedByTaskIdentifier 移除task的代理对象,同时销毁对 task 的监听
[self removeDelegateForTask:task];
}
// 统一回调
if (self.taskDidComplete) {
self.taskDidComplete(session, task, error);
}
}
复制代码
而在 AFURLSessionManagerTaskDelegate 的同名方法里则完成了数据的解析、序列化和回调,主要来讲有如下工做
这里主要看一下序列化 response 的操做,AFHTTPSessionManager 默认使用的序列化类是 AFJSONResponseSerializer,除此以外还有 AFHTTPResponseSerializer、AFXMLParserResponseSerializer、AFXMLDocumentResponseSerializer、AFPropertyListResponseSerializer、AFImageResponseSerializer 等序列化器。
下面分析几个主要的序列化器的内部逻辑。
序列化的核心方法是 responseObjectForResponse:data:error:
,这个方法由 AFURLResponseSerialization 协议类定义,AFJSONResponseSerializer 的实现作了以下工做
验证合法性这一步,AFJSONResponseSerializer 用到了它的父类 AFHTTPResponseSerializer 定义的 validateResponse:data:error:
方法,这个方法主要检查
验证合法性结束后就调用 NSJSONSerialization 的 + (nullable id)JSONObjectWithData:(NSData *)data options:(NSJSONReadingOptions)opt error:(NSError **)error;
方法,将数据转为 JSON 对象,多是字典或者数组。若是外部设置了 removesKeysWithNullValues,即表明须要将 value 为 NSNULL 的键值对去除,这一步操做在 AFJSONObjectByRemovingKeysWithNullValues 方法中实现。
做为父类,AFHTTPResponseSerializer 的序列化操做仅仅检查了合法性就直接返回数据了
- (id)responseObjectForResponse:(NSURLResponse *)response
data:(NSData *)data
error:(NSError *__autoreleasing *)error
{
[self validateResponse:(NSHTTPURLResponse *)response data:data error:error];
return data;
}
复制代码
同时,它的 acceptableContentTypes 为 nil。
AFXMLParserResponseSerializer 接受 "application/xml" 及 "text/xml" 类型的 MIMEType,它的序列化过程主要调用以下方法
[[NSXMLParser alloc] initWithData:data];
复制代码
AFXMLDocumentResponseSerializer 接受 "application/xml" 及 "text/xml" 类型的 MIMEType,它的序列化过程主要调用以下方法
NSError *serializationError = nil;
NSXMLDocument *document = [[NSXMLDocument alloc] initWithData:data options:self.options error:&serializationError];
复制代码
AFPropertyListResponseSerializer 接受 "application/x-plist" 类型的 MIMEType,它的序列化过程主要调用以下方法
NSError *serializationError = nil;
id responseObject = [NSPropertyListSerialization propertyListWithData:data options:self.readOptions format:NULL error:&serializationError];
复制代码
AFImageResponseSerializer 定义了许多与图片相关 MIMEType,包括 "image/tiff", "image/jpeg", "image/gif", "image/png", "image/ico", "image/x-icon", "image/bmp", "image/x-bmp", "image/x-xbitmap", "image/x-win-bitmap" 等等。
图片序列化的过程若是细分会很复杂,这里简单归纳一下以下
AFCompoundResponseSerializer 是一个混合序列化器,它接受一系列的序列化器,当收到 response 时,一个一个去尝试可否解析出最终结果,若是都没法解析,则会调用到 AFHTTPResponseSerializer 的默认实现。