iOS源码解析—AFNetworking(ResponseSerializer)

概述

上篇文章分析了AFURLRequestSerialization，本篇文章主要分析一下AFURLResponseSerialization。AFURLResponseSerialization主要负责对网络请求回来的响应报文数据进行反序列化。主要的类包括AFHTTPResponseSerializer及其子类。

AFHTTPResponseSerializer

下面是AFHTTPResponseSerializer的相关属性：

@interface AFHTTPResponseSerializer : NSObject <AFURLResponseSerialization>
@property (nonatomic, assign) NSStringEncoding stringEncoding; //文本编码
@property (nonatomic, copy, nullable) NSIndexSet *acceptableStatusCodes; //允许的http状态码
@property (nonatomic, copy, nullable) NSSet *acceptableContentTypes; //允许的content-type类型
@end

stringEncoding属性是文本编码方式，用于响应的报文数据反序列化成字符串。acceptableStatusCodes是一个集合，表示客户端可以接受的报文数据的http状态码。acceptableContentTypes是一个集合，表示客户端可以接受的报文数据的content-type类型。接下来看一下初始化的代码：

self.stringEncoding = NSUTF8StringEncoding;
self.acceptableStatusCodes = [NSIndexSet indexSetWithIndexesInRange:NSMakeRange(200, 100)]; //允许200-299
self.acceptableContentTypes = nil;

默认指定文本编码方式为UTF-8，acceptableStatusCodes的范围是200-299，即HTTP响应状态码是200-299，因为根据RFC相关文档规定，2字头的状态码表示成功，下面是状态码的分类：

消息（1字头）、成功（2字头）、重定向（3字头）请求错误（4字头）、服务器错误（5、6字头）

acceptableContentTypes为nil，允许任何content-type类型的报文数据。解析响应报文数据的方法是：

- (id)responseObjectForResponse:(NSURLResponse *)response
                           data:(NSData *)data
                          error:(NSError *__autoreleasing *)error
{
    [self validateResponse:(NSHTTPURLResponse *)response data:data error:error];
    return 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]]) {
        if (self.acceptableContentTypes && ![self.acceptableContentTypes containsObject:[response MIMEType]]) {
            ...//生成错误信息
            responseIsValid = NO;
        }
        if (self.acceptableStatusCodes && ![self.acceptableStatusCodes containsIndex:(NSUInteger)response.statusCode] && [response URL]) {
            ...//生成错误信息
            responseIsValid = NO;
        }
    }
    ...
    return responseIsValid;
}

该方法首先判断响应的报文数据是否是NSHTTPURLResponse类型，即HTTP的相应报文，如果是，然后判断报文数据的content-type是否在acceptableContentTypes范围内，如果不在，生成错误信息，错误码是NSURLErrorCannotDecodeContentData，即反序列化报文数据失败。然后判断是否在acceptableStatusCodes范围内，如果不在，说明HTTP请求异常，生成错误信息，错误码是NSURLErrorBadServerResponse，即服务器返回的报文数据有问题。

AFJSONResponseSerializer

AFJSONResponseSerializer是AFHTTPResponseSerializer的子类，专门用于解析JSON格式的响应报文数据，初始化方法如下：

- (instancetype)init {
    self = [super init];
    if (!self) {
        return nil;
    }
    self.acceptableContentTypes = [NSSet setWithObjects:@"application/json", @"text/json", @"text/javascript", nil];
    return self;
}

该方法在父类方法的基础上，规定acceptableContentTypes包含”application/json”、”text/json”、”text/javascript”三种JSON格式，即报文数据的content-type只能是JSON相关的格式。重写了父类的解析方法，代码注释如下：

- (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;
        }
    }
    ...            
    id responseObject = nil;
    NSError *serializationError = nil;
    @autoreleasepool { //反序列化JSON报文数据
        NSString *responseString = [[NSString alloc] initWithData:data encoding:stringEncoding];
        if (responseString && ![responseString isEqualToString:@" "]) {
            data = [responseString dataUsingEncoding:NSUTF8StringEncoding];
            if (data) {
                if ([data length] > 0) {
                    responseObject = [NSJSONSerialization JSONObjectWithData:data options:self.readingOptions error:&serializationError];
                } else {
                    return nil;
                }
            } else {
                //生成错误信息
            }
        }
    }
    //针对反序列化后的对象，进行NSNull过滤
    if (self.removesKeysWithNullValues && responseObject) {
        responseObject = AFJSONObjectByRemovingKeysWithNullValues(responseObject, self.readingOptions);
    }
    if (error) {
        *error = AFErrorWithUnderlyingError(serializationError, *error);
    }
    return responseObject;
}

