iOS直接缓存数据的网络请求库封装(利用AF3.0&YY
2016-05-21 本文已影响3562人
cd5e2b81487d
前言:
开发中我们经常需要缓存某个界面的数据,那么我们如果在每个界面都去写这样的缓存代码就会变得非常繁琐...于是,一直在考虑封装一个自己的自带缓存功能的网络请求库.....
首先说明下,需要用到哪些第三方库...主要是AFNetWoking 3.0(主要用于请求网络数据),YYCache(主要用于生成缓存到内存和硬盘,更新和删除缓存等操作).
这里的YYCache底层实现,他会将数据缓存在内存中,和磁盘上,当数据量少的时候,是直接存在本地数据库.db中,数据量大的话,会以文件的形式存放
下面只是部分代码实现....详细的,请看我gitHub上的demo 希望大家多多指教
链接地址如下
https://github.com/BrightMoment/D-Y/tree/master/HttpWithCacheDemo
1.先看下网络请求类的.h文件(HttpRequestWithCache.h)
#import <Foundation/Foundation.h>
//连接可自己替换
#define urlStr @"http://192.168.0.199:8888/yuyue_m/"
@protocol HttpRequestCacheDelegate <NSObject>
@optional
-(void)httpSuccess:(id)response bindTag:(NSString *)bindTag;
-(void)httpError:(NSString *)error bindTag:(NSString *)bindTag;
@end
@interface HttpRequestWithCache : NSObject
-(instancetype)initWithDelegate:(id)requestDelegate bindTag:(NSString *)bindTag needToken:(NSInteger)needToken;
@property (nonatomic,assign) id requestDelegate;
@property (nonatomic,copy) NSString *bindTag;
@property (nonatomic,assign) NSInteger needToken;
#pragma mark - Get方法(默认方法)
//不带缓存
-(void)httpGetRequest:(NSString *)api params:(NSMutableDictionary *)params;
-(void)httpGetCacheRequest:(NSString *)api params:(NSMutableDictionary *)params;
#pragma mark - Post方法
//不带缓存
-(void)httpPostRequest:(NSString *)api params:(NSMutableDictionary *)params;
-(void)httpPostCacheRequest:(NSString *)api params:(NSMutableDictionary *)params;
#pragma mark - 上传文件方法
//上传单张图片
-(void)upLoadDataWithUrlStr:(NSString *)api params:(NSMutableDictionary *)params imageKey:(NSString *)name withData:(NSData *)data;
//上传多张图片
-(void)upLoadDataWithUrlStr:(NSString *)api params:(NSMutableDictionary *)params withDataArray:(NSArray *)dataArray;
@end
上面代码中方法写的很明确,携带Cache的方法,就是可以对从服务器拿到的数据进行缓存的方法,
2.这些方法的具体实现,我们来看下.m文件
#import "HttpRequestWithCache.h"
#import "AFNetworking.h"
#import "YYCache.h"
//YYCache缓存文件存放的文件夹
NSString * const HttpCache = @"HttpRequestCache";
#define DYLog(...) NSLog(__VA_ARGS__) //如果不需要打印数据, 注释掉NSLog
// 请求方式
typedef NS_ENUM(NSInteger, RequestType) {
RequestTypeGet,
RequestTypePost,
RequestTypeUpLoad,//单个上传
RequestTypeMultiUpload,//多个上传
RequestTypeDownload
};
@implementation HttpRequestWithCache
{
__weak HttpRequestWithCache *weakSelf;
}
-(instancetype)initWithDelegate:(id)requestDelegate bindTag:(NSString *)bindTag needToken:(NSInteger)needToken
{
if (self =[super init]) {
self.requestDelegate=requestDelegate;
self.bindTag=bindTag;
self.needToken=needToken;
weakSelf=self;
}
return self;
}
#pragma mark - Get方法(默认方法)
//不带缓存
-(void)httpGetRequest:(NSString *)api params:(NSMutableDictionary *)params
{
[self httpRequestWithUrlStr:api params:params requestType:RequestTypeGet isCache:NO cacheKey:nil imageKey:nil withData:nil withDataArray:nil];
}
-(void)httpGetCacheRequest:(NSString *)api params:(NSMutableDictionary *)params
{
[self httpRequestWithUrlStr:api params:params requestType:RequestTypeGet isCache:YES cacheKey:[urlStr stringByAppendingString:api] imageKey:nil withData:nil withDataArray:nil];
}
#pragma mark - Post方法
//不带缓存
-(void)httpPostRequest:(NSString *)api params:(NSMutableDictionary *)params
{
[self httpRequestWithUrlStr:api params:params requestType:RequestTypePost isCache:NO cacheKey:nil imageKey:nil withData:nil withDataArray:nil];
}
-(void)httpPostCacheRequest:(NSString *)api params:(NSMutableDictionary *)params
{
[self httpRequestWithUrlStr:api params:params requestType:RequestTypePost isCache:YES cacheKey:[urlStr stringByAppendingString:api] imageKey:nil withData:nil withDataArray:nil];
}
#pragma mark - 上传文件方法
//上传单张图片 name一般写file
-(void)upLoadDataWithUrlStr:(NSString *)api params:(NSMutableDictionary *)params imageKey:(NSString *)name withData:(NSData *)data
{
[self httpRequestWithUrlStr:api params:params requestType:RequestTypeUpLoad isCache:NO cacheKey:[urlStr stringByAppendingString:api] imageKey:name withData:data withDataArray:nil];
}
//上传多张图片
-(void)upLoadDataWithUrlStr:(NSString *)api params:(NSMutableDictionary *)params withDataArray:(NSArray *)dataArray
{
[self httpRequestWithUrlStr:api params:params requestType:RequestTypeUpLoad isCache:NO cacheKey:[urlStr stringByAppendingString:api] imageKey:nil withData:nil withDataArray:dataArray];
}
#pragma mark - 网络请求统一处理
/**
*
*
* @param api 后台的接口名
* @param params 参数dict
* @param requestType 请求类型
* @param isCache 是否缓存标志
* @param cacheKey 缓存的对应key值
* @param name 图片上传的名字(upload)
* @param data 图片的二进制数据(upload)
* @param dataArray 多图片上传时的imageDataArray
*/
-(void)httpRequestWithUrlStr:(NSString *)api params:(NSMutableDictionary *)params requestType:(RequestType)requestType isCache:(BOOL)isCache cacheKey:(NSString *)cacheKey imageKey:(NSString *)name withData:(NSData *)data withDataArray:(NSArray *)dataArray
{
NSString *url=[NSString stringWithFormat:@"%@%@",urlStr,api];
url=[url stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
if (params==nil) {
params=[NSMutableDictionary dictionary];
}
NSString *token=[[NSUserDefaults standardUserDefaults] objectForKey:@"token"];
NSLog(@"token:%@",token);
token=(token==nil)?@"":token;
//是否需要token
if(self.needToken)
{
//未登录提示登录操作
// if([token isEqualToString:@""])
// {
//
//
// [[AppDelegate sharedAppDelegate]presentToLoginView:self._delegate success:^{
// //登录成功之后,继续刚才未完成的 接口操作
// [weakSelf updateImage:api params:params WithImageData:imageData];
// }];
// return;
// }
[params setObject:token forKey:@"token"];
}
NSString *allUrl=[self urlDictToStringWithUrlStr:url WithDict:params];
DYLog(@"\\n\\n 网址 \\n\\n %@ \\n\\n 网址 \\n\\n",allUrl);
//设置YYCache属性
YYCache *cache = [[YYCache alloc] initWithName:HttpCache];
cache.memoryCache.shouldRemoveAllObjectsOnMemoryWarning = YES;
cache.memoryCache.shouldRemoveAllObjectsWhenEnteringBackground = YES;
id cacheData;
/* 此处要修改为,服务端不要求重新拉取数据时执行;注意当缓存没取到时,重新访问接口
if (isCache) {
//根据网址从Cache中取数据
cacheData = [cache objectForKey:cacheKey];
if(cacheData!=nil)
{
//将数据统一处理
[self returnDataWithRequestData:cacheData];
}
}
*/
//进行网络检查
if (![self requestBeforeJudgeConnect])
{
//断网
// [self showError:@"请检查网络连接"];
DYLog(@"\\n\\n----%@------\\n\\n",@"没有网络");
//断网后,根据网址从Cache中取数据进行显示
id cacheData = [cache objectForKey:cacheKey];
if(cacheData!=nil)
{
//将数据统一处理
[self returnDataWithRequestData:cacheData];
}
return;
}
AFHTTPSessionManager *session=[AFHTTPSessionManager manager];
session.responseSerializer.acceptableContentTypes=[NSSet setWithObjects:@"application/json",@"text/json",@"text/javascript",@"text/html", nil];
//超时时间
session.requestSerializer.timeoutInterval=10;
session.responseSerializer=[AFHTTPResponseSerializer serializer];
//Get请求
if (requestType==RequestTypeGet)
{
[session GET:url parameters:params progress:^(NSProgress * _Nonnull downloadProgress) {
} success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) {
[weakSelf dealWithResponseObject:responseObject cacheUrl:allUrl cacheData:cacheData isCache:isCache cache:cache cacheKey:cacheKey];
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
[weakSelf showError:@"请检查网络设置"];
}];
}
else if (requestType==RequestTypePost)
{
[session POST:url parameters:params progress:^(NSProgress * _Nonnull downloadProgress) {
} success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) {
[weakSelf dealWithResponseObject:responseObject cacheUrl:allUrl cacheData:cacheData isCache:isCache cache:cache cacheKey:cacheKey];
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
[weakSelf showError:@"请检查网络设置"];
}];
}
else if (requestType==RequestTypeUpLoad)
{
[session POST:url parameters:params constructingBodyWithBlock:^(id<AFMultipartFormData> _Nonnull formData) {
NSTimeInterval timeInterVal = [[NSDate date] timeIntervalSince1970];
NSString * fileName = [NSString stringWithFormat:@"%@.png",@(timeInterVal)];
[formData appendPartWithFileData:data name:name fileName:fileName mimeType:@"image/png"];
} progress:^(NSProgress * _Nonnull uploadProgress) {
//(float)uploadProgress.completedUnitCount/(float)uploadProgress.totalUnitCount
} success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) {
[weakSelf dealWithResponseObject:responseObject cacheUrl:allUrl cacheData:cacheData isCache:isCache cache:nil cacheKey:nil];
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
[weakSelf showError:@"上传文件出错"];
}];
}
else if (requestType==RequestTypeMultiUpload)
{
[session POST:url parameters:params constructingBodyWithBlock:^(id<AFMultipartFormData> _Nonnull formData) {
for (NSInteger i = 0; i < dataArray.count; i++)
{
NSData *imageData = [dataArray objectAtIndex:i];
//name和服务端约定好
[formData appendPartWithFileData:imageData name:@"file" fileName:[NSString stringWithFormat:@"%zi.jpg",i] mimeType:@"image/jpeg"];
}
} progress:^(NSProgress * _Nonnull uploadProgress) {
//(float)uploadProgress.completedUnitCount/(float)uploadProgress.totalUnitCount
} success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) {
[weakSelf dealWithResponseObject:responseObject cacheUrl:allUrl cacheData:cacheData isCache:isCache cache:nil cacheKey:nil];
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
[weakSelf showError:@"上传文件出错"];
}];
}
}
#pragma mark 统一处理请求到的数据
-(void)dealWithResponseObject:(NSData *)responseData cacheUrl:(NSString *)cacheUrl cacheData:(id)cacheData isCache:(BOOL)isCache cache:(YYCache*)cache cacheKey:(NSString *)cacheKey //cacheData暂不理会
{
dispatch_async(dispatch_get_main_queue(), ^{
[UIApplication sharedApplication].networkActivityIndicatorVisible = NO;// 关闭网络指示器
});
NSString * dataString = [[NSString alloc] initWithData:responseData encoding:NSUTF8StringEncoding];
dataString = [self deleteSpecialCodeWithStr:dataString];
DYLog(@"response\\n%@\\n",dataString);
NSData *requestData = [dataString dataUsingEncoding:NSUTF8StringEncoding];
if (isCache) {
//需要缓存,就进行缓存
[cache setObject:requestData forKey:cacheKey];
}
/*
//如果不缓存 或 数据不相同,就把网络返回的数据显示
if (!isCache || ![cacheData isEqual:requestData]) {
[self returnDataWithRequestData:requestData];
}
*/
//不管缓不缓存都要显示数据
[self returnDataWithRequestData:requestData];
}
#pragma mark - 根据返回的数据进行统一的格式处理-requestData 网络或者是缓存的数据-
- (void)returnDataWithRequestData:(NSData *)requestData
{
id myResult = [NSJSONSerialization JSONObjectWithData:requestData options:NSJSONReadingMutableContainers error:nil];
//判断是否为字典
if ([myResult isKindOfClass:[NSDictionary class]]) {
NSDictionary * response = (NSDictionary *)myResult;
// //根据返回的接口内容来变
id success = [response objectForKey:@"success"];
NSString* message = [response objectForKey:@"message"];
//success存在,并且为0时
if(success && ![success boolValue])//处理掉0的情况,直接进报错处理
{
if([message isKindOfClass:[NSString class]] && message.length>0)
{
//message不为空
} else
{
message = @"";
}
[self showError:message];
return;
}
NSLog(@"返回Json\\n%@\\n",response);
//把data层剥掉
NSDictionary *dict=[response objectForKey:@"data"];
[self showSuccess:dict];
}
}
#pragma mark - 拼接请求的网络地址
/**
* 拼接请求的网络地址
*
* @param urlStr 基础网址
* @param parameters 拼接参数
*
* @return 拼接完成的网址
*/
-(NSString *)urlDictToStringWithUrlStr:(NSString *)urlString WithDict:(NSDictionary *)parameters
{
if (!parameters) {
return urlString;
}
NSMutableArray *parts = [NSMutableArray array];
//enumerateKeysAndObjectsUsingBlock会遍历dictionary并把里面所有的key和value一组一组的展示给你，每组都会执行这个block 这其实就是传递一个block到另一个方法，在这个例子里它会带着特定参数被反复调用，直到找到一个ENOUGH的key，然后就会通过重新赋值那个BOOL *stop来停止运行，停止遍历同时停止调用block
[parameters enumerateKeysAndObjectsUsingBlock:^(id _Nonnull key, id _Nonnull obj, BOOL * _Nonnull stop) {
//字符串处理
key=[NSString stringWithFormat:@"%@",key];
obj=[NSString stringWithFormat:@"%@",obj];
//接收key
NSString *finalKey = [key stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
//接收值
NSString *finalValue = [obj stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *part =[NSString stringWithFormat:@"%@=%@",finalKey,finalValue];
[parts addObject:part];
}];
NSString *queryString = [parts componentsJoinedByString:@"&"];
queryString = queryString.length!=0 ? [NSString stringWithFormat:@"?%@",queryString] : @"";
NSString *pathStr = [NSString stringWithFormat:@"%@%@",urlString,queryString];
return pathStr;
}
#pragma mark -- 处理json格式的字符串中的换行符、回车符
- (NSString *)deleteSpecialCodeWithStr:(NSString *)str {
NSString *string = [str stringByReplacingOccurrencesOfString:@"\\r" withString:@""];
string = [string stringByReplacingOccurrencesOfString:@"\\n" withString:@""];
string = [string stringByReplacingOccurrencesOfString:@"\\n" withString:@""];
string = [string stringByReplacingOccurrencesOfString:@"\\t" withString:@""];
string = [string stringByReplacingOccurrencesOfString:@" " withString:@""];
string = [string stringByReplacingOccurrencesOfString:@"(" withString:@""];
string = [string stringByReplacingOccurrencesOfString:@")" withString:@""];
return string;
}
#pragma mark 网络判断
-(BOOL)requestBeforeJudgeConnect
{
struct sockaddr zeroAddress;
bzero(&zeroAddress, sizeof(zeroAddress));
zeroAddress.sa_len = sizeof(zeroAddress);
zeroAddress.sa_family = AF_INET;
SCNetworkReachabilityRef defaultRouteReachability =
SCNetworkReachabilityCreateWithAddress(NULL, (struct sockaddr *)&zeroAddress);
SCNetworkReachabilityFlags flags;
BOOL didRetrieveFlags =
SCNetworkReachabilityGetFlags(defaultRouteReachability, &flags);
CFRelease(defaultRouteReachability);
if (!didRetrieveFlags) {
printf("Error. Count not recover network reachability flags\\n");
return NO;
}
BOOL isReachable = flags & kSCNetworkFlagsReachable;
BOOL needsConnection = flags & kSCNetworkFlagsConnectionRequired;
BOOL isNetworkEnable =(isReachable && !needsConnection) ? YES : NO;
dispatch_async(dispatch_get_main_queue(), ^{
[UIApplication sharedApplication].networkActivityIndicatorVisible =isNetworkEnable;/* 网络指示器的状态： 有网络 ： 开 没有网络： 关 */
});
return isNetworkEnable;
}
#pragma mark - 返回数据的调度显示
-(void)showSuccess:(id)response
{
if(!self.requestDelegate) return;
#pragma clang diagnostic push
#pragma clang diagnostic ignored"-Wundeclared-selector"
if ([self.requestDelegate respondsToSelector:@selector(httpSuccess:tag:)])
{
[self.requestDelegate performSelector:@selector(httpSuccess:tag:) withObject:response withObject:self.bindTag];
return;
}
#pragma clang diagnostic pop
}
-(void)showError:(NSString *)error
{
if(!self.requestDelegate) return;
#pragma clang diagnostic push
#pragma clang diagnostic ignored"-Wundeclared-selector"
if ([self.requestDelegate respondsToSelector:@selector(httpError:tag:)])
{
[self.requestDelegate performSelector:@selector(httpError:tag:) withObject:error withObject:self.bindTag];
return;
}
#pragma clang diagnostic pop
}
@end
上面代码着重注意下面的几行
//设置YYCache属性
YYCache *cache = [[YYCache alloc] initWithName:HttpCache];
cache.memoryCache.shouldRemoveAllObjectsOnMemoryWarning = YES;
cache.memoryCache.shouldRemoveAllObjectsWhenEnteringBackground = YES;
id cacheData;
/* 此处要修改为,服务端不要求重新拉取数据时执行;注意当缓存没取到时,重新访问接口
if (isCache) {
//根据网址从Cache中取数据
cacheData = [cache objectForKey:cacheKey];
if(cacheData!=nil)
{
//将数据统一处理
[self returnDataWithRequestData:cacheData];
}
}
*/
//进行网络检查
if (![self requestBeforeJudgeConnect])
{
//断网
// [self showError:@"请检查网络连接"];
DYLog(@"\\n\\n----%@------\\n\\n",@"没有网络");
//断网后,根据网址从Cache中取数据进行显示
id cacheData = [cache objectForKey:cacheKey];
if(cacheData!=nil)
{
//将数据统一处理
[self returnDataWithRequestData:cacheData];
}
return;
}
作用在于我们在拿到服务器数据之后,我们是不是把数据缓存到本地(需要服务器配合),但是在断网的情况下,我们是直接取缓存中的数据进行使用的...
存放网络数据到缓存的代码是
NSString * dataString = [[NSString alloc] initWithData:responseData encoding:NSUTF8StringEncoding];
dataString = [self deleteSpecialCodeWithStr:dataString];
DYLog(@"response\\n%@\\n",dataString);
NSData *requestData = [dataString dataUsingEncoding:NSUTF8StringEncoding];
if (isCache) {
//需要缓存,就进行缓存
[cache setObject:requestData forKey:cacheKey];
}
上面只是部分代码实现....详细的,请看我gitHub上的demo 希望大家多多指教
链接地址为
https://github.com/BrightMoment/D-Y/tree/master/HttpWithCacheDemo
