对于大多数app来说,业务量到一定级别,为了可维护性和框架的合理性,通常都需要设计专门的网络层,将业务逻辑中的所有网络请求封装在这一层,便于统一维护。
YTKNetwork是一种分散型的网络三房库,因为它考虑了业务网络层复杂的程序设计上问题,通过命令模式来讲每一个网络请求对象化,相对于每个网络请求都独立成一个类,互相之间隔离。另外,它还提供了如缓存、统一设置、校验请求的响应内容等多方面内容,给我们设计网络层提供了一种新思路。下面主要分析下源码中值得学习的地方:
对于源码,我们应该先从基类看起,也就是YTKBaseRequest:
YTKBaseRequest
- 这个类头文件从NS_ASSUME_NONNULL_BEGIN开始,表示到NS_ASSUME_NONNULL_END之间的所有简单指针对象都被假定为nonnull。
- 定义了两个协议YTKRequestDelegate 和YTKRequestAccessory,用来跟踪请求的进程:
@protocol YTKRequestDelegate <NSObject>
@optional
- (void)requestFinished:(__kindof YTKBaseRequest *)request;
- (void)requestFailed:(__kindof YTKBaseRequest *)request;
@end
@protocol YTKRequestAccessory <NSObject>
@optional
- (void)requestWillStart:(id)request;
- (void)requestWillStop:(id)request;
- (void)requestDidStop:(id)request;
@end```
3. 定义了一系列子类需要覆盖的方法,并且在m文件中将这些方法都写出并带有返回值,避免子类不覆盖这些方法,内部又调用到这些方法时造成找不到selector的crash;
4. 通过__has_include判断AFNetworking的引入方式是framework还是源码,来决定import时使用<>还是"";
if __has_include(<AFNetworking/AFNetworking.h>)
import <AFNetworking/AFNetworking.h>
else
import "AFNetworking.h"
endif```
- 提供了clearCompletionBlock方法,可以在适当时刻清除作为内部属性block强引用外部的实例,可能提高内存利用率,减少长期占用;
- start方法中会调用网络请求的类YTKNetworkAgent和当前类的扩展(定义在YTKNetworkPrivate类中)来实现进程的代理形式调用:
- (void)start
{
[self toggleAccessoriesWillStartCallBack];
[[YTKNetworkAgent sharedAgent] addRequest:self];
}
YTKRequest
继承了YTKBaseRequest,并额外实现了缓存的存储和读取在网络请求时的处理。
- 首先错误码的定义,我们可以学习其使用负数来逐个枚举值,这样代码中可能通过是否<0 ,就可以最快判断是否有错误:
NS_ENUM(NSInteger) {
YTKRequestCacheErrorExpired = -1,
YTKRequestCacheErrorVersionMismatch = -2,
YTKRequestCacheErrorSensitiveDataMismatch = -3,
YTKRequestCacheErrorAppVersionMismatch = -4,
YTKRequestCacheErrorInvalidCacheTime = -5,
YTKRequestCacheErrorInvalidMetadata = -6,
YTKRequestCacheErrorInvalidCacheData = -7,
};
- 定义了一个优先级低的线程的串行队列,保证所有请求在这个线程中, 将用于将缓存写入文件时使用,保证不占用cpu主线程资源,即使多个请求并发,也会使用这个标识了统一符号的同一个线程,避免了使用过多子线程,同样占用过多资源。
static dispatch_queue_t ytkrequest_cache_writing_queue() {
static dispatch_queue_t queue;
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
dispatch_queue_attr_t attr = DISPATCH_QUEUE_SERIAL;
// mm 定义为优先级最低的线程串行队列
if (NSFoundationVersionNumber >= NSFoundationVersionNumber_With_QoS_Available) {
attr = dispatch_queue_attr_make_with_qos_class(attr, QOS_CLASS_BACKGROUND, 0);
}
queue = dispatch_queue_create("com.yuantiku.ytkrequest.caching", attr);
});
return queue;
}
- (void)requestCompletePreprocessor {
[super requestCompletePreprocessor];
if (self.writeCacheAsynchronously) {
dispatch_async(ytkrequest_cache_writing_queue(), ^{
[self saveResponseDataToCacheFile:[super responseData]];
});
} else {
[self saveResponseDataToCacheFile:[super responseData]];
}
}```
3. 遵守了NSSecureCoding的缓存的元数据类YTKCacheMetadata。NSSecureCoding有何用?
NSCoding是iOS上把模型对象直接转变成一个文件,然后再把这个文件重新加载到内存里一种极其简单和方便的方式,它并不需要任何文件解析和序列化的逻辑。如果要把对象保存到一个数据文件中(假设这个对象实现了NSCoding协议),那么你可以像下面这样做:
[NSKeyedArchiver archiveRootObject:xxx toFile:someFile];
XXX *xxx = [NSKeyedUnarchiver unarchiveObjectWithFile:someFile];
这样做对于编译进APP里的mainbundle中的资源(nib等)来说是可以的,但是使用NSCoding来读写用户数据文件的问题在于,把全部的类编码到一个文件里,也就间接地给了这个文件访问你APP里面实例类的权限,存在安全风险。苹果引入了基于NSCoding的NSSecureCoding。除了在解码时要同时指定key和要解码的对象的类,如果要求的类和从文件中解码出的对象的类不匹配,NSCoder会抛出异常,告诉你数据已经被篡改了。
#YTKNetworkConfig
YTKNetworkConfig是对这个app中使用了YTKNetwork发起请求的所有请求的统一配置中心,这里可以配置如统一的参数过滤、baseurl、cdnurl等。
#YTKNetworkAgent
YTKNetworkAgent是一个网络请求的单例,内部的请求是通过AFHTTPSessionManager来发出的。其中
- (void)addRequest:(YTKBaseRequest *)request
接口会将当前请求启动,并记录下这次请求的信息。
1. 断点继续下载:此类保存了上次下载未完成的文件,再次下载同一个文件时,优先考虑继续上次下载的位置。
#YTKBatchRequest
YTKBatchRequest类实现批量请求,并YTKBatchRequestAgent通过管理(添加和删除)所有请求,当批量请求开始时将遍历YTKBatchRequestAgent保存的所有请求,逐个开始。 遗憾的是,这里的源码并没有对并发的线程做任何管理,如并发数目等限制。
#YTKChainRequest
YTKChainRequest顾名思义是链式请求,也就是请求之间互相依赖,串行发出。和批量请求相似的,通过一个YTKBatchRequestAgent来管理这些依赖的请求。内部通过_nextRequestIndex来索引正在进行和下一个将要处理的请求,每次上一个请求成功回调回来,才开始下一个链式的请求。