ZBNetworking 介绍文档

本来想发布到cocoaPods的发现名字已经被占用了，也不想改名了。大家就手动下载用吧

变更日志

优点:

1.请求类型丰富 /*GET请求//*POST请求//*PUT请求//*PATCH请求//*DELETE请求//*Upload请求//*DownLoad请求/

2.低耦合，易扩展。

3.通过Block配置信息，代码紧凑;

4.有缓存文件过期机制默认一周

5.显示缓存大小/个数，全部清除缓存/单个文件清除缓存/按时间清除缓存/按路径清除缓存方法多样并且都可以自定义路径可扩展性强

6.有缓存key过滤功能

7.离线下载功能，批量请求功能

8.多种请求缓存类型的判断。也可不遵循，自由随你定。

  /**
     重新请求:   不读取缓存，不存储缓存
     没有缓存需求的，单独使用
     */
    ZBRequestTypeRefresh,
    
    /**
     重新请求:   不读取缓存，但存储缓存
     可以与 ZBRequestTypeCache 配合使用
     */
    ZBRequestTypeRefreshAndCache,
    /**
     读取缓存:   有缓存,读取缓存--无缓存，重新请求并存储缓存
     可以与ZBRequestTypeRefreshAndCache 配合使用
     */
    ZBRequestTypeCache,
    /**
     重新请求：  上拉加载更多业务，不读取缓存，不存储缓存
     用于区分业务 可以不用
     */
    ZBRequestTypeRefreshMore,

9.可见的缓存文件

使用

 /**
     基础配置
     需要在请求之前配置，设置后所有请求都会带上 此基础配置
     */
    NSMutableDictionary *parameters = [NSMutableDictionary dictionary];
    parameters[@"github"] = @"https://github.com/Suzhibin/ZBNetworking";
    parameters[@"jianshu"] = @"https://www.jianshu.com/p/55cda3341d11";
    NSTimeInterval timeInterval = [[NSDate date] timeIntervalSince1970];
    NSString *timeString = [NSString stringWithFormat:@"%.2f",timeInterval];
    parameters[@"timeString"] =timeString;//时间戳

    NSMutableDictionary *headers = [NSMutableDictionary dictionary];
    headers[@"Token"] = @"Token";
    
    [ZBRequestManager setupBaseConfig:^(ZBConfig * _Nullable config) {
        config.baseURL=server_URL;//如果同一个环境，有多个域名 不建议设置baseURL
        config.baseParameters=parameters;//公告参数
        // filtrationCacheKey因为时间戳是变动参数，缓存key需要过滤掉 变动参数,如果 不使用缓存功能 或者 没有变动参数 则不需要设置。
        config.baseFiltrationCacheKey=@[@"timeString"];
        config.baseHeaders=headers;//请求头
        config.baseRequestSerializer=ZBJSONRequestSerializer; //全局设置 请求格式 默认JSON
        config.baseResponseSerializer=ZBJSONResponseSerializer; //全局设置 响应格式 默认JSON
        config.baseTimeoutInterval=15;//超时时间  优先级 小于 单个请求重新设置
        config.baseRetryCount=2;//请求失败 所有请求重新连接次数
        config.consoleLog=YES;//开log
    }];
    