该方法首先验证响应报文数据，如果content-type不是JSON相关或者HTTP状态码不是成功类型，验证不通过，直接返回nil。然后调用NSJSONSerialization反序列化报文成OC对象responseObject。接着根据removesKeysWithNullValues属性做NSNull类型的过滤，层层遍历responseObject的结构，如果是字典属性，且value是NSNull，则从字典中删除相应key/value。最后将处理后的responseObject返回。

AFXMLParserResponseSerializer

AFXMLParserResponseSerializer负责解析XML格式的报文数据，初始化方法指定了content-type是”application/xml”，”text/xml”，即只支持XML格式的报文数据，然后调用解析方法，代码如下：

- (id)responseObjectForResponse:(NSHTTPURLResponse *)response
                           data:(NSData *)data
                          error:(NSError *__autoreleasing *)error
{
    ...//验证content-type和statusCode
    return [[NSXMLParser alloc] initWithData:data]; //生成XML解析器
}

该方法采用SAX的方式进行解析，特点是逐行解析，需要指定delegate，调用parse方法解析，当解析到每个节点的时候，都会通过delegate回调给调用层。这种方式读取部分XML的时候就可以边处理，不用等到XML加载完毕。

AFPropertyListResponseSerializer

plist格式类似XML格式，AFPropertyListResponseSerializer负责解析plist格式的报文数据，初始化方法指定了content-type是”application/x-plist”，即只支持plist格式的报文数据，然后调用解析方法，代码如下：

- (id)responseObjectForResponse:(NSURLResponse *)response
                           data:(NSData *)data
                          error:(NSError *__autoreleasing *)error
{
    ...//验证content-type和statusCode
    id responseObject;
    NSError *serializationError = nil;
    if (data) {
        responseObject = [NSPropertyListSerialization propertyListWithData:data options:self.readOptions format:NULL error:&serializationError];
    }
    return responseObject;
}

该方法调用NSPropertyListSerialization的propertyListWithData:options:format:error:方法解析报文数据，最后将解析后的responseObject返回。

AFImageResponseSerializer

AFImageResponseSerializer是AFNetworking库中专门用于解析图片格式数据的类，负责将报文数据反序列化成UIImage对象返回，首先初始化方法中指定了acceptableContentTypes都是image相关的格式。automaticallyInflatesResponseImage属性用于指定是否预处理图片数据。通常情况下网络请求返回的报文数据data，调用[UIImage imageWithData:data]得到的图像是PNG或者JPG等压缩格式的，如果将UIImage渲染到UIImageView上面，首先会进行解压，然后渲染到屏幕上，这一处理在主线程完成。如果在子线程中预先解压图片，返回Bitmap格式的UIImage对象，这样主线程只要渲染图片即可，减轻了主线程的负担。具体可以参考JSPatch大神博客中的分析。

具体负责解压处理的方法是AFInflatedImageFromResponseWithDataAtScale，将PNG或者JPG格式的图片转化成位图格式(Bitmap)的图片返回。该方法在子线程中调用，代码注释如下：

