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

图片发自简书App

有 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。
  1. YTKNetwork 的封装运用了 command 设计模式,有如下几个好处:
  • 将网络请求与具体的第三方库依赖隔离,方便以后更换底层的网络库。实际上 YTKNetwork 最初是基于 ASIHttpRequest 的,我们只花了两天,就很轻松地切换到了 AFNetworking。
  • 方便在基类中处理公共逻辑,例如猿题库的数据版本号信息就统一在基类中处理。
  • 方便在基类中处理缓存逻辑,以及其它一些公共逻辑。
  • 方便做对象的持久化。
  1. 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请求的完整历程

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,968评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,601评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,220评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,416评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,425评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,144评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,432评论 3 401
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,088评论 0 261
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,586评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,028评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,137评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,783评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,343评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,333评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,559评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,595评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,901评论 2 345

推荐阅读更多精彩内容

  • 第一篇第二篇大概是把下载图片缓存图片的这个逻辑走完了,里面涉及好多类。 罗列一下 UIView+WebCache ...
    充满活力的早晨阅读 734评论 0 1
  • AFHTTPRequestOperationManager 网络传输协议UDP、TCP、Http、Socket、X...
    Carden阅读 4,322评论 0 12
  • 技术无极限,从菜鸟开始,从源码开始。 由于公司目前项目还是用OC写的项目,没有升级swift 所以暂时SDWebI...
    充满活力的早晨阅读 12,622评论 0 2
  • 有句话叫做:还没好好享受青春,就变老了。而我想说的是,一切都刚要开始,却要结束了。今天是12月27日了,再过4天,...
    Hi楚梦蝶阅读 159评论 0 0
  • 小时候听大人说鬼故事,每次听完都感觉毛骨悚然。村西头的老胡头,一肚子故事,每到天擦黑,大伙儿都吃过晚饭之后,就开始...
    雾歌阅读 326评论 0 0