//请求方法 会默认创建缓存路径    
    NSMutableDictionary *parameters = [NSMutableDictionary dictionary];
    parameters[@"path"] = @"HomeViewController";
    NSMutableDictionary *headers = [NSMutableDictionary dictionary];
    headers[@"headers"] = @"herader";
    [ZBRequestManager requestWithConfig:^(ZBURLRequest *request){
        request.URLString=list_URL;
        request.methodType=ZBMethodTypeGET;//默认为GET
        request.apiType=ZBRequestTypeRefresh;//（默认为ZBRequestTypeRefresh 不读取缓存，不存储缓存）
        request.parameters=parameters;
        request.headers=headers;
        /**
         保留第一次或最后一次请求结果 只在请求时有用  读取缓存无效果。默认ZBResponseKeepNone 什么都不做
         使用场景是在 重复点击造成的 多次请求，如发帖，评论，搜索等业务
         */
        request.keepType=ZBResponseKeepNone;
        request.filtrationCacheKey=@[@""];//与basefiltrationCacheKey 兼容
        request.requestSerializer=ZBJSONRequestSerializer; //单次请求设置 请求格式 默认JSON，优先级大于 全局设置，不影响其他请求设置
        request.responseSerializer=ZBJSONResponseSerializer; //单次请求设置 响应格式 默认JSON，优先级大于 全局设置,不影响其他请求设置
        request.retryCount=2;//请求失败 所有请求重新连接次数
        request.timeoutInterval=10;//默认30 //优先级 高于 全局设置,不影响其他请求设置
      
    }  success:^(id responseObj,ZBURLRequest * request){
        if (request.apiType==ZBRequestTypeRefresh) 
             //结束刷新
        }
        if (request.apiType==ZBRequestTypeLoadMore) {
            //结束上拉加载
        }
        //请求成功
          NSLog(@"得到数据:%@",responseObject);
      
    } failure:^(NSError *error){
        if (error.code==NSURLErrorCancelled)return;
        if (error.code==NSURLErrorTimedOut){
            [self alertTitle:@"请求超时" andMessage:@""];
        }else{
            [self alertTitle:@"请求失败" andMessage:@""];
        }
    }];

使用其他功能

1.离线下载批量下载

 [ZBRequestManager sendBatchRequest:^(ZBBatchRequest *batchRequest)
            for (NSString *urlString in offlineArray) {
            ZBURLRequest *request=[[ZBURLRequest alloc]init];
            request.URLString=urlString;
            [batchRequest.urlArray addObject:request];
        }
    }  success:^(id responseObj,ZBURLRequest * request){
      
    } failure:^(NSError *error){
        if (error.code==NSURLErrorCancelled)return;
        if (error.code==NSURLErrorTimedOut){
            [self alertTitle:@"请求超时" andMessage:@""];
        }else{
            [self alertTitle:@"请求失败" andMessage:@""];
        }
    }];

//具体演示看demo

2.缓存相关

 //显示缓存大小 可以自定义路径
 [[ZBCacheManager sharedInstance]getCacheSize];
  //显示缓存个数  可以自定义路径
 [[ZBCacheManager sharedInstance]getCacheCount];
 //清除沙盒缓存
 [[ZBCacheManager sharedInstance]clearCache];
 //清除内存缓存
 [[ZBCacheManager sharedInstance]clearMemory];
  //清除单个缓存文件
 [[ZBCacheManager sharedInstance]clearCacheForkey:list_URL];
  //按路径清除缓存
 [[ZBCacheManager sharedInstance]clearDiskWithpath:@"路径" completion:nil];
  //取消当前请求
 [self.currentTask cancel];//取消本次请求
  //取消所有请求
  [ZBRequestManager cancelAllRequest];

缓存key过滤

   NSDate* dat = [NSDate dateWithTimeIntervalSinceNow:0];
   NSTimeInterval a=[dat timeIntervalSince1970];
   NSString *timeString = [NSString stringWithFormat:@"&time=%f", a];
   
    // 使用了parameters 的请求 缓存key会是URLString+parameters，parameters里有是时间戳或者其他动态参数,key一直变动 无法拿到缓存。所以定义一个 filtrationCacheKey 过滤掉parameters 缓存key里的 变动参数比如 时间戳
   [ZBRequestManager requestWithConfig:^(ZBURLRequest *request){
       request.URLString=@"http://URL";
       request.methodType=ZBMethodTypePOST;//默认为GET
       request.apiType=ZBRequestTypeRefresh;//默认为ZBRequestTypeRefresh
       request.parameters=@{@"1": @"one", @"2": @"two", @"time": @"12345667"};
       request.filtrationCacheKey=@[@"time"];//过滤掉time
   }success:nil failure:nil];

License

ZBNetworking is released under the MIT license. See LICENSE for details.

VooiCode/ZBNetworking

ZBNetworking 介绍文档

使用

使用 其他功能

缓存key过滤

License

使用其他功能