对AFNetworking的3.x版本的一个封装,已集成到cocoapods,提供了请求悬浮窗显示于隐藏、延迟显示悬浮窗、请求时屏幕点击响应、网络超时设置和重试次数设置。HDNetTools, based on AFNetworking encapsulation, provides request suspending windows to hide, delay display suspension windows, request screen click response, network timeout settings and retry times settings.
一、HDNetTool使用说明
该工具是对AFNetworking的3.x版本的一个封装,提供了返回json格式检测、请求悬浮窗显示于隐藏、延迟显示悬浮窗、请求时屏幕点击响应、网络超时设置和重试次数设置。
为了使用方便,提供了下面的几个请求方式用作不同的用途。
typedef NS_ENUM(NSUInteger, HDNetToolRequestType) {
HDNetToolRequestTypePost = 0, //POST: 普通post请求,返回jsonData
HDNetToolRequestTypeGet, //GET: 普通get请求,返回jsonData
HDNetToolRequestTypeUploadFileAndData, //POST: 上传文件和数据,返回jsonData
HDNetToolRequestTypePostDownLoadFile, //POST: 带参数post下载数据或文件
HDNetToolRequestTypeGetDownLoadFile, //GET: 不带参数get下载数据或文件
HDNetToolRequestTypeUploadAndDownLoad //POST: 上传文件之后返回的数据是需要下载的文件流类型
};
二、可配置选项
该工具在请求时提供了HDNetToolConfig用来配置请求信息,下面几个可选择的配置项
///请求时屏幕是否可以点击,默认为NO:不可点击
@property (assign,nonatomic)BOOL canTouchWhenRequest;
///屏幕是否隐藏请求的旋转标识,默认为NO:显示请求标识
@property (assign,nonatomic)BOOL hiddenProgressHUD;
///设置旋转的标识的显示文字,默认为旋转不带文字,显示请求标识时有效
@property (strong,nonatomic)NSString *progressHUDText;
///发起请求之后多少秒之后没回调才开始显示旋转标识,不设置的话,请求时会立即显示旋转标识
@property (assign,nonatomic)float delayShowProgressHUD;
///设置网络超时时间,默认为10s
@property (assign,nonatomic)float timeoutInterval;
///设置请求失败之后的重试次数,默认为3次
@property (assign,nonatomic)int retryCount;
///是否异步发起请求,默认为NO
@property (assign,nonatomic)BOOL shouldAsyn;
三、发送请求
发送请求就是统一的一个函数,参数就是配置项和发送请求的类型
+(void)startRequestWithHDNetToolConfig:(HDNetToolConfig*)netToolConfig WithType:(HDNetToolRequestType)requestType andCompleteCallBack:(HDNetToolCompetionHandler)completion;
四、取消请求
可以通过url取消请求,也可以取消所有正在进行的请求
///通过URL取消请求
+(void)cancelRequestByURL:(NSString*)url;
///通过HDNetToolConfig取消请求
+(void)cancelRequestByConfig:(HDNetToolConfig*)netToolConfig;
///取消所有请求
+(void)cancelAllNetRequest;
五、网络状态
监听网络状态和获取当前的网络状态
///检测网络状态
+(void)startNetMonitoring;
///调用一次检测网络状态,检测完毕之后回调
+(void)startNetMonitoringComplete:(HDNetToolMonitoringCompetionHandler)completion;
///检测完毕之后当前的网络状态,会自动更改,需要调用过startNetMonitoring或者startNetMonitoringComplete才生效
+(YZNetReachabilityStatus)currentNetStatue;
六、返回json参数检测
YZNetReciveParamCheckTools用来检测返回参数的类型和值是否符合规则。dic是要检测的内容,url和param是请求的url和参数,用来记录发生异常的参数。
-(instancetype)initWithDictionary:(NSDictionary*)dic withPostErrorWithUrl:(NSString*)url param:(NSDictionary*)param;
添加要检测的字段
/**
添加检测的字段
@param name 字段key值
@param paramType 字段指定的类型
@param canNil 是否可空
*/
-(void)addCheckParamName:(NSString*)name withType:(YZNetErrorParamType)paramType canNil:(BOOL)canNil;
开始检测接受的参数是否符合要求
/**
开始检测是否符合要求
@param competionHandler 检测完成后发生的回调
@return 是否符合要求
*/
-(BOOL)startCheckReciveParam:(HDNetToolReciveParamCheckCompetionHandler)competionHandler;
七、接受数据输出开关
在HDNetToolDefConfig.h
文件中,可以设置显示/隐藏接受数据的输出信息
#define HDNetTool_DEBUG_MODE true //开启控制台输出返回数据
#define HDNetTool_DEBUG_MODE false //关闭输出
八、导入使用
文件导入
将HDNetTool文件夹的内容导入到项目即可
cocoapods安装
pod 'HDNetTools'
九、使用方法
导入头文件
#import "HDNetToolsHeader.h"
监测网络状态的变化通知
//添加网络变化的通知
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(netChange:) name:HDNetworkingReachabilityDidChangeNotification object:nil];
///检测网络状态
[HDNetTools startNetMonitoring];
///网络状态变化的通知
-(void)netChange:(NSNotification*)notification{
HDNetReachabilityStatus status = [[notification.userInfo objectForKey:HDNetworkingReachabilityNotificationStatusItem] integerValue];
NSLog(@"%ld",(long)status);
}
发送请求
//普通post请求
-(void)testPostRequst{
//普通post请求
NSString *url=[NSString stringWithFormat:@"https://api.tianapi.com/wxnew/?key=c9c06e42004367180cd41f5ca34297f5&num=%ld&rand=1&page=%ld",(long)2,(long)1];
HDNetToolConfig *netToolsConfig = [[HDNetToolConfig alloc] initWithUrl:url];
[HDNetToolS startRequestWithHDNetToolConfig:netToolsConfig CompleteCallBack:^(NSURLResponse *response, id responseObject, NSError *error) {
NSLog(@"%@",responseObject);
}];
}
接受数据的检测
-(void)testPostReciveParamCheck{
NSString *url=[NSString stringWithFormat:@"https://api.tianapi.com/wxnew/?key=c9c06e42004367180cd41f5ca34297f5&num=%ld&rand=1&page=%ld",(long)2,(long)1];
HDNetToolConfig *netToolsConfig = [[HDNetToolConfig alloc] initWithUrl:url];
[HDNetTools startRequestWithHDNetToolConfig:netToolsConfig WithType:HDNetToolRequestTypeGet andCompleteCallBack:^(NSURLResponse *response, id responseObject, NSError *error) {
//检测返回的类型是不是指定类型
YZNetReciveParamCheckTools *checkTools = [[YZNetReciveParamCheckTools alloc] initWithDictionary:[[responseObject objectForKey:@"newslist"] objectAtIndex:0] withPostErrorWithUrl:netToolsConfig.url param:netToolsConfig.requestData];
//设置检测title是否是数字,并且不可空
[checkTools addCheckParamName:@"title" withType:kYZNetErrorParamNumber canNil:NO];
//判断可以用下面三种方式
//1、可以在block里面回调,直接写逻辑
[checkTools startCheckReciveParam:^(BOOL isAccord, NSString *url, NSString *param, NSString *value, NSString *errorStr) {
if (isAccord) {
NSLog(@"1111检测通过");
}else{
NSLog(@"1111检测不通过,不通过的参数是:url:%@,param:%@,value:%@,errorStr:%@",url,param,value,errorStr);
}
}];
//2、也可以不使用block,只判断返回值写逻辑
if ([checkTools startCheckReciveParam:nil]) {
NSLog(@"2222检测通过");
}
else{
NSLog(@"2222检测不通过");
}
//3、或者使用回调和判断返回值同时执行
if ([checkTools startCheckReciveParam:^(BOOL isAccord, NSString *url, NSString *param, NSString *value, NSString *errorStr) {
if (isAccord) {
NSLog(@"33333检测通过");
}else{
NSLog(@"3333检测不通过,不通过的参数是:url:%@,param:%@,value:%@,errorStr:%@",url,param,value,errorStr);
}
}]) {
NSLog(@"3333检测不通过,不通过的参数是");
}
else{
NSLog(@"3333检测不通过");
}
}];
}
文件的get下载
-(void)testFileDownload{
NSString *urlStr = @"https://app.huaimayi.com/qian/2018-01-01.jpg";
HDNetToolConfig *netToolConfig = [[HDNetToolConfig alloc] initWithUrl:urlStr];
WEAKSELF
[HDNetTools startRequestWithHDNetToolConfig:netToolConfig WithType:HDNetToolRequestTypeGetDownLoadFile andCompleteCallBack:^(NSURLResponse *response, id responseObject, NSError *error) {
if (error) {
[SVProgressHUD showErrorWithStatus:error.localizedDescription];
}
else{
NSURL *filePath = responseObject;
UIImage *image = [[UIImage alloc] initWithContentsOfFile:[HDNetTool conVertToStr:filePath]];
UIImageView *imageView = [[UIImageView alloc] initWithFrame:CGRectMake(100, 100, 300, 300)];
[imageView setImage:image];
[weakSelf.view addSubview:imageView];
}
}];
}
十、文件说明
文件名 | 文件作用说明 |
---|---|
HDNetToolsHeader | HDNetTools库的头文件 |
HDNetToolDefConfig | HDNetTools库的配置选项和枚举列表 |
HDUIWindowsTools | 控制请求是否可点击以及背景颜色等配置 |
HDNetTools | HDNetTools库主文件,请求全部在该文件 |
HDNetToolMultipartFormData | 上传下载的多媒体数据格式 |
HDNetReciveParamCheckTools | 返回json格式的检查函数 |
十一、其他说明
该库的网络请求基于AFNetworking,飘窗提示使用的SVProgressHUD,所以如果没有这两个库会报错,如果想使用其他的飘窗库,可以将HDNetTool.m文件中
[SVProgressHUD show];
[SVProgressHUD showWithStatus:netToolConfig.progressHUDText];
[SVProgressHUD dismiss];
之类的调用注销或者替换掉即可。
十二、文件链接
gitHub:https://github.com/DamonHu/HDNetTools
希望可以多提建议,觉得好用给个star
重要fix记录
2018-01-20 v1.2.0
- 增加网络检测的回调
- 修改网络返回参数的检测方式
- 完善demo
2018-01-07 v1.0.3
- 修正了内存重复创建的问题,现在请求内存平稳
版权属于:东哥笔记 - DongGe.me
本文链接:https://dongge.org/blog/758.html
自2017年12月26日起,『转载以及大段采集进行后续编辑』须注明本文标题和链接!否则禁止所有转载和采集行为!