iOS请求缓存、离线缓存框架 ZBNetworking

时间 2019-12-18

原文原文链接

在最初接触数据缓存的时候就看到多个博客提到能够用SDWebImage缓存图片方式的思路去作数据缓存，但是基本没有看到去实践的，而更多看到的使用sqlite的封装FMDB去作缓存，也有用系统的NSURLCache，可表现的都很难扩展，对请求缓存中的一些操做都很单一。也许我没看到好的吧，若是有请留言给我谢谢。
先说说一些缓存中的误区：看到不少刚接触缓存这块的开发者认为网络状态是缓存的第一判断条件，大概是有网络就从新请求数据，无网络就使用缓存。这么认为的就是进入误区了。就说一个例子，有网络，但服务器挂了，怎么办。显示你返回请求失败的异常页面吗？有人说了请求失败再使用缓存呗。我们作APP的是否是要考虑用户的使用体验啊。请求失败了，都啥时候了，黄花菜都凉了。
你们能够看看几个主流APP 的缓存显示方式“ 网易新闻”,“今日头条”,“ 微博” 。在有缓存的状态下，这几款APP都是优先显示缓存，同时有的进行自动下拉刷新操做，有的给你提示，有多少条数据更新，请进行下拉刷新操做。下拉刷新就是重现请求，请求的结果有不少状态，与界面操做有关就几种，请求成功替换显示的数据，请求超时给提示，请求失败给提示。能够看出缓存是和请求分不开的（因为GET请求通常用来查询数据，POST请求通常是发大量数据给服务器处理（变更性比较大）所以通常只对GET请求进行缓存，而不对POST请求进行缓存）。
正确的缓存的使用策略是在有缓存的状态下，使用缓存，没有缓存去请求，请求的成功后的数据刷新界面，并覆盖原缓存文件。结合网络请求，还要给出不使用缓存的状态，和使用缓存的状态.在实际运用中能够能还有别的需求，好比上拉加载的状态，离线缓存的状态，因此请求的种类多样，缓存的使用策略的状态也要多样。
根据此缓存策略封装的请求框架 ZBNetworking

ZBNetworking

优势: 1 低耦合，易扩展。（这个下篇文章体现） 2.有缓存文件过时机制默认一周（以最后缓存文件修改时间为准） 3.显示缓存大小/个数，所有清除缓存/单个文件清除缓存/按时间清除缓存方法多样而且均可以自定义路径可扩展性强 4.离线下载功能 5.多种请求类型的判断。也可不遵循，自由随你定。git

/** 从新请求 ,不读取缓存，从新请求*/
    ZBRequestTypeRefresh,
    /** 有缓存,读取缓存 无缓存，从新请求*/
    ZBRequestTypeCache,
    /** 加载更多 ,不读取缓存，从新请求*/
    ZBRequestTypeRefreshMore,
    /** 加载更多 ,有缓存,读取缓存 无缓存，从新请求*/
    ZBRequestTypeCacheMore,
    /** 详情    ,有缓存,读取缓存 无缓存，从新请求*/
    ZBRequestTypeDetailCache,
    /** 自定义  ,有缓存,读取缓存 无缓存，从新请求*/
    ZBRequestTypeCustomCache
复制代码

6.可见的缓存文件 github

AFNetworking 很少介绍了在使用OC开发的，不少都用这个。封装了一个缓存管理类ZBCacheManager，主要参照了SDWebImage的SDImageCache磁盘存储的思路,SDWebImage的存储性能你们应该不用怀疑，但也要进行大量的改动，毕竟SDImageCache 只是缓存图片的。无论用那种请求方法缓存文件都会存储到沙盒 /Library/Caches/ZBKit/AppCache 路径下。有一点要注意，请求下来的数据格式是二进制的由于缓存也是二进制数据。因此设置了responseSerializer = [AFHTTPResponseSerializer serializer];不能更改。sql

运行流程以下图

请求示例具体看demo 。 2017-8-21 重构了此库如今默认为Refresh （从新请求，不读缓存）。json

[ZBRequestManager requestWithConfig:^(ZBURLRequest *request){
        request.urlString=list_URL;
        request.methodType=ZBMethodTypeGET;//默认为GET
        request.apiType=ZBRequestTypeCache;//默认为ZBRequestTypeRefresh
    }  success:^(id responseObj,apiType type){
        if (type==ZBRequestTypeRefresh) {
              //下拉结束刷新
        }  
        if (type==ZBRequestTypeLoadMore) {
            // 上拉结束刷新
        }
             //请求成功
        
    } failed:^(NSError *error){
        if (error.code==NSURLErrorCancelled)return;
        if (error.code==NSURLErrorTimedOut){
            [self alertTitle:@"请求超时" andMessage:@""];
        }else{
            [self alertTitle:@"请求失败" andMessage:@""];
        }
    }];

//取消对应的网络请求
 [ZBRequestManager cancelRequest: list_URL completion:^(NSString *urlString){
        //若是请求成功 或 读缓存 会返回null 没法取消。请求未完成的会取消并返回对应url
        //NSLog(@"取消对应url:%@ ",urlString);
    }];
复制代码

其余的一些功能显示缓存大小 ,缓存个数。按时间清除缓存，手动清理缓存，自定义清除某个路径文件，清除某个单独key的缓存等功能，

#离线缓存/下载api

