PPNetworkHelper
现在绝大部分的APP都会对服务器端的数据进行缓存,以增强用户体验,不让APP在无网状态下显得光秃秃的。之前在我自己的一个项目中使用的是FMDB进行的离线缓存,虽然FMDB大大简化了SQLite语句的繁琐,但需要缓存的东西一但多起来,用起来还是比较麻烦的。(2016/9/27更新-,无需设置,,无需插件,控制台可直接打印中文字符,Xcode8绝配!)
无意中看到一篇ibireme的YYCache 设计思路的技术博客,就知道发现我想要的东西了,以下就是对AFNetworking 3.x 与YYCache的二次封装,封装常见的GET、POST、文件上传/下载、网络状态监测的功能、方法接口简洁明了,使用YYCache(缓存性能足够优秀,详情可戳其博客)实现对网络数据的自动缓存,简单易用,不用再写FMDB那烦人的SQL语句,一句代码搞定网络数据的请求与缓存.
演示图
一、PPNetworkHelper, 网络请求部分对AFN3.x的简单封装
1.GET请求无缓存
/**
* GET请求,无缓存
*
* @param URL 请求地址
* @param parameters 请求参数
* @param success 请求成功的回调
* @param failure 请求失败的回调
*
* @return 返回的对象可取消请求,调用cancle方法
*/
+ (__kindof NSURLSessionTask *)GET:(NSString *)URL parameters:(NSDictionary *)parameters success:(HttpRequestSuccess)success failure:(HttpRequestFailed)failure;
2.GET请求自动缓存
/**
* GET请求,自动缓存
*
* @param URL 请求地址
* @param parameters 请求参数
* @param responseCache 缓存数据的回调
* @param success 请求成功的回调
* @param failure 请求失败的回调
*
* @return 返回的对象可取消请求,调用cancle方法
*/
+ (__kindof NSURLSessionTask *)GET:(NSString *)URL parameters:(NSDictionary *)parameters responseCache:(HttpRequestCache)responseCache success:(HttpRequestSuccess)success failure:(HttpRequestFailed)failure;
3.POST请求无缓存
/**
* POST请求,无缓存
*
* @param URL 请求地址
* @param parameters 请求参数
* @param success 请求成功的回调
* @param failure 请求失败的回调
*
* @return 返回的对象可取消请求,调用cancle方法
*/
+ (__kindof NSURLSessionTask *)POST:(NSString *)URL parameters:(NSDictionary *)parameters success:(HttpRequestSuccess)success failure:(HttpRequestFailed)failure;
4.POST请求自动缓存
/**
* POST请求,自动缓存
*
* @param URL 请求地址
* @param parameters 请求参数
* @param responseCache 缓存数据的回调
* @param success 请求成功的回调
* @param failure 请求失败的回调
*
* @return 返回的对象可取消请求,调用cancle方法
*/
+ (__kindof NSURLSessionTask *)POST:(NSString *)URL parameters:(NSDictionary *)parameters responseCache:(HttpRequestCache)responseCache success:(HttpRequestSuccess)success failure:(HttpRequestFailed)failure;
5.上传图片文件
/**
* 上传图片文件
*
* @param URL 请求地址
* @param parameters 请求参数
* @param images 图片数组
* @param name 文件对应服务器上的字段
* @param fileName 文件名
* @param mimeType 图片文件的类型,例:png、jpeg(默认类型)....
* @param progress 上传进度信息
* @param success 请求成功的回调
* @param failure 请求失败的回调
*
* @return 返回的对象可取消请求,调用cancle方法
*/
+ (__kindof NSURLSessionTask *)uploadWithURL:(NSString *)URL parameters:(NSDictionary *)parameters images:(NSArray<UIImage *> *)images name:(NSString *)name fileName:(NSString *)fileName mimeType:(NSString *)mimeType progress:(HttpProgress)progress success:(HttpRequestSuccess)success failure:(HttpRequestFailed)failure;
6.下载文件
/**
* 下载文件
*
* @param URL 请求地址
* @param fileDir 文件存储目录(默认存储目录为Download)
* @param progress 文件下载的进度信息
* @param success 下载成功的回调(回调参数filePath:文件的路径)
* @param failure 下载失败的回调
*
* @return 返回NSURLSessionDownloadTask实例,可用于暂停继续,暂停调用suspend方法,开始下载调用resume方法
*/
+ (__kindof NSURLSessionTask *)downloadWithURL:(NSString *)URL fileDir:(NSString *)fileDir progress:(HttpProgress)progress success:(void(^)(NSString *filePat
+ h))success failure:(HttpRequestFailed)failure;
7.监听网络状态及网络状态实时回调
/**
* 开始监听网络状态
*/
+ (void)startMonitoringNetwork;
/**
* 通过Block回调实时获取网络状态,也可以通过返回值进行一次性判断
*/
+ (BOOL)checkNetworkStatusWithBlock:(NetworkStatus)status;
二、PPNetworkCache,数据缓存部分对YYCache简单封装
/**
* 缓存网络数据
*
* @param responseCache 服务器返回的数据
* @param key 缓存数据对应的key值,推荐填入请求的URL
*/
+ (void)saveHttpCache:(id)httpCache forKey:(NSString *)key;
/**
* 取出缓存的数据
*
* @param key 根据存入时候填入的key值来取出对应的数据
*
* @return 缓存的数据
*/
+ (id)getHttpCacheForKey:(NSString *)key;
/**
* 获取网络缓存的总大小 bytes(字节)
*/
+ (NSInteger)getAllHttpCacheSize;
/**
* 删除所有网络缓存,
*/
+ (void)removeAllHttpCache;
三、请求示例
1.无缓存
[PPNetworkHelper GET:url parameters:nil success:^(id responseObject) {
//请求成功
} failure:^(NSError *error) {
//请求失败
}];
2.自动缓存
[PPNetworkHelper GET:url parameters:nil responseCache:^(id responseCache) {
//加载缓存数据
} success:^(id responseObject) {
//请求成功
} failure:^(NSError *error) {
//请求失败
}];







