BANetManager
1、功能及简介
- 1、集成 get / post / put / delete 等常用请求方式的封装
- 2、集成单图/多图上传，让图片上传更简单，自带压缩处理
- 3、集成视频上传/下载，和文件下载，让视频的上传下载更方便，支持异步下载【已测试多个项目通过】
- 4、集成网络监测，让你实时监测你的宝贝APP的网络状态【已经测试通过】
- 5、新增 https 请求参数自定义：requestSerializer、responseSerializer、请求头等的配置
- 6、自定义 CA 证书 和 HTTPS 请求配置，只需把证书导入项目目录即可
- 7、如果使用PHP后台，后台不会对接此接口的话，博爱已经为你们量身定做了PHP后台接口，你们只需要把文件夹中的 postdynamic.php 文件发送给你们的PHP后台同事，他们就知道了，里面都有详细说明！
- 8、新增 YYCache 缓存处理，有缓存开关，随时缓存
- 9、新增自定义：超时设置，取消单个网络请求和取消所有网络请求
- 10、史上最全的 AFN 请求 NSLog 打印，详见 demo 控制台打印结果
2、图片示例
3、安装、导入示例和源码地址
- 1、pod 导入【最新版本：version 2.2.2】：
pod 'BANetManager'
如果发现pod search BANetManager搜索出来的不是最新版本，需要在终端执行 cd 转换文件路径命令退回到 desktop，然后执行pod setup命令更新本地spec缓存（可能需要几分钟），然后再搜索就可以了。
具体步骤：- pod setup : 初始化
- pod repo update : 更新仓库
- pod search BANetManager
- 2、文件夹拖入：下载demo，把 BANetManager 文件夹拖入项目即可，
- 3、导入头文件：
#import "BANetManager.h" - 4、项目源码地址：
OC 版 ：https://github.com/BAHome/BANetManager
4、BANetManager 的类结构及 demo 示例
BANetManager.h
#import <Foundation/Foundation.h>
#import <UIKit/UIKit.h>
#define BANetManagerShare [BANetManager sharedBANetManager]
#define BAWeak __weak __typeof(self) weakSelf = self
/*! 过期属性或方法名提醒 */
#define BANetManagerDeprecated(instead) __deprecated_msg(instead)
/*! 使用枚举NS_ENUM:区别可判断编译器是否支持新式枚举,支持就使用新的,否则使用旧的 */
typedef NS_ENUM(NSUInteger, BANetworkStatus)
{
/*! 未知网络 */
BANetworkStatusUnknown = 0,
/*! 没有网络 */
BANetworkStatusNotReachable,
/*! 手机 3G/4G 网络 */
BANetworkStatusReachableViaWWAN,
/*! wifi 网络 */
BANetworkStatusReachableViaWiFi
};
/*！定义请求类型的枚举 */
typedef NS_ENUM(NSUInteger, BAHttpRequestType)
{
/*! get请求 */
BAHttpRequestTypeGet = 0,
/*! post请求 */
BAHttpRequestTypePost,
/*! put请求 */
BAHttpRequestTypePut,
/*! delete请求 */
BAHttpRequestTypeDelete
};
typedef NS_ENUM(NSUInteger, BAHttpRequestSerializer) {
/** 设置请求数据为JSON格式*/
BAHttpRequestSerializerJSON,
/** 设置请求数据为HTTP格式*/
BAHttpRequestSerializerHTTP,
};
typedef NS_ENUM(NSUInteger, BAHttpResponseSerializer) {
/** 设置响应数据为JSON格式*/
BAHttpResponseSerializerJSON,
/** 设置响应数据为HTTP格式*/
BAHttpResponseSerializerHTTP,
};
/*! 实时监测网络状态的 block */
typedef void(^BANetworkStatusBlock)(BANetworkStatus status);
/*! 定义请求成功的 block */
typedef void( ^ BAResponseSuccess)(id response);
/*! 定义请求失败的 block */
typedef void( ^ BAResponseFail)(NSError *error);
/*! 定义上传进度 block */
typedef void( ^ BAUploadProgress)(int64_t bytesProgress,
int64_t totalBytesProgress);
/*! 定义下载进度 block */
typedef void( ^ BADownloadProgress)(int64_t bytesProgress,
int64_t totalBytesProgress);
/*!
* 方便管理请求任务。执行取消，暂停，继续等任务.
* - (void)cancel，取消任务
* - (void)suspend，暂停任务
* - (void)resume，继续任务
*/
typedef NSURLSessionTask BAURLSessionTask;
@interface BANetManager : NSObject
/**
创建的请求的超时间隔（以秒为单位），此设置为全局统一设置一次即可，默认超时时间间隔为30秒。
*/
@property (nonatomic, assign) NSTimeInterval timeoutInterval;
/**
设置网络请求参数的格式，此设置为全局统一设置一次即可，默认：BAHttpRequestSerializerJSON
*/
@property (nonatomic, assign) BAHttpRequestSerializer requestSerializer;
/**
设置服务器响应数据格式，此设置为全局统一设置一次即可，默认：BAHttpResponseSerializerJSON
*/
@property (nonatomic, assign) BAHttpResponseSerializer responseSerializer;
/**
自定义请求头：httpHeaderField
*/
@property(nonatomic, strong) NSDictionary *httpHeaderFieldDictionary;
/*!
* 获得全局唯一的网络请求实例单例方法
*
* @return 网络请求类BANetManager单例
*/
+ (instancetype)sharedBANetManager;
#pragma mark - 网络请求的类方法 --- get / post / put / delete
/**
网络请求的实例方法 get
@param urlString 请求的地址
@param isNeedCache 是否需要缓存，只有 get / post 请求有缓存配置
@param parameters 请求的参数
@param successBlock 请求成功的回调
@param failureBlock 请求失败的回调
@param progress 进度
@return BAURLSessionTask
*/
+ (BAURLSessionTask *)ba_request_GETWithUrlString:(NSString *)urlString
isNeedCache:(BOOL)isNeedCache
parameters:(NSDictionary *)parameters
successBlock:(BAResponseSuccess)successBlock
failureBlock:(BAResponseFail)failureBlock
progress:(BADownloadProgress)progress;
/**
网络请求的实例方法 post
@param urlString 请求的地址
@param isNeedCache 是否需要缓存，只有 get / post 请求有缓存配置
@param parameters 请求的参数
@param successBlock 请求成功的回调
@param failureBlock 请求失败的回调
@param progress 进度
@return BAURLSessionTask
*/
+ (BAURLSessionTask *)ba_request_POSTWithUrlString:(NSString *)urlString
isNeedCache:(BOOL)isNeedCache
parameters:(NSDictionary *)parameters
successBlock:(BAResponseSuccess)successBlock
failureBlock:(BAResponseFail)failureBlock
progress:(BADownloadProgress)progress;
/**
网络请求的实例方法 put
@param urlString 请求的地址
@param parameters 请求的参数
@param successBlock 请求成功的回调
@param failureBlock 请求失败的回调
@param progress 进度
@return BAURLSessionTask
*/
+ (BAURLSessionTask *)ba_request_PUTWithUrlString:(NSString *)urlString
parameters:(NSDictionary *)parameters
successBlock:(BAResponseSuccess)successBlock
failureBlock:(BAResponseFail)failureBlock
progress:(BADownloadProgress)progress;
/**
网络请求的实例方法 delete
@param urlString 请求的地址
@param parameters 请求的参数
@param successBlock 请求成功的回调
@param failureBlock 请求失败的回调
@param progress 进度
@return BAURLSessionTask
*/
+ (BAURLSessionTask *)ba_request_DELETEWithUrlString:(NSString *)urlString
parameters:(NSDictionary *)parameters
successBlock:(BAResponseSuccess)successBlock
failureBlock:(BAResponseFail)failureBlock
progress:(BADownloadProgress)progress;
/**
上传图片(多图)
@param urlString 上传的url
@param parameters 上传图片预留参数---视具体情况而定 可移除
@param imageArray 上传的图片数组
@param fileName 上传的图片数组fileName
@param successBlock 上传成功的回调
@param failureBlock 上传失败的回调
@param progress 上传进度
@return BAURLSessionTask
*/
+ (BAURLSessionTask *)ba_uploadImageWithUrlString:(NSString *)urlString
parameters:(NSDictionary *)parameters
imageArray:(NSArray *)imageArray
fileName:(NSString *)fileName
successBlock:(BAResponseSuccess)successBlock
failurBlock:(BAResponseFail)failureBlock
upLoadProgress:(BAUploadProgress)progress;
/**
视频上传
@param urlString 上传的url
@param parameters 上传视频预留参数---视具体情况而定 可移除
@param videoPath 上传视频的本地沙河路径
@param successBlock 成功的回调
@param failureBlock 失败的回调
@param progress 上传的进度
*/
+ (void)ba_uploadVideoWithUrlString:(NSString *)urlString
parameters:(NSDictionary *)parameters
videoPath:(NSString *)videoPath
successBlock:(BAResponseSuccess)successBlock
failureBlock:(BAResponseFail)failureBlock
uploadProgress:(BAUploadProgress)progress;
/**
文件下载
@param urlString 请求的url
@param parameters 文件下载预留参数---视具体情况而定 可移除
@param savePath 下载文件保存路径
@param successBlock 下载文件成功的回调
@param failureBlock 下载文件失败的回调
@param progress 下载文件的进度显示
@return BAURLSessionTask
*/
+ (BAURLSessionTask *)ba_downLoadFileWithUrlString:(NSString *)urlString
parameters:(NSDictionary *)parameters
savaPath:(NSString *)savePath
successBlock:(BAResponseSuccess)successBlock
failureBlock:(BAResponseFail)failureBlock
downLoadProgress:(BADownloadProgress)progress;
#pragma mark - 网络状态监测
/*!
* 开启实时网络状态监测，通过Block回调实时获取(此方法可多次调用)
*/
+ (void)ba_startNetWorkMonitoringWithBlock:(BANetworkStatusBlock)networkStatus;
#pragma mark - 自定义请求头
/**
* 自定义请求头
*/
+ (void)ba_setValue:(NSString *)value forHTTPHeaderKey:(NSString *)HTTPHeaderKey;
#pragma mark - 取消 Http 请求
/*!
* 取消所有 Http 请求
*/
+ (void)ba_cancelAllRequest;
/*!
* 取消指定 URL 的 Http 请求
*/
+ (void)ba_cancelRequestWithURL:(NSString *)URL;
@end
demo 示例
- (void)viewDidLoad {
[super viewDidLoad];
// Do any additional setup after loading the view, typically from a nib.
self.title = @"AFNetworking 3.1 封装demo";
/*! 网络状态实时监测可以使用 block 回调，也可以使用单独方法判断 */
[self ba_netType];
}
#pragma mark - 网络类型判断
- (void)ba_netType
{
BAWeak;
[BANetManager ba_startNetWorkMonitoringWithBlock:^(BANetworkStatus status) {
NSString *msg;
switch (status) {
case 0:
{
msg = @"未知网络";
BAKit_ShowAlertWithMsg(msg);
}
break;
case 1:
{
msg = @"没有网络";
BAKit_ShowAlertWithMsg(msg);
}
break;
case 2:
{
msg = @"您的网络类型为：手机 3G/4G 网络";
BAKit_ShowAlertWithMsg(msg);
}
break;
case 3:
{
msg = @"您的网络类型为：wifi 网络";
/*! wifi 网络下请求网络：可以在父类写此方法，具体使用demo，详见：https://github.com/boai/BABaseProject */
BAKit_ShowAlertWithMsg(msg);
}
break;
default:
break;
}
}];
}
#pragma mark - ***** get
- (IBAction)getData:(UIButton *)sender
{
BAWeak;
// 如果打印数据不完整，是因为 Xcode 8 版本问题，请下断点打印数据
[BANetManager ba_request_GETWithUrlString:url5 isNeedCache:YES parameters:nil successBlock:^(id response) {
NSLog(@"get请求数据成功： *** %@", response);
} failureBlock:^(NSError *error) {
} progress:nil];
}
#pragma mark - ***** post
- (IBAction)postData:(UIButton *)sender
{
BAWeak;
// 自定义超时设置
BANetManagerShare.timeoutInterval = 15;
// 自定义添加请求头
NSDictionary *headerDict = @{@"Accept":@"application/json", @"Accept-Encoding":@"gzip"};
BANetManagerShare.httpHeaderFieldDictionary = headerDict;
// 自定义更改 requestSerializer
// BANetManagerShare.requestSerializer = BAHttpRequestSerializerHTTP;
// 自定义更改 responseSerializer
// BANetManagerShare.responseSerializer = BAHttpRequestSerializerHTTP;
int page = 1;
NSDictionary *parameters = [NSDictionary dictionaryWithObjectsAndKeys:@(page).stringValue, @"page", @"10", @"per_page", nil];;
// 如果打印数据不完整，是因为 Xcode 8 版本问题，请下断点打印数据
[BANetManager ba_request_POSTWithUrlString:url5 isNeedCache:YES parameters:parameters successBlock:^(id response) {
NSLog(@"post请求数据成功： *** %@", response);
} failureBlock:^(NSError *error) {
} progress:nil];
}
#pragma mark - ***** 下载视频、图片
- (IBAction)downloadData:(UIButton *)sender
{
UIButton *downloadBtn = (UIButton *)sender;
NSString *path1 = [NSHomeDirectory() stringByAppendingString:[NSString stringWithFormat:@"/Documents/半塘.mp4"]];
// NSString *path2 = [NSHomeDirectory() stringByAppendingString:[NSString stringWithFormat:@"/Documents/image123.mp3"]];
NSLog(@"路径：%@", path1);
/*! 查找路径中是否存在"半塘.mp4"，是，返回真；否，返回假。 */
// BOOL result2 = [path1 hasSuffix:@"半塘.mp4"];
// NSLog(@"%d", result2);
/*!
下载前先判断该用户是否已经下载，目前用了两种方式：
1、第一次下载完用变量保存，
2、查找路径中是否包含改文件的名字
如果下载完了，就不要再让用户下载，也可以添加alert的代理方法，增加用户的选择！
*/
// if (isFinishDownload || result2)
// {
// [[[UIAlertView alloc] initWithTitle:@"温馨提示：" message:@"您已经下载该视频！" delegate:nil cancelButtonTitle:@"确 定" otherButtonTitles:nil, nil] show];
// return;
// }
BAWeak;
NSString *url = @"http://static.yizhibo.com/pc_live/static/video.swf?onPlay=YZB.play&onPause=YZB.pause&onSeek=YZB.seek&scid=pALRs7JBtTRU9TWy";
self.tasks = [BANetManager ba_downLoadFileWithUrlString:url
parameters:nil
savaPath:path1
successBlock:^(id response) {
NSLog(@"下载完成，路径为：%@", response);
self.downloadLabel.text = @"下载完成";
isFinishDownload = YES;
[downloadBtn setTitle:@"下载完成" forState:UIControlStateNormal];
[downloadBtn setTitleColor:[UIColor redColor] forState:UIControlStateNormal];
BAKit_ShowAlertWithMsg(@"视频下载完成！");
} failureBlock:^(NSError *error) {
} downLoadProgress:^(int64_t bytesProgress, int64_t totalBytesProgress) {
/*! 封装方法里已经回到主线程，所有这里不用再调主线程了 */
self.downloadLabel.text = [NSString stringWithFormat:@"下载进度：%.2lld%%",100 * bytesProgress/totalBytesProgress];
[downloadBtn setTitle:@"下载中..." forState:UIControlStateNormal];
}];
// sender.selected = !sender.selected;
// if (sender.selected)
// {
// [self.tasks resume];
// }
// else
// {
// [self.tasks suspend];
// UIButton *downloadBtn = (UIButton *)sender;
// [downloadBtn setTitle:@"暂停下载" forState:UIControlStateNormal];
// }
}
#pragma mark - ***** 上传图片
- (IBAction)uploadImageData:(UIButton *)sender
{
/*!
1、此上传图片单张、多图上传都经过几十个项目亲测可用，大家可以放心使用，使用过程中有问题，请加群：479663605 进行反馈，多谢！
2、此处只需要传URL 和 parameters，和你的image数组、FileName就行了，具体压缩方法都已经做好处理！
3、注意：如果使用PHP后台，后台不会对接此接口的话，博爱已经为你们量身定做了PHP后台接口，你们只需要把文件夹中的 postdynamic.php 文件发送给你们的PHP后台同事，他们就知道了，里面都有详细说明！
*/
[BANetManager ba_uploadImageWithUrlString:nil parameters:nil imageArray:nil fileName:nil successBlock:^(id response) {
} failurBlock:^(NSError *error) {
} upLoadProgress:^(int64_t bytesProgress, int64_t totalBytesProgress) {
}];
}
#pragma mark - ***** 上传视频
- (IBAction)uploadVideoData:(UIButton *)sender
{
/*!
1、此上传视频都经过几十个项目亲测可用，大家可以放心使用，使用过程中有问题，请加群：479663605 进行反馈，多谢！
2、此处只需要传URL 和 parameters就行了，具体压缩方法都已经做好处理！
*/
[BANetManager ba_uploadVideoWithUrlString:nil parameters:nil videoPath:nil successBlock:^(id response) {
} failureBlock:^(NSError *error) {
} uploadProgress:^(int64_t bytesProgress, int64_t totalBytesProgress) {
}];
}
- (IBAction)putData:(UIButton *)sender
{
NSString *url = @"http://120.76.245.240:8080/bda/resetPassword/?account=761463699@qq.com&password=q&OTP=634613";
NSDictionary *dict = @{@"EquipmentType":@"iPhone", @"EquipmentGUID":@"b61df00d-87db-426f-bc5a-bc8fffa907db"};
[BANetManager ba_request_PUTWithUrlString:url parameters:dict successBlock:^(id response) {
NSLog(@"*********00000 : %@", response);
} failureBlock:^(NSError *error) {
} progress:nil];
}
- (IBAction)deleteData:(UIButton *)sender
{
[BANetManager ba_request_DELETEWithUrlString:nil parameters:nil successBlock:nil failureBlock:nil progress:nil];
}
其他示例可下载demo查看源码！
5、更新记录：【倒叙】
欢迎使用 【BAHome】 系列开源代码 ！ 如有更多需求，请前往：【https://github.com/BAHome】
最新更新时间：2017-05-03 【倒叙】
最新Version：【Version：2.2.2】
更新内容：
2.2.1、优化方法名命名规范
2.2.2、优化网络状态实时监测 block 回调，去除多余设置，需要网络判断，直接调用block回调即可
2.2.3、新增 YYCache 缓存处理
2.2.4、新增自定义：超时设置
2.2.5、新增自定义：requestSerializer设置
2.2.6、新增自定义：responseSerializer设置
2.2.7、新增自定义：请求头设置
2.2.8、新增自定义 CA 证书 和 HTTPS 请求配置，只需把证书导入项目目录即可，无需设置
2.2.9、新增史上最全的 AFN 请求 NSLog 打印，详见 demo 控制台打印结果
2.2.10、新增 DEBUG 模式下的 NSLog 判断，release 下不会打印，请放心使用
2.2.11、如果打印数据不完整，是因为 Xcode 8 版本问题，请下断点打印数据
2.2.12、由于新版本改动较大，原有方法命名可能有所改动，希望老用户见谅！
2.2.13、目前版本较稳定，稍后奉上 pod 版本！请大家耐心等待
最新更新时间：2016-11-24 【倒叙】
最新Version：【Version：2.1】
更新内容：
2.1.1、优化方法名命名规范
2.1.2、新增网络状态实时监测 block 回调，新增单独网络监测 bool 返回，详见 demo
2.1.3、新增旧方法更新提示
2.1.4、优化各种注释
最新更新时间：2016-11-17
最新Version：【Version：2.0】
更新内容：
2.0.1、优化方法名命名规范
2.0.2、新增部分注释
2.0.3、视频上传方法对接，目前有很多项目对接成功
6、bug 反馈 和 联系方式
1、开发中遇到 bug，希望小伙伴儿们能够及时反馈与我们 BAHome 团队，我们必定会认真对待每一个问题！
2、联系方式
QQ群：479663605 【注意：此群为 2 元 付费群，介意的小伙伴儿勿扰！】
博爱QQ：137361770
博爱微博：
7、开发环境 和 支持版本
开发使用 Xcode Version 8.3.2 (8E2002) ，理论上支持所有 iOS 版本，如有版本适配问题，请及时反馈！多谢合作！
8、感谢
感谢 BAHome 团队成员倾力合作，后期会推出一系列 常用 UI 控件的封装，大家有需求得也可以在 issue 提出，如果合理，我们会尽快推出新版本！
BAHome 的发展离不开小伙伴儿的信任与推广，再次感谢各位小伙伴儿的支持！