项目中常用的网络请求和数据缓存封装
需要AFN和YYCaChe
有自定义log和提示框,根据需要替换就可以了.
1.数据缓存
声明部分
//
// NetworkCache.h
// BuLuoKe
//
// Created by 裴铎 on 2018/9/4.
// Copyright © 2018年 裴铎. All rights reserved.
//
#import <Foundation/Foundation.h>
@interface NetworkCache : NSObject
/** 将数据缓存并设置key */
+ (void)setHTTPCache:(id)httpData URLString:(NSString *)urlString parameters:(NSDictionary *)parameters;
/** 通过key获取缓存数据 */
+ (id)getHTTPCacheForURLString:(NSString *)urlString parameters:(NSDictionary *)parameters;
/** 获取所有缓存数据的大小 */
+ (NSInteger)getAllCacheDataSize;
/** 清除所有缓存 */
+ (void)clearAllCacheDatas;
@end
实现部分
//
// NetworkCache.m
// BuLuoKe
//
// Created by 裴铎 on 2018/9/4.
// Copyright © 2018年 裴铎. All rights reserved.
//
#import "NetworkCache.h"
#import "YYCache.h" //数据缓存第三方类
/** 用于缓存数据的第三方对象 */
static YYCache * _defaultYYCache = nil;
/** 用于缓存数据的文件名 */
static NSString * const NetworkResponseCache = @"NetworkResponseCache";
@implementation NetworkCache
#pragma mark - 私有方法
/** 类内存第一次加载时会调用下面两个方法(load, initialize),只加载一次 */
//+ (void)load{
//
//}
/** 类的初始化方法 */
+ (void)initialize{
/** 实力化YYCache对象 */
_defaultYYCache = [YYCache cacheWithName:NetworkResponseCache];
}
/** 根据url和参数字典来拼接成一个缓存用的key */
+ (NSString *)cacheKeyWithURLString:(NSString *)urlString parameters:(NSDictionary *)parameters{
if (parameters.count == 0 || parameters == nil) {
return urlString;
}
/** 将参数字典转成字符窜 */
//1./
NSData * stringData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
//2./
NSString * parametersString = [[NSString alloc] initWithData:stringData encoding:NSUTF8StringEncoding];
/** 将url和参数进行拼接, 并返回 */
return [urlString stringByAppendingString:parametersString];
}
#pragma mark - 对外接口
/** 将数据缓存并设置key */
+ (void)setHTTPCache:(id)httpData URLString:(NSString *)urlString parameters:(NSDictionary *)parameters {
/** 拼接key */
NSString * key = [self cacheKeyWithURLString:urlString parameters:parameters];
/** 缓存数据 */
[_defaultYYCache setObject:httpData forKey:key];
}
/** 通过key获取缓存数据 */
+ (id)getHTTPCacheForURLString:(NSString *)urlString parameters:(NSDictionary *)parameters{
/** 拼接key */
NSString * key = [self cacheKeyWithURLString:urlString parameters:parameters];
/** 通过key获取缓存 */
return [_defaultYYCache objectForKey:key];
}
/** 获取所有缓存数据的大小 */
+ (NSInteger)getAllCacheDataSize{
/** 返回缓存的大小 */
return [_defaultYYCache.diskCache totalCost];
}
/** 清除所有缓存 */
+ (void)clearAllCacheDatas{
[_defaultYYCache.diskCache removeAllObjects];
}
@end
2.网络请求
声明文件
//
// RequestDATA.h
// XiMaLaYa
//
// Copyright © 2018年 com，baweijiaoyu. All rights reserved.
// 网络数据请求类
#import <Foundation/Foundation.h>
typedef void(^UPLoadDataPass)(id resultData, NSError * error );
/** 缓存策略枚举, 默认是忽略缓存, 直接请求网络数据 */
typedef NS_ENUM(NSInteger, HTTPCacheType) {
/** 忽略缓存, 直接请求网络数据 */
ClientReloadIgnoringLocalCacheData = 0,
/** 先读取缓存数据, 然后马上同步网络数据 */
ClientReturnCacheDataThenLoad = 1,
/** 有缓存数据时, 使用缓存,不再请求网络数据, 没有缓存才请求网络数据,(数据总也不变时用) */
ClientReturnCacheDataElseLoad = 2,
/** 有缓存就用缓存,没有也不发送请求,(直接当成请求失败处理) 用于断网情况 */
ClientReturnCacheDataDontLoad = 3
};
/** 请求数据策略枚举 */
typedef NS_ENUM(NSInteger, HTTPRequestType) {
GET = 0,
POST = 1
};
/** 用于数据回传的block */
typedef void(^HTTPDataPass)(id resultData, NSError * error );
@interface RequestDATA : NSObject
+(instancetype)getInstance;
/**
网络数据的请求方式
参数列表:
1./请求数据的方式(GET、POST)
2./请求的网址字符串
3./请求的参数
4./缓存策略
5./请求结束回调
*/
+ (void)request:(HTTPRequestType)type
urlString:(NSString *)urlString
parameters:(NSDictionary *)parameters
cachePolicy:(HTTPCacheType)cachePolicy
completion:(__strong HTTPDataPass)completion;
/** 获取所有缓存数据的大小 */
+ (NSInteger)getAllCacheDataSize;
/** 清除所有缓存 */
+ (void)clearAllCacheDatas;
@end
实现文件
//
// RequestDATA.m
// XiMaLaYa
//
// Copyright © 2018年 com，baweijiaoyu. All rights reserved.
//// 网络数据请求类
#import "RequestDATA.h"
#import "defind.h" //全局宏
#import "UIView+Alert.h"
#import "AFNetworking.h"
#import "NetworkCache.h" //对YYCache的二次封装
@interface RequestDATA ()
/** AFN的请求对象 */
@property (nonatomic, strong) AFHTTPSessionManager * manager;
/** 是否发送网络数据 */
@property (nonatomic, assign, getter=isReloadData) BOOL reloadData;
@end
@implementation RequestDATA
#pragma mark - 缓存处理
/** 获取所有缓存数据的大小 */
+ (NSInteger)getAllCacheDataSize{
return [NetworkCache getAllCacheDataSize];
}
/** 清除所有缓存 */
+ (void)clearAllCacheDatas{
[NetworkCache clearAllCacheDatas];
}
/** 获取磁盘缓存数据 */
- (void)getCacheDataWithURLString:(NSString *)urlString
parameters:(NSDictionary *)parameters
cachePolicy:(HTTPCacheType)cachePolicy
completion:(HTTPDataPass)completion{
/** 获取缓存 */
id cacheData = [NetworkCache getHTTPCacheForURLString:urlString parameters:parameters];
/** 缓存策略区分 */
if (cachePolicy == ClientReturnCacheDataThenLoad) {
/** 是否允许请求数据 */
self.reloadData = YES;
}else if (cachePolicy == ClientReturnCacheDataElseLoad) {
/** 判断是否有缓存 */
if (cacheData == nil) {
/** 是否允许请求数据 */
self.reloadData = YES;
}else{
/** 是否允许请求数据 */
self.reloadData = NO;
}
}else if (cachePolicy == ClientReturnCacheDataDontLoad) {
/** 是否允许请求数据 */
self.reloadData = NO;
}
/** 返回缓存数据 */
completion(cacheData, nil);
}
#pragma mark - 对外的数据请求接口
+ (void)request:(HTTPRequestType)type
urlString:(NSString *)urlString
parameters:(NSMutableDictionary *)parameters
cachePolicy:(HTTPCacheType)cachePolicy
completion:(HTTPDataPass)completion{
// parameters[@"user_token"] = UserToken;
/** 创建一个本类的对象, 用来调用本类的私有实力方法 */
RequestDATA * request = [[RequestDATA alloc] init];
/** 判断缓存策略 */
if (cachePolicy != ClientReloadIgnoringLocalCacheData) {
/** 获取磁盘缓存 */
[request getCacheDataWithURLString:urlString parameters:parameters cachePolicy:cachePolicy completion:completion];
/** 判断是否允许请求数据, 如果不允许就直接返回 */
if (request.isReloadData == NO) {
return ;
}
}
/** 开始请求网络数据之前显示指示器 */
dispatch_async(dispatch_get_main_queue(), ^{/** 回到主线程 */
[K_Key_Window showIndicatorView];
});
/** 判断请求的方式 */
if (type == 0) {
[request getDataWithURLString:urlString parameters:parameters cachePolicy:cachePolicy complement:^(id resultData, NSError *error) {
/** 返回结果 */
if (error != nil) {
K_Log(@"\n================错误信息===========================\n%@", error)
dispatch_async(dispatch_get_main_queue(), ^{/** 回到主线程 */
[K_Key_Window showMBHUDAlertWithMessage:@"服务器发生错误了!~" hideTimeInterval:1.0];
});
}
completion(resultData, error);
/** 请求数据结束时,停止指示器 */
dispatch_async(dispatch_get_main_queue(), ^{/** 回到主线程 */
[K_Key_Window hideIndicatorView];
});
}];
}else if (type == 1) {
[request postDataWithURLString:urlString parameters:parameters cachePolicy:cachePolicy complement:^(id resultData, NSError *error) {
/** 返回结果 */
if (error != nil) {
K_Log(@"\n================错误信息===========================\n%@", error)
dispatch_async(dispatch_get_main_queue(), ^{/** 回到主线程 */
[K_Key_Window showMBHUDAlertWithMessage:@"服务器发生错误了!~" hideTimeInterval:1.0];
});
}
completion(resultData, error);
/** 请求数据结束时,停止指示器 */
dispatch_async(dispatch_get_main_queue(), ^{/** 回到主线程 */
[K_Key_Window hideIndicatorView];
});
}];
}
}
#pragma mark - 私有的实际请求方法
- (void)getDataWithURLString:(NSString *)urlString parameters:(NSDictionary *)parameters cachePolicy:(HTTPCacheType)cachePolicy complement:(HTTPDataPass)block{
/** 对特殊字符转吗 */
// NSString * urlStr = [urlString stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet characterSetWithCharactersInString:@"`#%^{}\"[]|\\<> "].invertedSet];
// NSString * urlStr = [urlString stringByAddingPercentEscapesUsingEncoding:NSUTF8StringEncoding];
//NSString * urlStr = [urlString stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceCharacterSet]];
NSString * urlStr = [urlString stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
/** 发送网络请求 */
[self.manager GET:urlStr parameters:parameters progress:^(NSProgress * _Nonnull downloadProgress) {
/** 进度回调 */
} success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) {
/** 成功回调 */
/** 缓存数据, 做容错处理 */
if (responseObject != nil) {
/** 返回数据给外界 */
block(responseObject, nil);
/** 判断是否需要缓存 */
if (cachePolicy != ClientReloadIgnoringLocalCacheData) {
[NetworkCache setHTTPCache:responseObject URLString:urlString parameters:parameters];
}
}
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
/** 失败回调 */
block(nil, error);
}];
}
+(instancetype)getInstance {
RequestDATA *net = [[RequestDATA alloc] init];
return net;
}
- (void)postDataWithURLString:(NSString *)urlString parameters:(NSDictionary *)parameters cachePolicy:(HTTPCacheType)cachePolicy complement:(HTTPDataPass)block{
/** 发送网络请求 */
[self.manager POST:urlString parameters:parameters progress:^(NSProgress * _Nonnull uploadProgress) {
/** 进度回调 */
} success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) {
/** 成功回调 */
/** 缓存数据, 做容错处理 */
if (responseObject != nil) {
/** 返回数据给外界 */
block(responseObject, nil);
/** 判断是否需要缓存 */
if (cachePolicy != ClientReloadIgnoringLocalCacheData) {
[NetworkCache setHTTPCache:responseObject URLString:urlString parameters:parameters];
}
}
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
/** 失败回调 */
block(nil, error);
}];
}
/** 懒加载, 并设置请求的支持格式 */
- (AFHTTPSessionManager *)manager{
if (_manager == nil) {
/** 请求对象 */
_manager =[AFHTTPSessionManager manager];
/** 设置响应
响应解析器, 这样返回的数据就是解析好的JSON数据, 不需要再做反序列化 */
_manager.responseSerializer = [AFJSONResponseSerializer serializerWithReadingOptions:NSJSONReadingAllowFragments];
/** 支持的数据格式 */
NSSet * set = [NSSet setWithObjects:
@"application/json",
@"text/json",
@"text/javascript",
@"text/html",
@"text/plain",
@"image/jpg",
nil];
_manager.responseSerializer.acceptableContentTypes = set;
/** 设置请求 */
_manager.requestSerializer = [AFHTTPRequestSerializer serializer];
/** 将用户的token放在请求头中发送给后台 */
// [_manager.requestSerializer setValue:K_Read_UserToken forHTTPHeaderField:@"token"];
/** 设置请求超时时间, AFN默认是60秒 */
[_manager.requestSerializer willChangeValueForKey:@"timeoutInterval"];
_manager.requestSerializer.timeoutInterval = 15.0f;
[_manager.requestSerializer didChangeValueForKey:@"timeoutInterval"];
/** AF自动处理返回NULL对象的异常 */
AFJSONResponseSerializer * jsonResponse = (AFJSONResponseSerializer *)_manager.responseSerializer;
jsonResponse.removesKeysWithNullValues = YES;
}
return _manager;
}
@end
网友评论