基于AFNetworking3.0网络封装
概述
对于开发人员来说，学习网络层知识是必备的，任何一款App的开发，都需要到网络请求接口。很多朋友都还在使用原生的NSURLConnection一行一行地写，代码到处是，这样维护起来更困难了。
对于使用AFNetworking的朋友来说，很多朋友都是直接调用AFNetworking的API，这样不太好，无法做到全工程统一配置。
最好的方式就是对网络层再封装一层，全工程不允许直接使用AFNetworking的API，必须调用我们自己封装的一层，如此一来，任何网络配置都可以在这一层里配置好，使用的人无须知道里面在干嘛，只管调用就可以了。
本篇为基于AFNetworking3.0以上的版本，支持iOS7及其以上版本。若要支持iOS6，请阅读旧版本：基于AFNetworking2.5封装
Version 3.2.1
- 完善缓存机制及无网或者网络异常状态下取缓存数据
Version 3.2.0
- 增加超时设置
- 增加网络异常时是否读取本地缓存的策略
升级为3.0版本
- 简化API，以降低使用的要求
- 增加GET/POST数据缓存、获取缓存大小、清空缓存功能
- 接口增加刷新缓存功能
- 增加取消所有请求、取消单个请求功能
- 格式化打印日志
- 增加对手动取消请求接口是否在失败时还回调的控制
常用接口类型
应用开发过程中，所使用类型通常是GET、POST及上传图片。因此，这里只是对这几种类型提供API。
GET接口
这里提供了两个GET请求的API，需要一般情况下GET请求都是直接写一个完整的URL，但是有时候为了参数可读性更强，改成传一个字典过来更容易阅读。
HYBResponseSuccess是响应成功的回调，返回的是字典，外部再转换成模型就可以了。
HYBResponseFail是响应失败的回调，只有一个NSError对象，外部可接收处理。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
|
/*!
* @author 黄仪标, 15-11-15 13:11:50
*
* GET请求接口，若不指定baseurl，可传完整的url
*
* @param url 接口路径，如/path/getArticleList
* @param refreshCache 是否刷新缓存。由于请求成功也可能没有数据，对于业务失败，只能通过人为手动判断
* @param params 接口中所需要的拼接参数，如@{"categoryid" : @(12)}
* @param success 接口成功请求到数据的回调
* @param fail 接口请求数据失败的回调
*
* @return 返回的对象中有可取消请求的API
*/
+ (HYBURLSessionTask *)getWithUrl:(NSString *)url
refreshCache:(BOOL)refreshCache
success:(HYBResponseSuccess)success
fail:(HYBResponseFail)fail;
// 多一个params参数
+ (HYBURLSessionTask *)getWithUrl:(NSString *)url
refreshCache:(BOOL)refreshCache
params:(NSDictionary *)params
success:(HYBResponseSuccess)success
fail:(HYBResponseFail)fail;
// 多一个带进度回调
+ (HYBURLSessionTask *)getWithUrl:(NSString *)url
refreshCache:(BOOL)refreshCache
params:(NSDictionary *)params
progress:(HYBGetProgress)progress
success:(HYBResponseSuccess)success
fail:(HYBResponseFail)fail;
|
POST接口
对于POST请求类型的接口，只有一个，看注释就可以明白如何使用了。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
|
/*!
* @author 黄仪标, 15-11-15 13:11:50
*
* POST请求接口，若不指定baseurl，可传完整的url
*
* @param url 接口路径，如/path/getArticleList
* @param params 接口中所需的参数，如@{"categoryid" : @(12)}
* @param success 接口成功请求到数据的回调
* @param fail 接口请求数据失败的回调
*
* @return 返回的对象中有可取消请求的API
*/
+ (HYBURLSessionTask *)postWithUrl:(NSString *)url
refreshCache:(BOOL)refreshCache
params:(NSDictionary *)params
success:(HYBResponseSuccess)success
fail:(HYBResponseFail)fail;
+ (HYBURLSessionTask *)postWithUrl:(NSString *)url
refreshCache:(BOOL)refreshCache
params:(NSDictionary *)params
progress:(HYBPostProgress)progress
success:(HYBResponseSuccess)success
fail:(HYBResponseFail)fail;
|
图片上传接口
接口一次只能上传一张图片，通常也是这么处理的。这里是以文件流的形式来上传的哦。其中，mineType为image/jpeg。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
|
/**
* @author 黄仪标, 16-01-31 00:01:40
*
* 图片上传接口，若不指定baseurl，可传完整的url
*
* @param image 图片对象
* @param url 上传图片的接口路径，如/path/images/
* @param filename 给图片起一个名字，默认为当前日期时间,格式为"yyyyMMddHHmmss"，后缀为`jpg`
* @param name 与指定的图片相关联的名称，这是由后端写接口的人指定的，如imagefiles
* @param mimeType 默认为image/jpeg
* @param parameters 参数
* @param progress 上传进度
* @param success 上传成功回调
* @param fail 上传失败回调
*
* @return
*/
+ (HYBURLSessionTask *)uploadWithImage:(UIImage *)image
url:(NSString *)url
filename:(NSString *)filename
name:(NSString *)name
mimeType:(NSString *)mimeType
parameters:(NSDictionary *)parameters
progress:(HYBUploadProgress)progress
success:(HYBResponseSuccess)success
fail:(HYBResponseFail)fail;
|
上传文件接口
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
|
/**
* @author 黄仪标, 16-01-31 00:01:59
*
* 上传文件操作
*
* @param url 上传路径
* @param uploadingFile 待上传文件的路径
* @param progress 上传进度
* @param success 上传成功回调
* @param fail 上传失败回调
*
* @return
*/
+ (HYBURLSessionTask *)uploadFileWithUrl:(NSString *)url
uploadingFile:(NSString *)uploadingFile
progress:(HYBUploadProgress)progress
success:(HYBResponseSuccess)success
fail:(HYBResponseFail)fail;
|
文件下载接口
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
/*!
* @author 黄仪标, 16-01-08 15:01:11
*
* 下载文件
*
* @param url 下载URL
* @param saveToPath 下载到哪个路径下
* @param progressBlock 下载进度
* @param success 下载成功后的回调
* @param failure 下载失败后的回调
*/
+ (HYBURLSessionTask *)downloadWithUrl:(NSString *)url
saveToPath:(NSString *)saveToPath
progress:(HYBDownloadProgress)progressBlock
success:(HYBResponseSuccess)success
failure:(HYBResponseFail)failure;
|
取消请求
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
|
/**
* @author 黄仪标
*
* 取消所有请求
*/
+ (void)cancelAllRequest;
/**
* @author 黄仪标
*
* 取消某个请求。如果是要取消某个请求，最好是引用接口所返回来的HYBURLSessionTask对象，
* 然后调用对象的cancel方法。如果不想引用对象，这里额外提供了一种方法来实现取消某个请求
*
* @param url URL，可以是绝对URL，也可以是path（也就是不包括baseurl）
*/
+ (void)cancelRequestWithURL:(NSString *)url;
|
在使用中，可以通过这样来调用：
|
1
2
3
4
5
6
7
8
9
10
|
// 取消全部请求
// [HYBNetworking cancelAllRequest];
// 取消单个请求方法一
// [HYBNetworking cancelRequestWithURL:path];
// 取消单个请求方法二
// [task cancel];
|
缓存
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
|
/**
* @author 黄仪标
*
* 默认只缓存GET请求的数据，对于POST请求是不缓存的。如果要缓存POST获取的数据，需要手动调用设置
* 对JSON类型数据有效，对于PLIST、XML不确定！
*
* @param isCacheGet 默认为YES
* @param shouldCachePost 默认为NO
*/
+ (void)cacheGetRequest:(BOOL)isCacheGet shoulCachePost:(BOOL)shouldCachePost;
/**
* @author 黄仪标
*
* 获取缓存总大小/bytes
*
* @return 缓存大小
*/
+ (unsigned long long)totalCacheSize;
/**
* @author 黄仪标
*
* 清除缓存
*/
+ (void)clearCaches;
|
BaseURL
这里还提供了两个公共接口，一个是用于设置或者更新网络接口的基础URL，一个是获取当前设置使用的网络接口基础URL。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
/*!
* @author 黄仪标, 15-11-15 13:11:45
*
* 用于指定网络请求接口的基础url，如：
* http://henishuo.com或者http://101.200.209.244
* 通常在AppDelegate中启动时就设置一次就可以了。如果接口有来源
* 于多个服务器，可以调用更新
*
* @param baseUrl 网络接口的基础url
*/
+ (void)updateBaseUrl:(NSString *)baseUrl;
+ (NSString *)baseUrl;
|
添加公共请求头参数
通常每家公司的接口都会设置公共的请求头参数，以代表是公司的接口。默认已经配置了可接收的类型，但是如果需要额外配置，可通过调用此api来添加：
|
1
2
3
4
5
6
7
8
9
10
|
/*!
* @author 黄仪标, 15-11-16 13:11:41
*
* 配置公共的请求头，只调用一次即可，通常放在应用启动的时候配置就可以了
*
* @param httpHeaders 只需要将与服务器商定的固定参数设置即可
*/
+ (void)configCommonHttpHeaders:(NSDictionary *)httpHeaders;
|
请求、响应类型
默认responseType和requestType都是JSON格式。如果不使用JSON，可以全局配置成自己希望的格式即可。若不配置，默认就是JSON。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
/*!
* @author 黄仪标, 15-12-25 15:12:45
*
* 配置请求格式，默认为JSON。如果要求传XML或者PLIST，请在全局配置一下
*
* @param requestType 请求格式，默认为JSON
* @param responseType 响应格式，默认为JSO，
* @param shouldAutoEncode YES or NO,默认为NO，是否自动encode url
* @param shouldCallbackOnCancelRequest 当取消请求时，是否要回调，默认为YES
*/
+ (void)configRequestType:(HYBRequestType)requestType
responseType:(HYBResponseType)responseType
shouldAutoEncodeUrl:(BOOL)shouldAutoEncode
callbackOnCancelRequest:(BOOL)shouldCallbackOnCancelRequest;
|
URL编码问题
考虑到网络请求接口中，有时候会有中文参数，这时候就会请求失败，因此我们要对这种类型的URL进行编码，否则请求会失败。这里是开启或者关闭自动将URL编码的接口，默认为NO，表示不开启。
|
1
2
3
4
5
6
7
8
9
10
|
/*!
* @author 黄仪标, 15-11-15 15:11:16
*
* 开启或关闭是否自动将URL使用UTF8编码，用于处理链接中有中文时无法请求的问题
*
* @param shouldAutoEncode YES or NO,默认为NO
*/
+ (void)shouldAutoEncodeUrl:(BOOL)shouldAutoEncode;
|
格式化接口数据打印日志
|
1
2
3
4
5
6
7
8
9
10
|
/*!
* @author 黄仪标, 15-11-15 14:11:40
*
* 开启或关闭接口打印信息
*
* @param isDebug 开发期，最好打开，默认是NO
*/
+ (void)enableInterfaceDebug:(BOOL)isDebug;
|
开启后会有非常好的打印效果，效果如下：
通常在AppDelegate中应用启动的代理方法中调用设置为开启就可以了。不过是否设置为开启，当应用以发布证书打包时，都不会打印日志，因为这里做了处理，可放心使用。现在已经公开在外部，项目中都可以使用哦：
|
1
2
3
4
5
6
7
8
|
// 项目打包上线都不会打印日志，因此可放心。
#ifdef DEBUG
#define HYBAppLog(s, ... ) NSLog( @"[%@ in line %d] ===============>%@", [[NSString stringWithUTF8String:__FILE__] lastPathComponent], __LINE__, [NSString stringWithFormat:(s), ##__VA_ARGS__] )
#else
#define HYBAppLog(s, ... )
#endif
|
安装使用
现在已经支持cocoapods，引入以下命令即可：
|
1
2
3
|
pod 'HYBNetworking', '~> 3.0.0'
|
或者直接下载源代码，拖入工程使用！
源代码
请大家到我的github下载源代码：HYBNetworking
温馨提示
最近老有人问：编译一直报错library not found for -lAFNetworking什么问题？
注意：如果您是使用cocoapods来管理第三方库的，那么直接通过上面安装使用的方式来安装即可，然后pod update一下。如果您不是使用cocoapods来引入的，请手动将AFNetworking对应的版本添加到工程。
转载于:https://www.cnblogs.com/fengmin/p/5507682.html
基于AFNetworking3.0网络封装相关推荐
- Android基于Retrofit2.0 +RxJava 封装的超好用的RetrofitClient工具类（六）
csdn :码小白 原文地址: http://blog.csdn.net/sk719887916/article/details/51958010 RetrofitClient 基于Retrofit2 ...
- 【转载】基于AFNetWorking3.0的图片缓存分析
原文出处:Yasin的简书 http://www.jianshu.com/p/b1045c3fc8d0 图片在APP中占有重要的角色,对图片做好缓存是重要的一项工作. [TOC] 理论 不喜欢理论的可 ...
- iOS开发--基于AFNetWorking3.0的图片缓存分析
图片在APP中占有重要的角色,对图片做好缓存是重要的一项工作.[TOC] 理论 不喜欢理论的可以直接跳到下面的Demo实践部分 缓存介绍 缓存按照保存位置可以分为两类:内存缓存.硬盘缓存(FMDB.C ...
- 深度学习之基于Tensorflow2.0实现ResNet50网络
理论上讲,当网络层数加深时,网络的性能会变强,而实际上,在不断的加深网络层数后,分类性能不会提高,而是会导致网络收敛更缓慢,准确率也随着降低.利用数据增强等方法抑制过拟合后,准确率也不会得到提高,出现 ...
- 深度学习之基于Tensorflow2.0实现AlexNet网络
在之前的实验中,一直是自己搭建或者是迁移学习进行物体识别,但是没有对某一个网络进行详细的研究,正好人工智能课需要按组上去展示成果,借此机会实现一下比较经典的网络,为以后的研究学习打下基础.本次基于Te ...
- 基于USB3.0、DP1.2的网络隔离数据安全传输方案
根据某省电网设计规划,数据交换区是信息内网(Ⅳ区)与信息外网(Ⅴ区)进行数据交互唯一边界.它的安全性与可用性将是此安全边界建设的重中之重.当前内外网平台性能及可靠性无法满足当前及未来外网业务发展需要, ...
- 第24节 综合网络配置实验（含IP、RIP、VLAN、VTP、HSRP、ACL、NAT等配置完整命令）——基于PacketTracer8.0仿真实验
综合网络配置实验(含IP.RIP.VLAN.VTP.HSRP.ACL.NAT等配置完整命令)--基于PacketTracer8.0仿真实验 1 网络规划 1.1 网络拓扑图 1.2 网络规划 2 实验 ...
- 基于对抗生成网络的滚动轴承故障检测方法
人工智能技术与咨询 点击蓝字 · 关注我们 来源:<人工智能与机器人研究> ,作者华丰 关键词: 不平衡工业时间序列:异常检测:生成对抗网络:滚动轴承数据 关注微信公众号:人工智能技术与咨 ...
- 实战干货：基于Redis6.0 部署迷你版本消息队列
点击关注公众号,实用技术文章及时了解 技术研究背景 由于目前的研发团队处于公司初创阶段,尚未有能成熟的运维体系,对于市面上常见的成熟MQ搭建维护能力不足,但是又希望能有一款轻量级的消息系统供研发团队的 ...
最新文章
- redis日志_「漫画」谈谈Redis持久化
- python如何将生成的随机数存入文件中_用python在excel中读取与生成随机数写入excel中...
- 微机计算机原理姚向华课后答案,微型计算机操作系统
- 【POJ - 1330】Nearest Common Ancestors（lca，模板题）
- 详述白盒测试逻辑覆盖法的语句覆盖及其缺点
- 困扰的问题终于解决了-docker时区不正确的问题修改记
- leach算法 matlab,求助LEACH的MATLAB仿真代码
- Edxposed研究之Magisk源码下载编译的详细实战教程
- WinHex脚本命令教程--中文版
- [转]如何查找最新文献
- python xmind_XMind
- 计算机结构体系-CISC与RISC
- 单边指数信号的特点_方波和单边指数信号的卷积.doc
- JQuery实现图片点击放大
- 红楼梦java_《红楼梦》最经典的12首诗词，读懂了才是人生
- Navicat Premium绿色版安装
- Python自动化测试框架之Pytest相关用法-基本使用（1）
- VMD分解，matlab代码，包络线，包络谱，中心频率，峭度值，能量熵，近似熵，包络熵，频谱图，希尔伯特变换，包含所有程序MATLAB代码，-西储大学数据集为例
- 天河计算机系统内存条,天河一号竟名不副实？
- python动态捕捉屏幕_Python实现屏幕截图的两种方式
热门文章
- pycharm 类型注释_后端开发使用pycharm的技巧
- 关于mysql设置varchar 字段的默认值''和null的区别，以及varchar和char的区别
- python【数据结构与算法】完全背包（附代码）
- Python程序设计题解【蓝桥杯官网题库】 DAY3-基础练习
- Unet实现图像分割（二）
- SQLite基本操作
- python 添加新元素时如果有重复的不进行添加_清华毕业大佬整理的Python基础22大知识点，自备热水，这货有点干...
- java instanceof 原理_java-在现代JVM实现中如何实现instanceof？
- postgresql中代理键
- 网络营销期间选用冷门关键词网络营销效果会好吗？