网友评论
sessionManager ? sessionManager(_sessionManager) : nil;
}
没看懂,能简单说下嘛?
fileDir:(NSString *)fileDir
progress:(PPHttpProgress)progress
success:(void(^)(NSString *))success
failure:(PPHttpRequestFailed)failure {
这个方法中 发现没有走下载进度的方法
+ (void)cancelRequestWithURL:(NSString *)URL;
那么该 url对应的task是取消了,但是请求的block回调还是没有监听到请求失败的响应,请问该如何解决
1.DOME中的PPHTTPRequest为何不采用继承PPNetworkHelper的方式?
2.因为全局只有一个AFHTTPSessionManager实例,当设置请求头的时候,会导致所有的请求都带有那个请求头,是不是其他不需要那个请求头的请求需要手动清空呀?
2017-09-08 09:59:24.972027+0800 BIM_Ios_App[1383:47170] 2017-9-18
2017-09-08 09:59:24.972536+0800 BIM_Ios_App[1383:47170] date 2017-09-18 courseId C17083101 url http://192.168.1.67:8080/LongMuseum/handset/classOutline?
__block NSURLSessionDataTask * task = nil;
task = [PPNetworkHelper GET:url parameters:para success:^(id responseObject) {
NSLog(@"NSURLSessionDataTask = %@",task);
} failure:^(NSError *error) {
}];
responseObject = <7b224c65 73735769 74686472 6177616c 42616c61 6e636522 3a31352c 22636f64 65223a31 2c225769 74686472 6177616c 42616c61 6e636546 6565223a 312c2262 616e6b4c 69737422 3a5b5d2c 226d6573 73616765 223a22e6 9fa5e8af a2e68890 e58a9f22 7d> ,上架后在app也会打印吗?
Link with required frameworks:
UIKit
CoreFoundation
QuartzCore
sqlite3
NSMutableDictionary *param = [NSMutableDictionary dictionary];
[param setObject:@"getNewsList" forKey:@"action"];
[param setObject:@"南通市" forKey:@"cityName"];
[param setObject:@"" forKey:@"typeId"];
[param setObject:@"1" forKey:@"pageNum"];
[param setObject:@"10" forKey:@"pageCount"];
NSMutableDictionary *param = [NSMutableDictionary dictionary];
[param setObject:@"南通市" forKey:@"cityName"];
[param setObject:@"" forKey:@"typeId"];
[param setObject:@"1" forKey:@"pageNum"];
[param setObject:@"10" forKey:@"pageCount"];
//加载缓存数据
} success:^(id responseObject) {
//请求成功
} failure:^(NSError *error) {
//请求失败
}];
当parameters传递参数时存在无法正常存取的情况。实测
cityCode = "";
latitude = "39.911510";
longitude = "116.396746";
pageNo = 1;
provinceCode = "";
rowsPerPage = 10;
sex = "";
sign = d138fb4a32f26878eb4a41807ab808d1;
userToken = c99ca9233f897b6a475b616ef11fa7ba45876a26dbe30a16f3983b730ad6db5ac6f611ab67a82c118cdbc454b87fffa9a32c0b03911bf4c7f49fdf701301dda23af2ec2b15821de1ac284bd250159dd09da98019986acc33e89154f2e9f746e23d59da9756632617bf30b34fdb6d7577d1c87e8f074a6cae0373214bb245cb73;
对_allSessionTask的操作都要使用@synchronized(self) {}
@synchronized(self)效率低,使用dispatch_semaphore比这个好
读取缓存操作 ’[PPNetworkCache httpCacheForURL:URL parameters:parameters]’ ,有同步I/O操作,阻塞主线程不太好吧
也是。
但线程同步的问题好像还是存在
没有设置_sessionManager的completionQueue,回调是在主线程执行,但调用那些Helper中的GET、POST方法不能保证就是在主线程,cancelAllRequest也不能保证在主线程执行,那么_allSessionTask的removeObject和addObject可能在不同的线程,_allSessionTask的操作没有线程同步的问题吗?
1、@synchronized的效率是低,但在现实中,有哪个APP会在短时间内取消网络请求1000次?10000次?再加上越来越强处理器,这点性能损耗可以忽略不计吧。比起可以忽略不计的性能损耗,我更看重的是@synchronized写法的简洁,直观,易读。
2、与第1条的初衷一样,PPNetworkCache缓存的只是一小段的json字典数据,其大小可能都还没超过0.1KB,不会阻塞主线程吧?为了还没有超过0.1KB的字典数据,来回切换线程也不一定好吧?
为什么啊 ?
如果在使用PPNetworkHelper的过程中遇到其他问题,可以加入我最近新建的 PP-iOS学习交流群 : 323408051 交流
此封装发起一次网络请求+缓存的过程是这样的 :
1.发起HTTP请求;
2.先加载本地缓存(无论有没有缓存);
3.HTTP请求成功/失败;
4.加载服务器数据的同时更新本地缓存(如果HTTP请求失败就一直加载本地缓存)
关于缓存的时效性这个问题你提醒的太好了,我会找时间将此接口加上去。非常感谢!