AFNetworking(一)從一次請求瞭解AFHTTPSessionManager

CISay發表於2019-01-21

AFNetworking 的核心類是 AFHTTPSessionManager,負責各種 HTTP 請求的發起和處理,它繼承自 AFURLSessionManager,是各種請求的直接執行者。

1. AFHTTPSessionManager的初始化

初始化方法主要接收 baseURL 和 sessionConfiguration 兩個引數。

其中對於 baseURL,初始化方法進行了如下判斷

    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 初始化方法裡也指定了預設物件。

// 請求序列化器用 AFHTTPRequestSerializer,響應序列化器用 AFJSONResponseSerializer
    self.requestSerializer = [AFHTTPRequestSerializer serializer];
    self.responseSerializer = [AFJSONResponseSerializer serializer];
複製程式碼

2 一次完整的請求與響應過程

這裡以 GET 為例,發起一次 GET 請求的具體過程可以分為發起請求和處理響應兩步,下面詳細說明。

2.1 發起請求

AFHTTPSessionManager 支援建立 GET、HEAD、POST、PUT、PATCH、DELETE 等請求,其中 GET 請求支援以下方法發起

- (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;
}
複製程式碼

2.1.1 設定 request 屬性以及引數

requestWithMethod:URLString:parameters:error: 方法主要做了建立和配置 Request 的工作,具體來說包括

  • 利用 url 建立 NSMutableURLRequest
  • 設定 HTTPMethod
  • 設定 request 的 allowsCellularAccess、cachePolicy、HTTPShouldHandleCookies、HTTPShouldUsePipelining、networkServiceType、timeoutInterval等屬性
  • 對引數編碼後加入到 url 或者 body 中

其中能設定的 request 具體作用如下

  • allowsCellularAccess 是否允許使用服務商蜂窩網路
  • cachePolicy 快取策略列舉
    • NSURLRequestUseProtocolCachePolicy = 0 預設的快取策略, 如果快取不存在,直接從服務端獲取。如果快取存在,會根據 response 中的 Cache-Control 欄位判斷下一步操作,如: Cache-Control 欄位為 must-revalidata, 則詢問服務端該資料是否有更新,無更新的話直接返回給使用者快取資料,若已更新,則請求服務端
    • NSURLRequestReloadIgnoringLocalCacheData = 1 忽略本地快取資料,直接請求服務端
    • NSURLRequestReloadIgnoringLocalAndRemoteCacheData = 4 未實現,忽略本地快取,代理伺服器以及其他中介,直接請求源服務端
    • NSURLRequestReloadIgnoringCacheData = NSURLRequestReloadIgnoringLocalCacheData 忽略本地快取資料,直接請求服務端
    • NSURLRequestReturnCacheDataElseLoad = 2 有快取就使用,不管其有效性(即忽略 Cache-Control 欄位), 無則請求服務端
    • NSURLRequestReturnCacheDataDontLoad = 3 只載入本地快取. 沒有就失敗(確定當前無網路時使用)
    • NSURLRequestReloadRevalidatingCacheData = 5 未實現,快取資料必須得得到服務端確認有效才使用
  • HTTPShouldHandleCookies 設定傳送請求時是否傳送cookie資料
  • HTTPShouldUsePipelining 設定請求時是否按順序收發 預設禁用 在某些伺服器中設為YES可以提高網路效能
  • networkServiceType 網路請求的服務型別
    • NSURLNetworkServiceTypeDefault = 0 普通網路傳輸,預設使用這個
    • NSURLNetworkServiceTypeVoIP = 1 網路語音通訊傳輸,只能在VoIP使用
    • NSURLNetworkServiceTypeVideo = 2 影像傳輸
    • NSURLNetworkServiceTypeBackground = 3 網路後臺傳輸,優先順序不高時可使用。對使用者不需要的網路操作可使用
    • NSURLNetworkServiceTypeVoice = 4 語音傳輸
  • timeoutInterval 請求超時時間

具體到 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];
        }
    }
複製程式碼

2.1.2 對引數編碼

編碼引數用到了 AFURLRequestSerialization 協議類的 requestBySerializingRequest:withParameters:error: 方法,而 HTTPSessionManager 用到的 AFHTTPRequestSerializer 則實現了此方法,主要做了幾件事

  • 沒有設定過相關必要的 header 欄位,則設定成預設值
  • 編碼 query 引數
  • 針對 HTTPMethod,將引數放入到 url 或 body 裡

首先是設定一些預設 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]];
    }
複製程式碼

2.1.3 設定 header

設定 header 就是遍歷傳入的 headers 字典,加入到 request 的 headerField 中即可。

2.1.4 序列化失敗回撥

對於序列化過程中出現的錯誤,實際上就是 queryStringSerialization 外部編碼出現的錯誤可以走 failure 回撥,結束此次請求。

2.1.5 傳給 URLSessionManager 建立 dataTask

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 對應的代理物件中實現。

2.2 處理響應

