AFN二次封装

前言

对于开发人员来说，学习网络层知识是必备的，任何一款App的开发，都需要到网络请求接口。很多朋友都还在使用原生的NSURLConnection一行一行地写，代码到处是，这样维护起来更困难了。

对于使用AFNetworking的朋友来说，很多朋友都是直接调用AFNetworking的API，这样不太好，无法做到全工程统一配置。

最好的方式就是对网络层再封装一层，全工程不允许直接使用AFNetworking的API，必须调用我们自己封装的一层，如此一来，任何网络配置都可以在这一层里配置好，使用的人无须知道里面在干嘛，只管调用就可以了。

本篇讲解的是基于AFNetworkging2.5.2版本的网络封装，支持iOS6.若不需要支持iOS6，可选择基于AFNetworking3.0的网络封装：http://www.henishuo.com/base-on-afnetworking3-0-wrapper/

常用接口类型

应用开发过程中，所使用类型通常是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?categoryid=1 *  @param success 接口成功请求到数据的回调 *  @param fail    接口请求数据失败的回调 * *  @return 返回的对象中有可取消请求的API */ + ( HYBRequestOperation * ) getWithUrl : ( NSString * ) url                             success : ( HYBResponseSuccess ) success                                fail : ( HYBResponseFail ) fail ; /*! *  @author 黄仪标, 15-11-15 13:11:50 * *  GET请求接口，若不指定baseurl，可传完整的url * *  @param url     接口路径，如/path/getArticleList *  @param params  接口中所需要的拼接参数，如@{"categoryid" : @(12)} *  @param success 接口成功请求到数据的回调 *  @param fail    接口请求数据失败的回调 * *  @return 返回的对象中有可取消请求的API */ + ( HYBRequestOperation * ) getWithUrl : ( NSString * ) url                              params : ( NSDictionary * ) params                             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

/*! *  @author 黄仪标, 15-11-15 13:11:50 * *  POST请求接口，若不指定baseurl，可传完整的url * *  @param url     接口路径，如/path/getArticleList *  @param params  接口中所需的参数，如@{"categoryid" : @(12)} *  @param success 接口成功请求到数据的回调 *  @param fail    接口请求数据失败的回调 * *  @return 返回的对象中有可取消请求的API */ + ( HYBRequestOperation * ) postWithUrl : ( NSString * ) url                               params : ( NSDictionary * ) params                              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

/*! *  @author 黄仪标, 15-11-15 13:11:39 * *  图片上传接口，若不指定baseurl，可传完整的url * *  @param image    图片对象 *  @param url      上传图片的接口路径，如/path/images/ *  @param filename 给图片起一个名字，默认为当前日期时间,格式为"yyyyMMddHHmmss"，后缀为`jpg` *  @param name     与指定的图片相关联的名称，这是由后端写接口的人指定的，如imagefiles *  @param success  上传成功的回调 *  @param fail     上传失败的回调 * *  @return 返回类型有取消请求的api */ + ( HYBRequestOperation * ) uploadWithImage : ( UIImage * ) image                                      url : ( NSString * ) url                                 filename : ( NSString * ) filename                                     name : ( NSString * ) name                                  success : ( HYBResponseSuccess ) success                                     fail : ( HYBResponseFail ) fail ;

设置基础URL

这里还提供了两个公共接口，一个是用于设置或者更新网络接口的基础URL，一个是获取当前设置使用的网络接口基础URL。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22

/*! *  @author 黄仪标, 15-11-15 13:11:45 * *  用于指定网络请求接口的基础url，如： *  http://henishuo.com或者http://101.200.209.244 *  通常在AppDelegate中启动时就设置一次就可以了。如果接口有来源 *  于多个服务器，可以调用更新 * *  @param baseUrl 网络接口的基础url */ + ( void ) updateBaseUrl : ( NSString * ) baseUrl ;   /*! *  @author 黄仪标, 15-11-15 13:11:06 * *  对外公开可获取当前所设置的网络接口基础url * *  @return 当前基础url */ + ( NSString * ) baseUrl ;

