AFN3.X研究

使用AFN时在自然不过的一件事了，正如在java中会使用httpClient。AFN3.0开始完全基于NSURLSession了，从此就告别了繁琐的线程操作的一些东西，转而更加关注于请求功能的实现。最近一段时间研究了下AFN3.0，得到一些浅薄的笔记，记录下来。

0. 一句话总结AFN

• 基于NSURLSession的轻量级，用于发送异步请求（get，post，文件上传，下载）的框架。
• 包含了对NSURLRequest的封装，NURLResponse的处理，以及连接的创建、管理，https安全性的配置，网络的监测，UIKit的扩展。
• AFN3.X版本仅仅基于NSURLSession，AFN2.X主流用法还是继续NSURLConnection。3.X比2.X结构更加简单清晰。

1. AFN 是什么

AFN是一个轻量级的框架，它将通用的客户端与服务器的交互的操作封装了起来，包括了请求的创建，请求操作的管理，响应的序列化，网络指示器的监测，安全性，以及UI控件异步加载网络数据的便捷扩展。

2. AFN3.X能干什么

• 发异步请求：
• 文件上传
• 文件下载（小文件，大文件和断点续传等操作目前需要自己封装）
• 网络监听

3.AFN包含什么

AFN3.X的主要功能模块包括：NSURLRequest的构建，NSURLSessionTask的创建和管理，进度的监测回调，结果的回调，响应的序列化处理

    - AFN3.X
        + AFURLSessionManager
            *工厂模式创建Task
            *Task绑定TaskDelegate
            *session代理回调，回调TaskDelegate响应回调
        + AFURLSessionManagerTaskDelegate
            *KVO监测进度，并回调
            *结果回调
        + AFHTTPSessionManager(继承前者封装了常用的 HTTP 方法)
            * GET
            * POST
            * POST constructBody
        + AFURLRequestSerialization 请求的数据格式/默认是二进制的
            *requestWithMethod
            *multipartFormRequestWithMethod
            * requestBySerializingRequest
          +AFJSONRequestSerializer
              * requestBySerializingRequest
          +AFPropertyListRequestSerializer
              * requestBySerializingRequest
       + AFURLResponseSerialization :响应的数据格式/默认是JSON格式
       + AFSecurityPolicy
       + AFNetworkReachabilityManager

• AFHTTPSessionManager的get方法基于NSURLSessionDataTask
• AFHTTPSessionManager的post方法基于NSURLSessionDataTask
• AFHTTPSessionManager的postconstruct方法基于 NSURLSessionUpLoadTask
• NSURLSessionDownLoadTask的封装可以自己实现

4. AFN3.X的功能实现流程

根据请求参数创建请求——发送请求——响应处理

• 输入：NSURLRequest，NSMutableURLRequest，
  NSURLSession，NSOperation，NSOperationQueue
• 输出data，序列化的对象
• KVO监测下载和上传的进度
• AFHTTPSessionManager get方法没有封装DownLoadTask，需要手动实现
• 上传使用的是：uploadTaskWithStreamedRequest ，上传的body使用的
  是request.HTTPBodyStream

1）请求的序列化

目的：根据输入的URL，参数字典，上传数据（可选），构造NSURLRequest。
功能：默认构造为application/x-www-form-urlencodedbody类型的数据。get直接拼接URL，post作为请求体。
子类可以构造application/json和application/x-plist请求数据。设置为httpbodyData。
上传数据形式为multipart/form-data; boundary=XXXX,设置的是httpbodystream
原生没有提供 仅仅上传单个文件，和纯文本body形式的API。但是话说回来，这两种并不常用。
实现：两个关键的方法构造请求：
- requestWithMethod:URLString: parameters:error:此方法调用协议方法requestBySerializingRequest: withParameters:error:
- multipartFormRequestWithMethod:URLString:parameters:constructingBodyWithBlock:error:
前者设置的是httpBody
后者设置是httpBodystream
具体实现细节：待续

2）响应的反序列化

目的：根据得到的NSURLResponse和body data转化为所需要的数据类型。
功能： responseObjectForResponse:response data:error:方法 得到感兴趣的数据类型(id )responseObject：
默认为data，json形式往往为NSDictionary。json的序列化可以设置是否去除null value。没有提供responseString的功能，需要自己转化。
响应默认为json处理形式，响应非json的话一定需要显示的设置为AFURLResponseSerialization类型

3）请求的创建，管理，维护

目的：发送请求，得到响应，处理好进度的回调，请求成功，失败的回调
实现：
GET:parameters: progress:success:failure:
POST:parameters: progress:success:failure:
会调用
dataTaskWithHTTPMethod:URLString:parameters:uploadProgress:downloadProgress: success:failure:
然后调用
dataTaskWithRequest: uploadProgress: downloadProgress: completionHandler（这是工厂方法创建Task的其中之一）
之后
调用
addDelegateForDataTask:uploadProgress: downloadProgress: completionHandler
在这里创建一个自定义的taskDelegate对象，将参数赋值给它。taskDelegate和Task是一一对应的，Task的进度检测，结果的回调完全都是在taskDelegate中进行。
再调用
setDelegate:forTask:这个方法是线程安全的，加上锁的，功能：把delegate放入一个字典中做记录，设置delegate的进度指示，KVO方法监测task的 countOfBytesReceived， countOfBytesExpectedToReceive等属性

Session的代理方法在manager中调用：
manager中每一个代理方法都定义了一个block。调用相应代理方法的时候如果有相应的block就会回调。但是实际上，定义的get和post等方法并未使用。
反而，在代理方法中
调用
delegateForTask:方法(加锁的操作)根据task取得相应的taskDelegate然后回调相应的taskDelegate的方法。
taskDelegate中，KVO回调方法会实时监测进度并回调响应的block
在taskDelegate的 URLSession:task:didCompleteWithError:中
获取到之前拼接的data，根据序列化得到responseObject，response直接取task的属性
然后回调 completionHandler block并发送相应通知。如果不设置 manager.completionQueue，就在main_queue中回调。

最后扫尾工作：移除taskDelegate的KVO和task的通知，保存task和taskDelegate的字典中移除（这个操作也需要加锁）

POST:parameters: constructingBodyWithBlock:progress:success:failure:
调用
uploadTaskWithStreamedRequest:progress:uploadProgressBlock completionHandler:
之后的流程类似
progress回调是在sessionQueue中回调，不是在mainQueue

5.常用的封装

待续

6.需要的背景知识

1)NSURLSession简介

• NSURLSession的创建需要指定模式，代理，和代理的线程队列
• NSURLSession的提供了丰富的构建task的方法，使用block的话就不会回调代理了
• NSURLSessionTask提供了开启，中断，取消的操作，状态，发送接收数据的属性，request，response，error属性，没有data属性
  使用代理的话，需要把data叠加
• NSURLSessionDelegate:session状态的代理回调
• NSURLSessionDataDelegate: dataTask的方法回调
• NSURLSessionTaskDelegate：只要是TASK的方法回调
• NSURLSessionDownLoadTask：downLoadTask的方法回调