AFN二次封装

矫情吗；* 2022-08-20 12:06 249阅读 0赞

# 前言 #

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

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

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

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

# 常用接口类型 #

应用开发过程中，所使用类型通常是`GET`、`POST`及上传图片。因此，这里只是对这几种类型提供`API`。

## GET接口 ##

这里提供了两个`GET`请求的`API`，需要一般情况下`GET`请求都是直接写一个完整的`URL`，但是有时候为了参数可读性更强，改成传一个字典过来更容易阅读。

`HYBResponseSuccess`是响应成功的回调，返回的是字典，外部再转换成模型就可以了。  
`HYBResponseFail`是响应失败的回调，只有一个`NSError`对象，外部可接收处理。

<table style=""> 
 <tbody style=""> 
  <tr style=""> 
   <td style=""> 
    <div style=""> 
     <div style="">
       1 
     </div> 
     <div style="">
       2 
     </div> 
     <div style="">
       3 
     </div> 
     <div style="">
       4 
     </div> 
     <div style="">
       5 
     </div> 
     <div style="">
       6 
     </div> 
     <div style="">
       7 
     </div> 
     <div style="">
       8 
     </div> 
     <div style="">
       9 
     </div> 
     <div style="">
       10 
     </div> 
     <div style="">
       11 
     </div> 
     <div style="">
       12 
     </div> 
     <div style="">
       13 
     </div> 
     <div style="">
       14 
     </div> 
     <div style="">
       15 
     </div> 
     <div style="">
       16 
     </div> 
     <div style="">
       17 
     </div> 
     <div style="">
       18 
     </div> 
     <div style="">
       19 
     </div> 
     <div style="">
       20 
     </div> 
     <div style="">
       21 
     </div> 
     <div style="">
       22 
     </div> 
     <div style="">
       23 
     </div> 
     <div style="">
       24 
     </div> 
     <div style="">
       25 
     </div> 
     <div style="">
       26 
     </div> 
     <div style="">
       27 
     </div> 
     <div style="">
       28 
     </div> 
     <div style="">
       29 
     </div> 
     <div style="">
       30 
     </div> 
     <div style="">
       31 
     </div> 
     <div style="">
       32 
     </div> 
    </div> </td> 
   <td style=""> 
    <div style=""> 
     <div style="">
       &nbsp; 
     </div> 
     <div style=""> 
      <span style="">/*!</span> 
     </div> 
     <div style=""> 
      <span style="">*&nbsp;&nbsp;@author 黄仪标, 15-11-15 13:11:50</span> 
     </div> 
     <div style=""> 
      <span style="">*</span> 
     </div> 
     <div style=""> 
      <span style="">*&nbsp;&nbsp;GET请求接口，若不指定baseurl，可传完整的url</span> 
     </div> 
     <div style=""> 
      <span style="">*</span> 
     </div> 
     <div style=""> 
      <span style="">*&nbsp;&nbsp;@param url&nbsp;&nbsp;&nbsp;&nbsp; 接口路径，如/path/getArticleList?categoryid=1</span> 
     </div> 
     <div style=""> 
      <span style="">*&nbsp;&nbsp;@param success 接口成功请求到数据的回调</span> 
     </div> 
     <div style=""> 
      <span style="">*&nbsp;&nbsp;@param fail&nbsp;&nbsp;&nbsp;&nbsp;接口请求数据失败的回调</span> 
     </div> 
     <div style=""> 
      <span style="">*</span> 
     </div> 
     <div style=""> 
      <span style="">*&nbsp;&nbsp;@return 返回的对象中有可取消请求的API</span> 
     </div> 
     <div style=""> 
      <span style="">*/</span> 
     </div> 
     <div style=""> 
      <span style="">+</span> 
      <span style=""> </span> 
      <span style="">(</span> 
      <span style="">HYBRequestOperation</span> 
      <span style=""> </span> 
      <span style="">*</span> 
      <span style="">)</span> 
      <span style="">getWithUrl</span> 
      <span style="">:</span> 
      <span style="">(</span> 
      <span style="">NSString</span> 
      <span style=""> </span> 
      <span style="">*</span> 
      <span style="">)</span> 
      <span style="">url</span> 
     </div> 
     <div style=""> 
      <span style="">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;success</span> 
      <span style="">:</span> 
      <span style="">(</span> 
      <span style="">HYBResponseSuccess</span> 
      <span style="">)</span> 
      <span style="">success</span> 
     </div> 
     <div style=""> 
      <span style="">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; fail</span> 
      <span style="">:</span> 
      <span style="">(</span> 
      <span style="">HYBResponseFail</span> 
      <span style="">)</span> 
      <span style="">fail</span> 
      <span style="">;</span> 
     </div> 
     <div style=""> 
      <span style="">/*!</span> 
     </div> 
     <div style=""> 
      <span style="">*&nbsp;&nbsp;@author 黄仪标, 15-11-15 13:11:50</span> 
     </div> 
     <div style=""> 
      <span style="">*</span> 
     </div> 
     <div style=""> 
      <span style="">*&nbsp;&nbsp;GET请求接口，若不指定baseurl，可传完整的url</span> 
     </div> 
     <div style=""> 
      <span style="">*</span> 
     </div> 
     <div style=""> 
      <span style="">*&nbsp;&nbsp;@param url&nbsp;&nbsp;&nbsp;&nbsp; 接口路径，如/path/getArticleList</span> 
     </div> 
     <div style=""> 
      <span style="">*&nbsp;&nbsp;@param params&nbsp;&nbsp;接口中所需要的拼接参数，如@{"categoryid" : @(12)}</span> 
     </div> 
     <div style=""> 
      <span style="">*&nbsp;&nbsp;@param success 接口成功请求到数据的回调</span> 
     </div> 
     <div style=""> 
      <span style="">*&nbsp;&nbsp;@param fail&nbsp;&nbsp;&nbsp;&nbsp;接口请求数据失败的回调</span> 
     </div> 
     <div style=""> 
      <span style="">*</span> 
     </div> 
     <div style=""> 
      <span style="">*&nbsp;&nbsp;@return 返回的对象中有可取消请求的API</span> 
     </div> 
     <div style=""> 
      <span style="">*/</span> 
     </div> 
     <div style=""> 
      <span style="">+</span> 
      <span style=""> </span> 
      <span style="">(</span> 
      <span style="">HYBRequestOperation</span> 
      <span style=""> </span> 
      <span style="">*</span> 
      <span style="">)</span> 
      <span style="">getWithUrl</span> 
      <span style="">:</span> 
      <span style="">(</span> 
      <span style="">NSString</span> 
      <span style=""> </span> 
      <span style="">*</span> 
      <span style="">)</span> 
      <span style="">url</span> 
     </div> 
     <div style=""> 
      <span style="">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; params</span> 
      <span style="">:</span> 
      <span style="">(</span> 
      <span style="">NSDictionary</span> 
      <span style=""> </span> 
      <span style="">*</span> 
      <span style="">)</span> 
      <span style="">params</span> 
     </div> 
     <div style=""> 
      <span style="">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;success</span> 
      <span style="">:</span> 
      <span style="">(</span> 
      <span style="">HYBResponseSuccess</span> 
      <span style="">)</span> 
      <span style="">success</span> 
     </div> 
     <div style=""> 
      <span style="">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; fail</span> 
      <span style="">:</span> 
      <span style="">(</span> 
      <span style="">HYBResponseFail</span> 
      <span style="">)</span> 
      <span style="">fail</span> 
      <span style="">;</span> 
     </div> 
     <div style="">
       &nbsp; 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