添加公共请求头参数

id="iframeu2513605_1" src="http://pos.baidu.com/acom?rdid=2513605&dc=2&di=u2513605&dri=1&dis=0&dai=2&ps=3264x378&dcb=BAIDU_UNION_define&dtm=BAIDU_DUP_SETJSONADSLOT&dvi=0.0&dci=-1&dpt=none&tsr=0&tpr=1456451592841&ti=%E5%9F%BA%E4%BA%8EAFNetworking2.5%E5%B0%81%E8%A3%85%E7%BD%91%E7%BB%9C%E5%BA%93%20%7C%20%E6%A0%87%E5%93%A5%E7%9A%84%E6%8A%80%E6%9C%AF%E5%8D%9A%E5%AE%A2&ari=1&dbv=2&drs=1&pcs=1423x775&pss=1423x3312&cfv=17&cpl=10&chi=2&cce=true&cec=UTF-8&tlm=1456451592&ltu=http%3A%2F%2Fwww.henishuo.com%2Fbase-on-afnetworking-wrapper%2F&ltr=http%3A%2F%2Fwww.henishuo.com%2F&ecd=1&psr=1440x900&par=1440x860&pis=-1x-1&ccd=24&cja=true&cmi=13&col=zh-CN&cdo=-1&tcn=1456451593&qn=cf6edbf500fbe909&tt=1456451592820.65.212.214" width="760" height="90" align="center,center" vspace="0" hspace="0" marginwidth="0" marginheight="0" scrolling="no" frameborder="0" allowtransparency="true" style="-webkit-tap-highlight-color: rgba(255, 0, 0, 0); border-width: 0px; font-family: inherit; font-style: inherit; font-weight: inherit; margin: 0px; outline: 0px; padding: 0px; vertical-align: bottom; max-width: 100%;">

通常每家公司的接口都会设置公共的请求头参数，以代表是公司的接口。默认已经配置了可接收的类型，但是如果需要额外配置，可通过调用此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 17 18 19

/*! *  @author 黄仪标, 15-12-25 15:12:38 * *  配置返回格式，默认为JSON。若为XML或者PLIST请在全局修改一下 * *  @param responseType 响应格式 */ + ( void ) configResponseType : ( HYBResponseType ) responseType ;   /*! *  @author 黄仪标, 15-12-25 15:12:45 * *  配置请求格式，默认为JSON。如果要求传XML或者PLIST，请在全局配置一下 * *  @param requestType 请求格式 */ + ( void ) configRequestType : ( HYBRequestType ) requestType ;

URL编码问题

考虑到网络请求接口中，有时候会有中文参数，这时候就会请求失败，因此我们要对这种类型的URL进行编码，否则请求会失败。这里是开启或者关闭自动将URL编码的接口，默认为NO，表示不开启。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

/*! *  @author 黄仪标, 15-11-15 14:11:40 * *  开启或关闭接口打印信息 * *  @param isDebug 开发期，最好打开，默认是NO */ + ( void ) enableInterfaceDebug : ( BOOL ) isDebug ;   /*! *  @author 黄仪标, 15-11-15 15:11:16 * *  开启或关闭是否自动将URL使用UTF8编码，用于处理链接中有中文时无法请求的问题 * *  @param shouldAutoEncode YES or NO,默认为NO */ + ( void ) shouldAutoEncodeUrl : ( BOOL ) shouldAutoEncode ;

网络接口数据日志

对于网络请求回来的结果，如果没有一个格式化好的日志打印出来查看，就要通过断点一步步跟踪，然后打开出来看，这太麻烦。因此，这里提供了打印日志的私有API。默认是不开启打印日志的。

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 9

// 项目打包上线都不会打印日志，因此可放心。 #ifdef DEBUG #define HYBAppLog(s, ... ) NSLog( @"[%@：in line: %d]-->[message: %@]", [[NSString stringWithUTF8String:__FILE__] lastPathComponent], __LINE__, [NSString stringWithFormat:(s), ##__VA_ARGS__] ) #else #define HYBAppLog(s, ... ) #endif