static UIImage * AFInflatedImageFromResponseWithDataAtScale(NSHTTPURLResponse *response, NSData *data, CGFloat scale) { 
    ...
    CGImageRef imageRef = NULL;
    //根据data创建dataProvider
    CGDataProviderRef dataProvider = CGDataProviderCreateWithCFData((__bridge CFDataRef)data);
    //判断报文格式是否是png或者jpg
    if ([response.MIMEType isEqualToString:@"image/png"]) {
        imageRef = CGImageCreateWithPNGDataProvider(dataProvider,  NULL, true, kCGRenderingIntentDefault); //创建png图片
    } else if ([response.MIMEType isEqualToString:@"image/jpeg"]) {
        imageRef = CGImageCreateWithJPEGDataProvider(dataProvider, NULL, true, kCGRenderingIntentDefault); //创建jpg图片
        //如果存在png图片或者jpg图片
        if (imageRef) {
            //获取图片的颜色模型
            CGColorSpaceRef imageColorSpace = CGImageGetColorSpace(imageRef);
            CGColorSpaceModel imageColorSpaceModel = CGColorSpaceGetModel(imageColorSpace);
            //如果是CMYK模型，则无法转成位图，imageRef指针置为空
            if (imageColorSpaceModel == kCGColorSpaceModelCMYK) {
                CGImageRelease(imageRef);
                imageRef = NULL;
            }
        }
    }
    CGDataProviderRelease(dataProvider);
    //根据创建原格式图片
    UIImage *image = AFImageWithDataAtScale(data, scale);
    if (!imageRef) { //如果imageRef为空，说明不是压缩格式的图片，或者无法进一步转成Bitmap格式，直接返回原格式图片
        if (image.images || !image) {
            return image;
        }
        imageRef = CGImageCreateCopy([image CGImage]);
        if (!imageRef) {
            return nil;
        }
    }
    //根据imageRef获取图片相关信息
    size_t width = CGImageGetWidth(imageRef);
    size_t height = CGImageGetHeight(imageRef);
    size_t bitsPerComponent = CGImageGetBitsPerComponent(imageRef);
    //如果图片太大，直接返回原格式图片
    if (width * height > 1024 * 1024 || bitsPerComponent > 8) {
        CGImageRelease(imageRef);
        return image;
    }

    //获取图片相关信息
    size_t bytesPerRow = 0;
    CGColorSpaceRef colorSpace = CGColorSpaceCreateDeviceRGB();
    CGColorSpaceModel colorSpaceModel = CGColorSpaceGetModel(colorSpace);
    CGBitmapInfo bitmapInfo = CGImageGetBitmapInfo(imageRef);
    //如果是RGB颜色模型，根据像素是否包含alpha通道进行相应处理
    if (colorSpaceModel == kCGColorSpaceModelRGB) {
        uint32_t alpha = (bitmapInfo & kCGBitmapAlphaInfoMask);
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wassign-enum"
        if (alpha == kCGImageAlphaNone) {
            bitmapInfo &= ~kCGBitmapAlphaInfoMask;
            bitmapInfo |= kCGImageAlphaNoneSkipFirst;
        } else if (!(alpha == kCGImageAlphaNoneSkipFirst || alpha == kCGImageAlphaNoneSkipLast)) {
            bitmapInfo &= ~kCGBitmapAlphaInfoMask;
            bitmapInfo |= kCGImageAlphaPremultipliedFirst;
        }
#pragma clang diagnostic pop
    }
    //创建Bitmap的上下文
    CGContextRef context = CGBitmapContextCreate(NULL, width, height, bitsPerComponent, bytesPerRow, colorSpace, bitmapInfo);

    CGColorSpaceRelease(colorSpace);

    if (!context) {
        CGImageRelease(imageRef);

        return image;
    }
    //渲染到画布上
    CGContextDrawImage(context, CGRectMake(0.0f, 0.0f, width, height), imageRef);
    //获取Bitmap格式的图片
    CGImageRef inflatedImageRef = CGBitmapContextCreateImage(context);
    CGContextRelease(context);
    //转化为UIImage对象
    UIImage *inflatedImage = [[UIImage alloc] initWithCGImage:inflatedImageRef scale:scale orientation:image.imageOrientation];

    CGImageRelease(inflatedImageRef);
    CGImageRelease(imageRef);
    return inflatedImage;
}

该方法分为以下几步：

1. 首先根据报文数据创建图像，如果content-type是PNG或者JPG格式，则imageRef指针指向该图像。如果不是PNG或者JPG，或者颜色模型是CMYK，则不能进行后续转化，imageRef指针置空。

2. 调用AFImageWithDataAtScale方法直接生成原格式的UIImage对象，如果imageRef为空，说明不能进行后续转化，直接返回原格式的图片对象，结束方法。

3. 如果imageRef不为空，说明可以进行转化，通过imageRef获取图像相关信息，如下：

   width Bitmap的宽度,单位为像素

   height Bitmap的高度,单位为像素

   bitsPerComponent 内存中像素的每个组件的位数. 例如，对于32位像素格式和RGB颜色模型，你应该将这个值设为8.

   bytesPerRow  Bitmap的每一行在内存所占的比特数

   colorspace  Bitmap上下文使用的颜色空间。

   bitmapInfo Bitmap是否包含alpha通道

4. 根据上述信息创建Bitmap的上下文，并渲染到画布上。

5. 调用CGBitmapContextCreateImage方法，通过上下文获取Bitmap格式的CGImageRef对象，通过inflatedImageRef创建Bitmap格式的UIImage对象，返回该图片。

结尾

本篇分析了报文数据反序列化的相关类，关于报文数据序列化和反序列化的分析到此告一段落。后续准备学习和分析AFNetworking的网络通信主体部分。