AFNetworking 框架小结 二(AFURLResponseSerialization)

2024-06-06 13:08

本文主要是介绍AFNetworking 框架小结 二(AFURLResponseSerialization),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

AFURLResponseSerialization

响应报文解析器

在 AFNetworking 网络框架中,为了方便处理网络返回的响应报文,特抽象出来一个响应报文解析器,其相关的类都在 AFURLResponseSerialization.h 文件中。相较于网络请求报文构造器,解析器要简单的多,其关键为抽象类 AFHTTPResponseSerializer 以及其遵循的 AFURLResponseSerialization 协议。

AFHTTPResponseSerializer

AFHTTPResponseSerializer 会对响应报文做一些基本的处理,所以自定义处理 HTTP 响应报文时,应扩展其子类以保证基本的报文处理得以进行,不过,该框架中提供的子类解析器已经满足了大部分需要。

在 AFHTTPResponseSerializer 类中定义了两个重要的属性和一个判断响应报文是否有效的方法。

@property (nonatomic, copy, nullable) NSIndexSet *acceptableStatusCodes;
@property (nonatomic, copy, nullable) NSSet <NSString *> *acceptableContentTypes;
  • acceptableStatusCodes 合法的报文状态码集合
  • acceptableContentTypes 合法的报文体数据类型集合

上述两个属性会在下面的方法中被用来判断响应报文是否是有效报文,当然,如果这两个属性为 nil ,那么便不会使用其进行判断。

- (BOOL)validateResponse:(nullable NSHTTPURLResponse *)responsedata:(nullable NSData *)dataerror:(NSError * _Nullable __autoreleasing *)error;

调用上面的方法,判断 response 的 MIMEType 属性值是否在 acceptableContentTypes 集合中,response 的 statusCode 属性值是否在 acceptableStatusCodes 范围内,并且 data 是否存在,如果校验不通过,相关的错误信息会保存在 error 中并返回 NO 。

在创建解析器时,可以调用类方法 serializer ,在该方法中,会初始化 acceptableStatusCodes 属性集合的范围为 200~300 ,而 acceptableContentTypes 会被置为 nil 。

AFURLResponseSerialization

该协议只提供了一个方法,用来解析响应报文中的数据,最后的返回值为解析后的数据。在自定义 AFHTTPResponseSerializer 的子类时,应该重写该协议方法,因为 AFHTTPResponseSerializer 类中并未对与报文相关的 data 数据进行额外的处理,而是直接返回了。

- (nullable id)responseObjectForResponse:(nullable NSURLResponse *)responsedata:(nullable NSData *)dataerror:(NSError * _Nullable __autoreleasing *)error NS_SWIFT_NOTHROW;

AFJSONResponseSerializer

AFJSONResponseSerializer 类重写了父类 AFHTTPResponseSerializer 中的实例创建方法和初始化方法,并提供了下面的类方法用于创建解析 JSON 数据的实例对象。

+ (instancetype)serializerWithReadingOptions:(NSJSONReadingOptions)readingOptions;

并且可以通过设置 removesKeysWithNullValues 属性值为 YES 来过滤为 NULL 的数据。

在创建 JSON 数据的解析器时,其初始化方法,会将有效的报文类型集合设置为 application/jsontext/jsontext/javascript ,如下:

self.acceptableContentTypes = [NSSet setWithObjects:@"application/json", @"text/json", @"text/javascript", nil];

这样在校验报文数据时,就会过滤掉非 JSON 格式的返回报文,然后使用 NSJSONSerialization 解析 JSON 数据得到相应的对象,如果需要移除为 NULL 的值,则会接着调用下面的函数。

static id AFJSONObjectByRemovingKeysWithNullValues(id JSONObject, NSJSONReadingOptions readingOptions)

AFXMLParserResponseSerializer

AFXMLParserResponseSerializer 同样是 AFHTTPResponseSerializer 的子类,只是其并未增加属性,只是重写了父类的方法。

在初始化方法中将 acceptableContentTypes 设置为 application/xmltext/xml 的集合。

在 AFURLResponseSerialization 协议的方法中,使用接收到的数据创建了一个 XML 数据解析器 NSXMLParser 并返回,进一步的解析则由用户负责。

AFXMLDocumentResponseSerializer

AFXMLDocumentResponseSerializer 与 AFXMLParserResponseSerializer 类似,有相同的报文类型集合,但是其重写的解析方法最后返回的是 NSXMLDocument 对象。

该解析器只适用于 Mac OS X 系统中

AFPropertyListResponseSerializer

AFPropertyListResponseSerializer 可以用来解析类型为 application/x-plist 的返回报文,在重写 AFURLResponseSerialization 中的方法时,会创建并返回一个 NSPropertyListSerialization 类实例对象。

AFImageResponseSerializer

AFImageResponseSerializer 用来解析请求到的图片数据,其默认支持的图片格式如下:

  • 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

在该子类中,声明了 imageScaleautomaticallyInflatesResponseImage 两个属性,前者指定图片的缩放值,默认为设备屏幕的缩放值。后者指明是否调用函数 AFInflatedImageFromResponseWithDataAtScale 对请求的图片的透明度信息进行填充,默认为 YES ,即进行填充。

在 AFInflatedImageFromResponseWithDataAtScale 函数中,只会对类型为 PNG 和 JPEG 类型的图片进行处理,并且图片如果是 JPEG 类型且其颜色空间为 kCGColorSpaceModelCMYK 类型,也不会进行透明度信息的填充。

