AFNetworking-ResponseSerializer

概況:

這部分比較簡單,一共有以下幾個類:

  • AFHTTPResponseSerializer
  • AFJSONResponseSerializer : AFHTTPResponseSerializer
  • AFXMLParseResponseSerializer : AFHTTPResponseSerializer
  • AFXMLDocumentResponseSerializer : AFHTTPResponseSerializer
  • AFPropertyListResponseSerializer : AFHTTPResponseSerializer
  • AFImageResponseSerializer : AFHTTPResponseSerializer
  • AFCompoundResponseSerializer : AFHTTPResponseSerializer

AFHTTPResponseSerializer

這個類主要是驗證response合法性,是否是有效的response

validateResponse:data:error:

- (BOOL)validateResponse:(NSHTTPURLResponse *)response
                    data:(NSData *)data
                   error:(NSError * __autoreleasing *)error
 
{
    BOOL responseIsValid = YES;
    NSError *validationError = nil;
    if (response && [response isKindOfClass:[NSHTTPURLResponse class]]) {
//acceptableContentTypes里存儲了當前serializer支持的content-type,
//可以在不同的子類init方法中指定。有時候,通過charlse去mock請求的response,
//沒有通過rewrite功能重寫content-type(默認是text/plain)為application/
//json就會被afnetworking顯示請求失敗,not accept content-type 錯誤。
        if (self.acceptableContentTypes && ![self.acceptableContentTypes 
            containsObject:[response MIMEType]]) {
 
            if ([data length] > 0 && [response URL]) {
 
                NSMutableDictionary *mutableUserInfo = [@{
 
                                                          NSLocalizedDescriptio
                                                          nKey: [NSString 
                                                          stringWithFormat:NSLo
                                                        calizedStringFromTable(
                                                            @"Request failed:
                                                        unacceptable 
                                                          content-type: %@", @"
                                                          AFNetworking", nil), 
                                                          [response MIMEType]],
 
                                                          NSURLErrorFailingURLE
                                                          rrorKey:[response URL
                                                          ],
 
                                                          AFNetworkingOperation
                                                          FailingURLResponseErr
                                                          orKey: response,
 
                                                        } mutableCopy];
 
                if (data) {
 
                    mutableUserInfo[AFNetworkingOperationFailingURLResponseDataErrorKey] = data;
 
                }
 
                validationError = AFErrorWithUnderlyingError([NSError 
                    errorWithDomain:AFURLResponseSerializationErrorDomain code:
                    NSURLErrorCannotDecodeContentData userInfo:mutableUserInfo]
                    , validationError);
 
            }
 
            responseIsValid = NO;
        }
//acceptableStatusCodes存儲了當前serializer支持的返回碼,里面的值是在
//AFHTTPResponseSerializer基類
調用init方法中指定的。
        if (self.acceptableStatusCodes && ![self.acceptableStatusCodes 
            containsIndex:(NSUInteger)response.statusCode] && [response URL]) {
 
            NSMutableDictionary *mutableUserInfo = [@{
 
                                               NSLocalizedDescriptionKey: [
                                               NSString stringWithFormat:
                                               NSLocalizedStringFromTable(@"
                                               Request failed: %@ (%ld)", @"
                                               AFNetworking", nil), [
                                               NSHTTPURLResponse 
                                               localizedStringForStatusCode:
                                               response.statusCode], (long)
                                               response.statusCode],
 
                                               NSURLErrorFailingURLErrorKey:[
                                               response URL],
 
                                               AFNetworkingOperationFailingURLR
                                               esponseErrorKey: response,
 
                                       } mutableCopy];
            if (data) {
 
                mutableUserInfo[
                AFNetworkingOperationFailingURLResponseDataErrorKey] = data;
 
            }
 
            validationError = AFErrorWithUnderlyingError([NSError 
                errorWithDomain:AFURLResponseSerializationErrorDomain code:
                NSURLErrorBadServerResponse userInfo:mutableUserInfo], 
                validationError);                
            responseIsValid = NO;
        }
    }
    if (error && !responseIsValid) {
 
        *error = validationError;
 
    }
    return responseIsValid;
}

AFHTTPResponseSerializer

//只做了response的驗證邏輯,具體的反序列化在各個子類中實現。
//所有的serializer都要實現這個方法,在網絡請求成功返回數據之后,AFNetworking就會調用serializer這個方法來反序列化。
- (id)responseObjectForResponse:(NSURLResponse *)response
                           data:(NSData *)data
                          error:(NSError *__autoreleasing *)error
{
    [self validateResponse:(NSHTTPURLResponse *)response data:data error:error];
    return data;
}

AFJSONResponseSerializer

responseObjectForResponse:data:error

- (id)responseObjectForResponse:(NSURLResponse *)response
                           data:(NSData *)data
                          error:(NSError *__autoreleasing *)error
{
 
    if (![self validateResponse:(NSHTTPURLResponse *)response data:data error:
    error]) {
 
        if (!error || AFErrorOrUnderlyingErrorHasCodeInDomain(*error, 
            NSURLErrorCannotDecodeContentData, 
            AFURLResponseSerializationErrorDomain)) {                
 
            return nil;
 
        }
 
    }
 
    // Workaround for behavior of Rails to return a single space for `head 
    //:ok` (a workaround for a bug in Safari), which is not interpreted as 
    //valid input by NSJSONSerialization.
 
    // See https://github.com/rails/rails/issues/1742
 
    NSStringEncoding stringEncoding = self.stringEncoding;
 
    if (response.textEncodingName) {
 
        CFStringEncoding encoding = CFStringConvertIANACharSetNameToEncoding((
            CFStringRef)response.textEncodingName);
 
        if (encoding != kCFStringEncodingInvalidId) {
            stringEncoding = CFStringConvertEncodingToNSStringEncoding(encoding);
        }
    }
 
    id responseObject = nil;
 
    NSError *serializationError = nil;
 
    @autoreleasepool {
 
        NSString *responseString = [[NSString alloc] initWithData:data encoding
        :stringEncoding];
 
        if (responseString && ![responseString isEqualToString:@" "]) {
 
            // Workaround for a bug in NSJSONSerialization when Unicode 
            //character escape codes are used instead of the actual character
 
            // See http://stackoverflow.com/a/12843465/157142
 
            data = [responseString dataUsingEncoding:NSUTF8StringEncoding];
 
            if (data) {
 
                if ([data length] > 0) {
                    responseObject = [NSJSONSerialization JSONObjectWithData:
                    data options:self.readingOptions error:&serializationError];
                } else {
                    return nil;
                }
 
            } else {
 
                NSDictionary *userInfo = @{
 
                                           NSLocalizedDescriptionKey: 
                                           NSLocalizedStringFromTable(@"Data 
                                           failed decoding as a UTF-8 string", 
                                           @"AFNetworking", nil),
 
                                           NSLocalizedFailureReasonErrorKey: [
                                           NSString stringWithFormat:
                                           NSLocalizedStringFromTable(@"Could 
                                           not decode string: %@", @"
                                           AFNetworking", nil), responseString]
 
                                           };
                serializationError = [NSError errorWithDomain:
                AFURLResponseSerializationErrorDomain code:
                NSURLErrorCannotDecodeContentData userInfo:userInfo];
            }
        }
    }
//1.removesKeysWithNullValues表示當返回的數據dictionary的value為NSNULL的情況的時候,是
//否移除對應鍵值對。不處理會導致前端crash,如果不設置這個屬性,默認是false
//2.self.readingOptions可以根據需求用來設置最后反序列化出字典是否未可變類型(
//NSJSONReadingMutableContainers),默認是不可變類型
    if (self.removesKeysWithNullValues && responseObject) {
        responseObject = AFJSONObjectByRemovingKeysWithNullValues(
            responseObject, self.readingOptions);
    }
    if (error) {
        *error = AFErrorWithUnderlyingError(serializationError, *error);
    }
    return responseObject;
} 

AFCompoundResponseSerializer

responseObjectForResponse:data:error:

//這個類主要是可以合并多中Serializer的功能,存儲在self.responseSerializers集合中。
- (id)responseObjectForResponse:(NSURLResponse *)response
                           data:(NSData *)data
                          error:(NSError *__autoreleasing *)error
 
{
//這里沒有調用validateResponse方法,因為這個類處理的不是某一個具體的response類型
    for (id <AFURLResponseSerialization> serializer in self.responseSerializers) {
        if (![serializer isKindOfClass:[AFHTTPResponseSerializer class]]) {
            continue;
        }
 
        NSError *serializerError = nil;
        id responseObject = [serializer responseObjectForResponse:response data:data error:&serializerError];
        if (responseObject) {
            if (error) {
                *error = AFErrorWithUnderlyingError(serializerError, *error);
            }
 
            return responseObject;
        }
 
    }
    return [super responseObjectForResponse:response data:data error:error];
}
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
禁止轉載,如需轉載請通過簡信或評論聯系作者。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,001評論 6 537
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,786評論 3 423
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,986評論 0 381
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,204評論 1 315
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,964評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,354評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,410評論 3 444
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,554評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,106評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,918評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,093評論 1 371
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,648評論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,342評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,755評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,009評論 1 289
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,839評論 3 395
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,107評論 2 375

推薦閱讀更多精彩內容