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阅读 218,546评论 6 507
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,224评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,911评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,737评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,753评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,598评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,338评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,249评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,696评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,888评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,013评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,731评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,348评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,929评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,048评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,203评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,960评论 2 355

推荐阅读更多精彩内容