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 的默認實現。