YTKNetwork 源码阅读(一)-整体框架

YTKNetwork 源码阅读(一)-整体框架

有 AFNetworking 了，为什么还要用 YTKNetwork ? (以下1、2条文字摘自 YTKNetwork 的 readme)

1. YTKNetwork 是基于 AFNetworking 封装的，提供了一些更高级的功能。

• 支持按时间缓存网络请求内容
• 支持按版本号缓存网络请求内容
• 支持统一设置服务器和 CDN 的地址
• 支持检查返回 JSON 内容的合法性
• 支持文件的断点续传
• 支持 block 和 delegate 两种模式的回调方式
• 支持批量的网络请求发送，并统一设置它们的回调（实现在 YTKBatchRequest 类中）
• 支持方便地设置有相互依赖的网络请求的发送，例如：发送请求 A，根据请求 A 的结果，选择性的发送请求 B 和 C，再根据 B 和 C 的结果，选择性的发送请求 D。（实现在 YTKChainRequest 类中）
• 支持网络请求 URL 的 filter，可以统一为网络请求加上一些参数，或者修改一些路径。
• 定义了一套插件机制，可以很方便地为 YTKNetwork 增加功能。猿题库官方现在提供了一个插件，可以在某些网络请求发起时，在界面上显示“正在加载”的 HUD。

2. YTKNetwork 的封装运用了 command 设计模式，有如下几个好处：

• 将网络请求与具体的第三方库依赖隔离，方便以后更换底层的网络库。实际上 YTKNetwork 最初是基于 ASIHttpRequest 的，我们只花了两天，就很轻松地切换到了 AFNetworking。
• 方便在基类中处理公共逻辑，例如猿题库的数据版本号信息就统一在基类中处理。
• 方便在基类中处理缓存逻辑，以及其它一些公共逻辑。
• 方便做对象的持久化。

3. YTKNetwork 把每个请求都封装成对象，代码组织的时候可以把所有的请求类都放到一个目录底下，我个人是比较喜欢这种组织方式。

说下 YTKNetwork 里面重要的几个类

1. YTKNetworkConfig 存储一些全局的网络配置。比较重要的就是 baseUrl(根URL路径)、cdnUrl(CDN服务器路径)、urlFilters(在请求发送之前，附加到URL路径上的一些公共参数)。

2. YTKRequest 相当于 command 设计模式中的 command。使用过程中，我们通过创建基于 YTKRequest 的网络请求类，重写一些父类的方法来访问后台。他是继承于 YTKBaseRequest。YTKBaseRequest 类提供了开始网络请求的便利方法。

    //YTKBaseRequest 类
   
    //  把一个请求加到队列里面，并且开始这个请求
    - (void)start; // -> 调用 YTKNetworkAgent 的 addRequest: 方法
   
    /// 把一个请求从请求队列里面移除掉，并且取消这个请求。   
    - (void)stop;  // -> 调用 YTKNetworkAgent 的 cancelRequest: 方法
   
    ///  便利请求方法，包含成功和失败的block回调.
    - (void)startWithCompletionBlockWithSuccess:(nullable YTKRequestCompletionBlock)success
                                failure:(nullable YTKRequestCompletionBlock)failure;  // -> 调用 [self start] 并且设置成功和失败的两个回掉
   

3. YTKNetworkAgent 类是一个单例，相当于 command 设计模式中的接收器，发出指令的对象和被调用的对象就是通过它来实现解耦的。网络请求的操作是在这里开始的。

    //YTKNetworkAgent 类
   
    ///  添加一个网络请求并开始
    - (void)addRequest:(YTKBaseRequest *)request;
    ///  取消之前添加的一个网络请求
    - (void)cancelRequest:(YTKBaseRequest *)request;
    ///  取消之前添加的所有网络请求
    - (void)cancelAllRequests;
   

4. YTKNetworkPrivate 类包含了一个工具类和一些 extension

    //YTKNetworkUtils 
    // 验证json的有效性
    + (BOOL)validateJSON:(id)json withValidator:(id)jsonValidator;
    // 阻止 iTunes 在应用中保存数据
    + (void)addDoNotBackupAttribute:(NSString *)path;
    // 对字符串进行 md5 加密
    + (NSString *)md5StringFromString:(NSString *)string;
    // 获取 app 的版本号
    + (NSString *)appVersionString;
   

5. YTKBatchRequest 用于方便的发送批量的请求。它是一个容器类，可以放置多个继承于 YTKRequest 的请求实例。

    // 通过一个请求数组创建一个 batch 请求
    - (instancetype)initWithRequestArray:(NSArray<YTKRequest *> *)requestArray;
    // 开始这个 batch 请求
     - (void)startWithCompletionBlockWithSuccess:(nullable void (^)(YTKBatchRequest *batchRequest))success
                                failure:(nullable void (^)(YTKBatchRequest *batchRequest))failure;
   

6. YTKChainRequest 用于管理相互之间有依赖的多个请求。

    // YTKChainRequest
    //添加一个请求并开始
    - (void)addRequest:(YTKBaseRequest *)request callback:(nullable YTKChainCallback)callback;
   
    // 官方示例: 
    - (void)sendChainRequest {
        // 创建一个注册的请求
        RegisterApi *reg = [[RegisterApi alloc] initWithUsername:@"username" password:@"password"]; 
        // 创建 chain 请求实例
        YTKChainRequest *chainReq = [[YTKChainRequest alloc] init];
        // 开始注册请求
        [chainReq addRequest:reg callback:^(YTKChainRequest *chainRequest, YTKBaseRequest *baseRequest) {
            RegisterApi *result = (RegisterApi *)baseRequest;
            NSString *userId = [result userId];
            //注册请求完成，开始获取个人信息的请求
            GetUserInfoApi *api = [[GetUserInfoApi alloc] initWithUserId:userId];
            [chainRequest addRequest:api callback:nil]; //这里仍然调用了 addRequest:callback: 方法,回调为nil
   
        }];
        chainReq.delegate = self;
        // start to send request
        [chainReq start];
    }
   
    // YTKChainRequestDelegate  代理
   
    // 所有 chain 请求完成的回调
    - (void)chainRequestFinished:(YTKChainRequest *)chainRequest;
   
    // 某个 chain 请求失败的回调
    - (void)chainRequestFailed:(YTKChainRequest *)chainRequest failedBaseRequest:(YTKBaseRequest*)request;
   

---

YTKNetwork 源码阅读(二)-一次POST请求的完整历程