AFNetworking的二次封装

重复请求问题

为了刷新数据或者加载更多数据,用户会触发上下拉刷新,当网络状态不好的时候,用户可能会不断地去刷新,这样会触发很多个重复的网络请求,回调逻辑会触发很多次,不作处理的话,不仅会浪费用户流量,还会造成数据错乱(数据列表存在很多重复的数据)。

原有的AFNetworking没有提供直接的方法解决上面的问题,所以我在AFNetworking3.0的基础上做了一层封装,github
框架架构
这里写图片描述
XDNetworking:提供调用的API
RequestManager目录:存放请求管理相关的类
Cache目录:存放缓存管理相关的类
AFSourceCore目录:存放AFNetworking的源码

API设计

API面向业务更加友好,回调方式采用block,基础功能包括GET、POST、下载、单文件上传、多文件上传、请求管理、缓存管理

GET请求

+ (XDURLSessionTask *)getWithUrl:(NSString *)url
                  refreshRequest:(BOOL)refresh
                           cache:(BOOL)cache
                          params:(NSDictionary *)params
                   progressBlock:(XDGetProgress)progressBlock
                    successBlock:(XDResponseSuccessBlock)successBlock
                       failBlock:(XDResponseFailBlock)failBlock;

POST

+ (XDURLSessionTask *)postWithUrl:(NSString *)url
                   refreshRequest:(BOOL)refresh
                            cache:(BOOL)cache
                           params:(NSDictionary *)params
                    progressBlock:(XDPostProgress)progressBlock
                     successBlock:(XDResponseSuccessBlock)successBlock
                        failBlock:(XDResponseFailBlock)failBlock;

Download

+ (XDURLSessionTask *)downloadWithUrl:(NSString *)url
                        progressBlock:(XDDownloadProgress)progressBlock
                         successBlock:(XDDownloadSuccessBlock)successBlock
                            failBlock:(XDDownloadFailBlock)failBlock;

Upload

+ (XDURLSessionTask *)uploadFileWithUrl:(NSString *)url
                               fileData:(NSData *)data
                                   type:(NSString *)type
                                   name:(NSString *)name
                               mimeType:(NSString *)mimeType
                          progressBlock:(XDUploadProgressBlock)progressBlock
                           successBlock:(XDResponseSuccessBlock)successBlock
                              failBlock:(XDResponseFailBlock)failBlock;

请求管理相关

/**
 *  正在运行的网络任务
 *
 *  @return 
 */
+ (NSArray *)currentRunningTasks;
/**
 *  取消GET请求
 */
+ (void)cancelRequestWithURL:(NSString *)url;
/**
 *  取消所有请求
 */
+ (void)cancleAllRequest;

缓存相关

@interface XDNetworking (cache)
/**
 *  获取缓存目录路径
 *  @return 缓存目录路径
 */
+ (NSString *)getCacheDiretoryPath;

/**
 *  获取下载目录路径
 *  @return 下载目录路径
 */
+ (NSString *)getDownDirectoryPath;

/**
 *  获取缓存大小
 *  @return 缓存大小
 */
+ (NSUInteger)totalCacheSize;

/**
 *  清除所有缓存
 */
+ (void)clearTotalCache;

/**
 *  获取所有下载数据大小
 *  @return 下载数据大小
 */
+ (NSUInteger)totalDownloadDataSize;

/**
 *  清除下载数据
 */
+ (void)clearDownloadData;
@end

重复请求管理

大家会发现GET和POST的API有refresh参数,这个参数的主要目的是用于刷新请求,当遇到重复请求时,若为YES,则会取消旧的请求,用新的请求,若为NO,则忽略新请求,用旧请求,大家针对自己的业务需求自己取舍。下面我给大家分析是如何判断重复和刷新请求的。
大家可以点进GET请求或者POST请求的源码查看他的判断方法:

if ([self haveSameRequestInTasksPool:session] && !refresh) {
        //取消新请求
        [session cancel];
        return session;
    }else {
        //无论是否有旧请求,先执行取消旧请求,反正都需要刷新请求
        XDURLSessionTask *oldTask = [self cancleSameRequestInTasksPool:session];
        if (oldTask) [[self allTasks] removeObject:oldTask];
        if (session) [[self allTasks] addObject:session];
        [session resume];
        return session;
    }

判断的相关逻辑在XDNetworking+requestManager.h这个分类文件中,大家可以看下它提供的API,注释在代码中:

/**
 *  判断网络请求池中是否有相同的请求
 *
 *  @param task 网络请求任务
 *
 *  @return
 */