另外,获取的图片,其宽和高都要小于 1024 且通道信息的位数不能大于 8 。之后,如果设备所支持的颜色空间模型为 kCGColorSpaceModelRGB 则可以对图片的透明度信息进行处理,分为下面两种情况:

  • 图片的 kCGBitmapAlphaInfoMask 值为 kCGImageAlphaNone 即图片没有透明度信息,那么透明度信息设置为 kCGImageAlphaNoneSkipFirst
  • 图片的 kCGBitmapAlphaInfoMask 值不是 kCGImageAlphaNoneSkipFirstkCGImageAlphaNoneSkipLast 时,设置为 kCGImageAlphaPremultipliedFirst

这两个属性不适用于 Mac OS X 系统中。

AFCompoundResponseSerializer

组合解析器,使用该类可以将多个解析器组合到一个解析器中,用于多种类型数据的解析,对于无法确定返回的数据类型的情况很方便,其实现的方式主要是在重写的协议方法中遍历 responseSerializers 属性中的所有解析器进行数据解析,一旦解析成功,则返回解析结果,否则继续使用下一个解析器。

这些解析器可以是自定义的,但是必需遵循 AFURLResponseSerialization 协议,当然,可能遍历结束后,数据仍然无法解析,参见下面的源码。

- (id)responseObjectForResponse:(NSURLResponse *)responsedata:(NSData *)dataerror:(NSError *__autoreleasing *)error
{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];
}

要注意的是,创建该类时,不能使用父类声明的 serializer 方法,而是要使用该类自己声明的类方法。

+ (instancetype)compoundSerializerWithResponseSerializers:(NSArray <id<AFURLResponseSerialization>> *)responseSerializers;

这篇关于AFNetworking 框架小结 二(AFURLResponseSerialization)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1036193

相关文章

判断PyTorch是GPU版还是CPU版的方法小结

《判断PyTorch是GPU版还是CPU版的方法小结》PyTorch作为当前最流行的深度学习框架之一,支持在CPU和GPU(NVIDIACUDA)上运行,所以对于深度学习开发者来说,正确识别PyTor... 目录前言为什么需要区分GPU和CPU版本?性能差异硬件要求如何检查PyTorch版本?方法1:使用命

Redis 热 key 和大 key 问题小结

《Redis热key和大key问题小结》:本文主要介绍Redis热key和大key问题小结,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录一、什么是 Redis 热 key?热 key(Hot Key)定义: 热 key 常见表现:热 key 的风险:二、

Spring Boot读取配置文件的五种方式小结

《SpringBoot读取配置文件的五种方式小结》SpringBoot提供了灵活多样的方式来读取配置文件,这篇文章为大家介绍了5种常见的读取方式,文中的示例代码简洁易懂,大家可以根据自己的需要进... 目录1. 配置文件位置与加载顺序2. 读取配置文件的方式汇总方式一:使用 @Value 注解读取配置方式二

Python中的getopt模块用法小结

《Python中的getopt模块用法小结》getopt.getopt()函数是Python中用于解析命令行参数的标准库函数,该函数可以从命令行中提取选项和参数,并对它们进行处理,本文详细介绍了Pyt... 目录getopt模块介绍getopt.getopt函数的介绍getopt模块的常用用法getopt模

C 语言中enum枚举的定义和使用小结

《C语言中enum枚举的定义和使用小结》在C语言里,enum(枚举)是一种用户自定义的数据类型,它能够让你创建一组具名的整数常量,下面我会从定义、使用、特性等方面详细介绍enum,感兴趣的朋友一起看... 目录1、引言2、基本定义3、定义枚举变量4、自定义枚举常量的值5、枚举与switch语句结合使用6、枚

Java中的Lambda表达式及其应用小结

《Java中的Lambda表达式及其应用小结》Java中的Lambda表达式是一项极具创新性的特性,它使得Java代码更加简洁和高效,尤其是在集合操作和并行处理方面,:本文主要介绍Java中的La... 目录前言1. 什么是Lambda表达式?2. Lambda表达式的基本语法例子1:最简单的Lambda表

Java中Scanner的用法示例小结

《Java中Scanner的用法示例小结》有时候我们在编写代码的时候可能会使用输入和输出,那Java也有自己的输入和输出,今天我们来探究一下,对JavaScanner用法相关知识感兴趣的朋友一起看看吧... 目录前言一 输出二 输入Scanner的使用多组输入三 综合练习:猜数字游戏猜数字前言有时候我们在

SQL BETWEEN 的常见用法小结

《SQLBETWEEN的常见用法小结》BETWEEN操作符是SQL中非常有用的工具,它允许你快速选取某个范围内的值,本文给大家介绍SQLBETWEEN的常见用法,感兴趣的朋友一起看看吧... 在SQL中,BETWEEN是一个操作符,用于选取介于两个值之间的数据。它包含这两个边界值。BETWEEN操作符常用

go 指针接收者和值接收者的区别小结

《go指针接收者和值接收者的区别小结》在Go语言中,值接收者和指针接收者是方法定义中的两种接收者类型,本文主要介绍了go指针接收者和值接收者的区别小结,文中通过示例代码介绍的非常详细,需要的朋友们下... 目录go 指针接收者和值接收者的区别易错点辨析go 指针接收者和值接收者的区别指针接收者和值接收者的

python uv包管理小结

《pythonuv包管理小结》uv是一个高性能的Python包管理工具,它不仅能够高效地处理包管理和依赖解析,还提供了对Python版本管理的支持,本文主要介绍了pythonuv包管理小结,具有一... 目录安装 uv使用 uv 管理 python 版本安装指定版本的 Python查看已安装的 Python