下面要说离线缓存功能。不知道该功能的：能够下个今日头条/个人 /离线功能看看通常新闻类的APP 大多有该功能。要作离线缓存功能:必需要有先决条件，就是必定不要多个缓存路径，特别是图片的缓存功能，存储路径要统一。个人demo中图片请求如今使用的是SDWebImage，其实也能够用别的。只要你用的图片请求框架在数据列表显示的图片和在离线下载的图片用的是一个缓存就能够，SDWebImage 由于用了MD5编码，确保了每一个URL对应的缓存惟一性。这里有个问题，有不少应用有轮播视图的功能，而大多数封装好轮播都是本身进行请求并缓存到自定义的缓存路径，这个要处理一下，这里我选用了一个codingZero 大神 XRCarouselView 的轮播视图进行修改，（为何选择这个，由于他写好简单，代码好少，好修改）。先把其余的请求/建立/存储缓存方法都删掉而后找到 - (void)downloadImages:(int)index 方法进行修改

//使用SDWebImage方法替换内部实现
- (void)downloadImages:(int)index {
    
    [[SDWebImageManager sharedManager] downloadImageWithURL:[NSURL URLWithString:_imageArray[index]] options:0 progress:^(NSInteger receivedSize, NSInteger expectedSize){
        
    } completed:^(UIImage *image, NSError *error, SDImageCacheType cacheType,BOOL finished,NSURL *imageURL){
        if (image) {
            self.images[index] = image;
            //若是下载的图片为当前要显示的图片，直接到主线程给imageView赋值，不然要等到下一轮才会显示
            if (_currIndex == index) [_currImageView performSelectorOnMainThread:@selector(setImage:) withObject:image waitUntilDone:NO];
        }
    }];
}

复制代码

好了咱们的列表图片包括轮播图片缓存都在SDWebImage 的默认缓存路径里了，由于XRCarouselView 我并无征得做者的赞成更改，因此demo中就不使用了,主要让你们知道图片的请求与存储要统一而咱们的json 数据已经缓存到/Library/Caches/ZBKit/AppCache 路径下。下面开始实现离线功能数组

其实离线缓存并非一个高深的技术，仍是缓存。正常咱们浏览一个页面缓存这个页面的数据。而离线就是同时请求多个页面并缓存下来。

思路就是每一个频道就是一个url,把你要缓存的 url 放到一个数组里进行遍历请求。ZBRequestManager已经封装好了离线的方法缓存

- (void)requestOffline:(NSMutableArray *)offlineArray{

    [ZBRequestManager sendBatchRequest:^(ZBBatchRequest *batchRequest){
         for (NSString *urlString in offlineArray) {
            ZBURLRequest *request=[[ZBURLRequest alloc]init];
            request.urlString=urlString;
            [batchRequest.urlArray addObject:request];
        }
    }  success:^(id responseObj,apiType type){

            NSLog(@"添加了几个url请求 就会走几遍");
            NSDictionary *dict = [NSJSONSerialization JSONObjectWithData:responseObj options:NSJSONReadingMutableContainers error:nil];
            NSArray *array=[dict objectForKey:@"videos"];
            for (NSDictionary *dic in array) {
                DetailsModel *model=[[DetailsModel alloc]init];
                model.thumb=[dic objectForKey:@"thumb"]; //找到图片的key
                [self.imageArray addObject:model];
                
                //使用SDWebImage 下载图片
                BOOL isKey=[[SDImageCache sharedImageCache]diskImageExistsWithKey:model.thumb];
                if (isKey) {
                    self.offlineView.progressLabel.text=@"已经下载了";
                } else{
                    
                    [[SDWebImageManager sharedManager] downloadImageWithURL:[NSURL URLWithString:model.thumb] options:0 progress:^(NSInteger receivedSize, NSInteger expectedSize){
                        
                        NSLog(@"%@",[self progressStrWithSize:(double)receivedSize/expectedSize]);
                        
                        self.offlineView.progressLabel.text=[self progressStrWithSize:(double)receivedSize/expectedSize];
                        
                        self.offlineView.pv.progress =(double)receivedSize/expectedSize;
                        
                    } completed:^(UIImage *image, NSError *error, SDImageCacheType cacheType,BOOL finished,NSURL *imageURL){
                        
                        NSLog(@"单个图片下载完成");
                        self.offlineView.progressLabel.text=nil;
                        
                        self.offlineView.progressLabel.text=[self progressStrWithSize:0.0];
                        
                        self.offlineView.pv.progress = 0.0;
                        
                        [self.tableView reloadData];
                        //让 下载的url与模型的最后一个比较，若是相同证实下载完毕。
                        NSString *imageURLStr = [imageURL absoluteString];
                        NSString *lastImage=[NSString stringWithFormat:@"%@",((DetailsModel *)[self.imageArray lastObject]).thumb];
                        
                        if ([imageURLStr isEqualToString:lastImage]) {
                            NSLog(@"下载完成");
                            
                            [self.offlineView hide];//取消下载进度视图
                            [self alertTitle:@"下载完成"andMessage:@""];
                             self.imageArray=nil;
                        }
                        
                        if (error) {
                            NSLog(@"下载失败");
                        }
                    }];
                    
                }
                
            }

    } failed:^(NSError *error){
        if (error.code==NSURLErrorCancelled)return;
        if (error.code==NSURLErrorTimedOut){
            [self alertTitle:@"请求超时" andMessage:@""];
        }else{
            [self alertTitle:@"请求失败" andMessage:@""];
        }
    }];
}
复制代码

点击 Github地址下载bash

结尾：水平有限，代码也很烂，一直在努力学习中，你们多多包涵。若是你喜欢这个轮子，请给个star，这是对做者最大的鼓励和支持，拜谢！！！假如你有更好的想法或方案请留言！服务器

下篇文章：设计一个简单的图片缓存器网络

iOS请求缓存、离线缓存 框架 ZBNetworking

ZBNetworking

iOS请求缓存、离线缓存框架 ZBNetworking