## POST接口 ##

对于`POST`请求类型的接口，只有一个，看注释就可以明白如何使用了。

## 图片上传接口 ##

接口一次只能上传一张图片，通常也是这么处理的。这里是以文件流的形式来上传的哦。其中，`mineType`为`image/jpeg`。

<table style=""> 
 <tbody style=""> 
  <tr style=""> 
   <td style=""> 
    <div style=""> 
     <div style="">
       1 
     </div> 
     <div style="">
       2 
     </div> 
     <div style="">
       3 
     </div> 
     <div style="">
       4 
     </div> 
     <div style="">
       5 
     </div> 
     <div style="">
       6 
     </div> 
     <div style="">
       7 
     </div> 
     <div style="">
       8 
     </div> 
     <div style="">
       9 
     </div> 
     <div style="">
       10 
     </div> 
     <div style="">
       11 
     </div> 
     <div style="">
       12 
     </div> 
     <div style="">
       13 
     </div> 
     <div style="">
       14 
     </div> 
     <div style="">
       15 
     </div> 
     <div style="">
       16 
     </div> 
     <div style="">
       17 
     </div> 
     <div style="">
       18 
     </div> 
     <div style="">
       19 
     </div> 
     <div style="">
       20 
     </div> 
     <div style="">
       21 
     </div> 
     <div style="">
       22 
     </div> 
    </div> </td> 
   <td style=""> 
    <div style=""> 
     <div style="">
       &nbsp; 
     </div> 
     <div style=""> 
      <span style="">/*!</span> 
     </div> 
     <div style=""> 
      <span style="">*&nbsp;&nbsp;@author 黄仪标, 15-11-15 13:11:39</span> 
     </div> 
     <div style=""> 
      <span style="">*</span> 
     </div> 
     <div style=""> 
      <span style="">*&nbsp;&nbsp;图片上传接口，若不指定baseurl，可传完整的url</span> 
     </div> 
     <div style=""> 
      <span style="">*</span> 
     </div> 
     <div style=""> 
      <span style="">*&nbsp;&nbsp;@param image&nbsp;&nbsp;&nbsp;&nbsp;图片对象</span> 
     </div> 
     <div style=""> 
      <span style="">*&nbsp;&nbsp;@param url&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;上传图片的接口路径，如/path/images/</span> 
     </div> 
     <div style=""> 
      <span style="">*&nbsp;&nbsp;@param filename 给图片起一个名字，默认为当前日期时间,格式为"yyyyMMddHHmmss"，后缀为`jpg`</span> 
     </div> 
     <div style=""> 
      <span style="">*&nbsp;&nbsp;@param name&nbsp;&nbsp;&nbsp;&nbsp; 与指定的图片相关联的名称，这是由后端写接口的人指定的，如imagefiles</span> 
     </div> 
     <div style=""> 
      <span style="">*&nbsp;&nbsp;@param success&nbsp;&nbsp;上传成功的回调</span> 
     </div> 
     <div style=""> 
      <span style="">*&nbsp;&nbsp;@param fail&nbsp;&nbsp;&nbsp;&nbsp; 上传失败的回调</span> 
     </div> 
     <div style=""> 
      <span style="">*</span> 
     </div> 
     <div style=""> 
      <span style="">*&nbsp;&nbsp;@return 返回类型有取消请求的api</span> 
     </div> 
     <div style=""> 
      <span style="">*/</span> 
     </div> 
     <div style=""> 
      <span style="">+</span> 
      <span style=""> </span> 
      <span style="">(</span> 
      <span style="">HYBRequestOperation</span> 
      <span style=""> </span> 
      <span style="">*</span> 
      <span style="">)</span> 
      <span style="">uploadWithImage</span> 
      <span style="">:</span> 
      <span style="">(</span> 
      <span style="">UIImage</span> 
      <span style=""> </span> 
      <span style="">*</span> 
      <span style="">)</span> 
      <span style="">image</span> 
     </div> 
     <div style=""> 
      <span style="">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; url</span> 
      <span style="">:</span> 
      <span style="">(</span> 
      <span style="">NSString</span> 
      <span style=""> </span> 
      <span style="">*</span> 
      <span style="">)</span> 
      <span style="">url</span> 
     </div> 
     <div style=""> 
      <span style="">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;filename</span> 
      <span style="">:</span> 
      <span style="">(</span> 
      <span style="">NSString</span> 
      <span style=""> </span> 
      <span style="">*</span> 
      <span style="">)</span> 
      <span style="">filename</span> 
     </div> 
     <div style=""> 
      <span style="">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;name</span> 
      <span style="">:</span> 
      <span style="">(</span> 
      <span style="">NSString</span> 
      <span style=""> </span> 
      <span style="">*</span> 
      <span style="">)</span> 
      <span style="">name</span> 
     </div> 
     <div style=""> 
      <span style="">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; success</span> 
      <span style="">:</span> 
      <span style="">(</span> 
      <span style="">HYBResponseSuccess</span> 
      <span style="">)</span> 
      <span style="">success</span> 
     </div> 
     <div style=""> 
      <span style="">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;fail</span> 
      <span style="">:</span> 
      <span style="">(</span> 
      <span style="">HYBResponseFail</span> 
      <span style="">)</span> 
      <span style="">fail</span> 
      <span style="">;</span> 
     </div> 
     <div style="">
       &nbsp; 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

## 设置基础URL ##

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

## 添加公共请求头参数 ##

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`来添加：

## 请求与响应格式设置 ##

默认responseType和requestType都是JSON格式。如果不使用JSON，可以全局配置成自己希望的格式即可。若不配置，默认就是JSON。

## URL编码问题 ##

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

## 网络接口数据日志 ##

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

通常在`AppDelegate`中应用启动的代理方法中调用设置为开启就可以了。不过是否设置为开启，当应用以发布证书打包时，都不会打印日志，因为这里做了处理，可放心使用。

[http_www.henishuo.com_base-on-afnetworking3-0-wrapper]: http://www.henishuo.com/base-on-afnetworking3-0-wrapper/