AFNetworking 3.0 內部使用的網路 API 是 URLSession,它有一系列的回撥方法,涵蓋 SSL 建立、傳送資料、收到響應行、收到響應實體、異常處理和結束請求等關鍵過程,具體又分為以下幾個協議類

  • NSURLSessionDelegate : session-level 的代理方法
  • NSURLSessionTaskDelegate : task-level 面向 all 的代理方法
  • NSURLSessionDataDelegate : task-level 面向 data 和 upload 的代理方法
  • NSURLSessionDownloadDelegate : task-level 面向 download 的代理方法
  • NSURLSessionStreamDelegate : task-level 面向 stream 的代理方法

2.2.1 接收資料

GET 請求主要關注 NSURLSessionDataDelegate 方法,當收到資料時,系統會回撥 URLSessionManager 的 URLSession:dataTask:didReceiveData: 方法,原因是初始化 URLSessionManager 時,session 的代理物件設定的就是 URLSessionManager。

這個方法的實現很簡單,主要做了以下工作

  • 回撥此事件給 task 的代理物件
  • 回撥 dataTaskDidReceiveData block

具體如下

{
    // 查詢 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];
}
複製程式碼

2.2.2 完成響應

這裡就有兩個問題了,其一是每一個 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 的同名方法裡則完成了資料的解析、序列化和回撥,主要來說有以下工作

  • 對系統回撥返回的 error 走異常處理,此時 responseObject 為 nil
  • 對響應中的二進位制資料進行序列化操作,預設通過 AFJSONResponseSerializer 進行序列化
  • 回撥到網路請求方

2.2.3 序列化操作

這裡主要看一下序列化 response 的操作,AFHTTPSessionManager 預設使用的序列化類是 AFJSONResponseSerializer,除此之外還有 AFHTTPResponseSerializer、AFXMLParserResponseSerializer、AFXMLDocumentResponseSerializer、AFPropertyListResponseSerializer、AFImageResponseSerializer 等序列化器。

下面分析幾個主要的序列化器的內部邏輯。

2.2.3.1 AFJSONResponseSerializer

序列化的核心方法是 responseObjectForResponse:data:error: ,這個方法由 AFURLResponseSerialization 協議類定義,AFJSONResponseSerializer 的實現做了如下工作

  • 驗證合法性
  • 呼叫 NSJSONSerialization 轉化為 JSON 物件
  • 去除值為 NSNULL 的情況(可選)

驗證合法性這一步,AFJSONResponseSerializer 用到了它的父類 AFHTTPResponseSerializer 定義的 validateResponse:data:error: 方法,這個方法主要檢查

  • MIMEType 是否在 AFHTTPResponseSerializer 定義的 acceptableContentTypes 中,不同的序列化器包含了不同的 MTMEType,對於 AFJSONResponseSerializer,包含以下型別application/json、text/json、text/javascript
  • 狀態碼在 acceptableStatusCodes 中,即 200-299

驗證合法性結束後就呼叫 NSJSONSerialization 的 + (nullable id)JSONObjectWithData:(NSData *)data options:(NSJSONReadingOptions)opt error:(NSError **)error; 方法,將資料轉為 JSON 物件,可能是字典或者陣列。如果外部設定了 removesKeysWithNullValues,即代表需要將 value 為 NSNULL 的鍵值對去除,這一步操作在 AFJSONObjectByRemovingKeysWithNullValues 方法中實現。

2.2.3.2 AFHTTPResponseSerializer

作為父類,AFHTTPResponseSerializer 的序列化操作僅僅檢查了合法性就直接返回資料了

- (id)responseObjectForResponse:(NSURLResponse *)response
                           data:(NSData *)data
                          error:(NSError *__autoreleasing *)error
{
    [self validateResponse:(NSHTTPURLResponse *)response data:data error:error];

    return data;
}
複製程式碼

同時,它的 acceptableContentTypes 為 nil。

2.2.3.3 AFXMLParserResponseSerializer

AFXMLParserResponseSerializer 接受 "application/xml" 及 "text/xml" 型別的 MIMEType,它的序列化過程主要呼叫如下方法

[[NSXMLParser alloc] initWithData:data];
複製程式碼
2.2.3.4 AFXMLDocumentResponseSerializer

AFXMLDocumentResponseSerializer 接受 "application/xml" 及 "text/xml" 型別的 MIMEType,它的序列化過程主要呼叫如下方法

    NSError *serializationError = nil;
    NSXMLDocument *document = [[NSXMLDocument alloc] initWithData:data options:self.options error:&serializationError];
複製程式碼
2.2.3.5 AFPropertyListResponseSerializer

AFPropertyListResponseSerializer 接受 "application/x-plist" 型別的 MIMEType,它的序列化過程主要呼叫如下方法

    NSError *serializationError = nil;
    
    id responseObject = [NSPropertyListSerialization propertyListWithData:data options:self.readOptions format:NULL error:&serializationError];
複製程式碼
2.2.3.6 AFImageResponseSerializer

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" 等等。

圖片序列化的過程如果細分會很複雜,這裡簡單概括一下如下

  • 驗證合法性
  • 是否自動解碼,需要自動解碼則通過 CGContextDrawImage 解碼圖片
  • 返回圖片
2.2.3.7 AFCompoundResponseSerializer

AFCompoundResponseSerializer 是一個混合序列化器,它接受一系列的序列化器,當收到 response 時,一個一個去嘗試能否解析出最終結果,如果都無法解析,則會呼叫到 AFHTTPResponseSerializer 的預設實現。

相關文章