+ (BOOL)haveSameRequestInTasksPool:(XDURLSessionTask *)task;
/**
 *  如果有旧请求则取消旧请求
 *
 *  @param task 新请求
 *
 *  @return 旧请求
 */
+ (XDURLSessionTask *)cancleSameRequestInTasksPool:(XDURLSessionTask *)task;

判断一个请求是否重复,也就是判断新来的请求和旧的请求是否一样,判断的依据有以下几点:
1、请求的方法是否相同,是否同为GET或者同为POST;
2、请求的url是否相同,如果是GET请求,到这一步就可以做出判断了,如果是POST请求,则还需进行下一步的验证;
3、请求体的内容是否相同(POST请求的参数放在HTTP body里);
于是我为NSURLRequest拓展一个分类用于判断请求异同:

@implementation NSURLRequest (decide)

- (BOOL)isTheSameRequest:(NSURLRequest *)request {
    if ([self.HTTPMethod isEqualToString:request.HTTPMethod]) {
        if ([self.URL.absoluteString isEqualToString:request.URL.absoluteString]) {
            if ([self.HTTPMethod isEqualToString:@"GET"]||[self.HTTPBody isEqualToData:request.HTTPBody]) {
                return YES;
            }
        }
    }
    return NO;
}
@end

于是乎,我们可以遍历XDNetworking当前的运行任务(调用currentRunningTasks获取当前的运行任务),根据任务源请求判断新来的请求,是否已经有相同的请求正在执行当中:

+ (BOOL)haveSameRequestInTasksPool:(XDURLSessionTask *)task {
    __block BOOL isSame = NO;
    [[self currentRunningTasks] enumerateObjectsUsingBlock:^(XDURLSessionTask *obj, NSUInteger idx, BOOL * _Nonnull stop) {
        if ([task.originalRequest isTheSameRequest:obj.originalRequest]) {
            isSame  = YES;
            *stop = YES;
        }
    }];
    return isSame;
}

取消旧请求的逻辑也很容易实现,遍历获取重复的请求,调用它的cancle方法就取消旧请求了。

//有重复的请求并且refresh = YES
//得到重复的旧请求
XDURLSessionTask *oldTask = [self cancleSameRequestIntasksPool:session];
//取消旧请求
if(oldTask) [[self allTasks] removeObject:oldTask];
//添加新请求
if(session) [[self allTasks] addObject:session];

缓存方案设计

其实苹果已经帮我们提供一个缓存解决方案:NSURLCache,他依赖于HTTP的缓存机制,但是他并不是100%完美的:

1、只支持GET请求的缓存,有时候我们也会用POST请求获取数据,然而这部分数据就无法使用NSURLCache进行缓存;
2、不够灵活,所有缓存都存储在同一个文件(记得好像是sql文件,如果有错,大家指正一下),不能分别指定每一个文件缓存的位置;
3、不能指定缓存淘汰策略;
所以这里我自己设计了一个网络的缓存方案,思路来源SDWebImage。

我的缓存方案分两级缓存:内存缓存和磁盘缓存,缓存的过程我给大家简单的梳理下:第一次请求获取响应数据,先缓存到内存,再缓存到磁盘,下一次再发起相同的请求时,会先查找内存之中会不会有相应的缓存,如果有则返回缓存数据,如果没有,则向磁盘查找,如果磁盘存在缓存则返回,否则发起网络请求获取数据。

上面就是缓存的整一个过程,思路还是比较清晰,除此之外,缓存的设计还需要考虑两个问题: 
1、缓存的淘汰策略 
2、缓存的过期机制 

针对以上那些内容,我通过解析源码的方式给大家过一遍:
缓存相关的类放在Cache这个目录下:
这里写图片描述
XDCacheManager是一个缓存管理类,暴露出简单的API给XDNetworking进行缓存的存取,底层是使用XDMemoryCache(NSCache)进行内存缓存,使用XDDiskCache(NSFileManager)进行磁盘缓存,缓存淘汰策略采用LRU算法(XD_LRUManager)。它是一个单例,通过一个全局入口统一访问:

+ (XDCacheManager *)shareManager{
  static XDCacheManager *_XDCacheManager = nil;
  static dispatch_once_t onceToken;
  dispatch_once(&onceToken, ^ {
  _XDCacheManager = [[XDCacheManager alloc] init];
  }
 return _XDCacheManager;
}

默认是磁盘大小是40MB,有效期是7天,如果想自定义设置,可以通过以下方法设置:

- (void)setCacheTime:(NSTimeInterval) time diskCapacity:(NSUInteger) capacity;

API:
存缓存的调用栈:

- [XDCacheManager cacheResponseObject:requestUrl:params:]
    - [XDMemoryCache writeData:forKey:]
    - [XDDiskCache writeData:toDir:filename:]
    - [XD_LRUManager addFileNode:]

取缓存的调用栈:

- [XDCacheManager getCacheResponseObjectWithRequestUrl:params:]
    - [XDMemoryCache readDataWithKey:]
    - [XDDiskCache readDataFromDir:filename:]
    - [XD_LRUManager refreshIndexOfFileNode:]

删除LRU缓存的调用栈:

- [XDCacheManager clearLRUCache]
    - [XD_LRUManager removeLRUFileNodeWithCacheTime:]
    - [XDDiskCache deleteCache:]

每一份缓存都有一个唯一的索引建,从方法的参数可以看出这个键是由请求的url和请求参数决定,大家不用担心接口和参数的暴露问题,键不是直接url加参数,而是两者共同作用的哈希值(采用MD5哈希算法)。

XD_LRUManager做了哪些处理

XD_LRUManager是一个基于LRU(最近最少使用算法)实现的缓存数据管理类,它底层是由一个动态数组实现的队列,数组的元素是字典,字典包含两个键:fileName(缓存文件名字)和date(缓存文文件最近的访问时间),这个队列保存在NSUserDefault里。
LRU算法的实现:
创建一个队列,新加的结点添加在队列的尾部;命中缓存时,调整结点的位置,将其放在队列的尾部;要淘汰缓存时,删除队列的头部结点。
应用情景:
1、当有数据缓存时,会调用XD_LRUManager的addFileNode方法在LRU队列上记录一个文件结点,文件结点也就是上面解释的字典,记录文件名和此时的访问时间,先判断队列是否已经存在同文件名的结点,如果有则将结点取出并插入到队列的尾部,没有则直接插入到尾部。
在遍历队列查找同文件名的结点的时候我做了遍历优化,先将队列逆序,再查找,因为在尾部的结点被重用的概率会大一些,从尾部查找会减少遍历的次数:

//优化遍历
    NSArray *reverseArray = [[array reverseObjectEnumerator] allObjects];
    [reverseArray enumerateObjectsUsingBlock:^(NSDictionary *obj, NSUInteger idx, BOOL * _Nonnull stop) {
        if ([obj[@"fileName"] isEqualToString:filename]) {
            [operationQueue removeObjectAtIndex:idx];
            *stop = YES;
        }
    }];

2、当使用缓存的时候,说明缓存文件被访问,所有应修改LRU队列对应文件结点的最近访问并它插入LRU队列的尾部,我们通过调用
XD_LRUManager的refreshIndexOfFileNode方法实现,它的实现原理跟addFileNode一样。
3、当删除LRU缓存的时候,调用XD_LRUManager的removeLRUFileNodeWithCacheTime方法,他需要传一个有效期的参数,这个参数由上层的XDCacheManager提供。遍历LRU队列,从头部开始删除,删掉已经过期的文件结点,用一个数组保存删除的文件结点里的文件名,用于回调给上层通过文件名删除真正的磁盘缓存。如果发现没有文件过期,则删除头结点,它对应着最近最少使用的文件:

NSArray *tmpArray = [operationQueue copy];
        [tmpArray enumerateObjectsUsingBlock:^(NSDictionary *obj, NSUInteger idx, BOOL * _Nonnull stop) {
            NSDate *date = obj[@"date"];
            NSDate *newDate = [date dateByAddingTimeInterval:time];
            if ([[NSDate date] compare:newDate] == NSOrderedDescending) {
                [result addObject:obj[@"fileName"]];
                [operationQueue removeObjectAtIndex:idx];
            }
        }];

这里有个注意点,就是每次操作完LRU队列,无论是增删查改,都要强制刷新LRU队列在NSUserDefault的缓存。

NSArray *tmpArray = [operationQueue copy];
        [tmpArray enumerateObjectsUsingBlock:^(NSDictionary *obj, NSUInteger idx, BOOL * _Nonnull stop) {
            NSDate *date = obj[@"date"];
            NSDate *newDate = [date dateByAddingTimeInterval:time];
            if ([[NSDate date] compare:newDate] == NSOrderedDescending) {
                [result addObject:obj[@"fileName"]];
                [operationQueue removeObjectAtIndex:idx];
            }
        }];

这里有个注意点,就是每次操作完LRU队列,无论是增删查改,都要强制刷新LRU队列在NSUserDefault的缓存。
源码地址:https://github.com/lizichenzi/XDNetworking
欢迎来github issue 我。如果大家觉得不错,give me a star。

猜你喜欢

转载自blog.csdn.net/ivolcano/article/details/77996131