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) {
//请求失败
}];