| Latest | 1.3.4 |
|---|---|
| Homepage | https://github.com/DamonHu/HDNetTools |
| License | MIT |
| Platforms | ios 9.0, requires ARC |
| Frameworks | UIKit |
| Authors |
HDNetTools
对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用来配置请求信息，下面几个可选择的配置项
///请求时屏幕是否可以点击，默认为YES:可以点击
@property (assign, nonatomic) BOOL canTouchWhenRequest;
///不可点击时的遮罩层颜色，默认为透明色
@property (strong, nonatomic) UIColor *maskColor;
///请求屏幕是否显示旋转标识,默认为NO:不显示请求标识
@property (assign, nonatomic) BOOL showProgressHUD;
///设置旋转的标识的显示文字，默认为旋转不带文字，显示请求标识时有效
@property (strong, nonatomic) NSString *progressHUDText;
///发起请求之后多少秒之后没回调才开始显示旋转标识,不设置的话，请求时会立即显示旋转标识
@property (assign, nonatomic) float delayShowProgressHUDTimeInterval;
///设置网络超时时间，默认为10s
@property (assign, nonatomic) float timeoutInterval;
///设置请求失败之后的重试次数，默认为3次
@property (assign, nonatomic) int retryCount;
///设置是否显示debug输出数据，默认为NO，不显示
@property (assign, nonatomic) BOOL showDebugLog;
///当前的task任务
@property (strong, nonatomic, readonly) NSURLSessionTask * task;
///请求任务进行状态
@property (assign, nonatomic, readonly) HDNetToolConfigRequestStatus requestStatus;三、发送请求
发送请求就是统一的一个函数，参数就是配置项和发送请求的类型
+ (void)startRequestWithHDNetToolConfig:(HDNetToolConfig *)netToolConfig WithType:(HDNetToolRequestType)requestType andCompleteCallBack:(HDNetToolCompetionHandler)completion;四、取消请求
可以通过url取消请求，也可以取消所有正在进行的请求
///取消对应的HDNetToolConfig请求
+ (void)cancelRequestByConfig:(HDNetToolConfig *)netToolConfig;
///取消所有对应URL取消请求
+ (void)cancelRequestByURL:(NSString *)url;
///取消所有请求
+ (void)cancelAllNetRequest;五、网络状态
监听网络状态
///实时监测网络状态，检测完毕之后回调
+ (void)startNetMonitoringComplete:(_Nullable HDNetToolMonitoringCompetionHandler)completion;
///停止监测网络状态
+ (void)stopNetMonitoring;六、返回json参数检测
YZNetReciveParamCheckTools用来检测返回参数的类型和值是否符合规则。dic是要检测的内容，url和param是请求的url和参数，用来记录发生异常的参数。
- (instancetype)initWithFatherDictionary:(NSDictionary *)dic withNetToolConfig:(HDNetToolConfig * _Nullable )netToolConfig;添加要检测的字段
/**
添加检测的字段
@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 "HDNetTools.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) {
//检测返回的类型是不是指定类型
HDNetReciveParamCheckTools *checkTools = [[HDNetReciveParamCheckTools alloc] initWithFatherDictionary:[[responseObject objectForKey:@"newslist"] objectAtIndex:0] withNetToolConfig:netToolsConfig];
//设置检测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];
}
}];
}十、文件说明
| 文件名 | 文件作用说明 |
|---|---|
| HDNetTools | HDNetTools库主文件，请求全部在该文件 |
| HDNetToolDefConfig | HDNetTools库的配置选项和枚举列表 |
| HDUIWindowsTools | 控制请求是否可点击以及背景颜色等配置 |
| HDNetToolMultipartFormData | 上传下载的多媒体数据格式 |
| HDNetReciveParamCheckTools | 返回json格式的检查函数 |
十一、其他说明
飘窗提示使用默认样式的SVProgressHUD，可以使用SVProgressHUD自定义弹窗样式
十二、文件链接
gitHub：https://github.com/DamonHu/HDNetTools
希望可以多提建议，觉得好用给个star
重要fix记录
2019-04-24 v2.2.0
增加内容：
- 增加网络状态获取停止函数
- 增加当前请求的task任务
- 增加当前请求的状态
删除内容：
- 删除过时的网络状态获取
修改优化内容
- 修改通过netToolConfig停止请求的方案
- 设置延迟显示旋转图标时不用再重复设置showProgressHUD
- 完善通过url取消时屏幕点击操作
- 完善网络请求任务处理，通过netconfig的task处理，不再单独返回请求
- 修正取消网络请求时，以前网络请求的残留
2019-04-04 v2.0.0
修改项目结构，移除无用设置
2018-02-16 v1.3.0
增加管理头文件
2018-01-20 v1.2.0
- 增加网络检测的回调
- 修改网络返回参数的检测方式
- 完善demo
2018-01-07 v1.0.3
- 修正了内存重复创建的问题,现在请求内存平稳
Latest podspec
{
"name": "HDWindowLogger",
"version": "1.3.4",
"license": {
"type": "MIT",
"file": "LICENSE"
},
"summary": "The iOS side displays the output log log on the screen, and can generate log file sharing, which is convenient for debugging information",
"homepage": "https://github.com/DamonHu/HDNetTools",
"authors": {
"DamonHu": "[email protected]"
},
"source": {
"git": "https://github.com/DamonHu/HDWindowLogger.git",
"tag": "1.3.4"
},
"requires_arc": true,
"platforms": {
"ios": "9.0"
},
"source_files": "HDWindowLogger/HDWindowLogger/*.{h,m}",
"frameworks": "UIKit",
"documentation_url": "http://blog.hudongdong.com/ios/952.html"
}
Wed, 29 May 2019 10:05:11 +0000