iOS开发之网络请求(基于AFNetworking的再封装)
最近一直很忙也没有什么时间写博客了。放假了休息一下,就写一篇博客来总结一下最近做项目中出现过的问题吧!!!
首先,在项目中我的起到了什么作用,无非就是把美工(UI设计师)给我们的图显示出来,然后再和服务器进行交互。
那个我们和服务器怎么交互呢?最简单的方式就是说话呗,但是我们要跟服务器说话必须通过我们彼此能听的懂的话来交流,也就需要制定很多的协议了(http,tcp,udp等,这个有兴趣的朋友可以了解一下网络协议的东西)。但是我平常最常使用的还是http协议。
http://www.cnblogs.com/li0803/archive/2008/11/03/1324746.html这篇博客详细讲解了http协议的东西(我能说是我随便百度了一篇博客吗?)
然后github上的AFNetworking应该现在是应用的最广泛的网络请求三方库了吧。那么今天就来说一下AFNetworing。
既然人家已经封装的这么好了,我们为什么还要多此一举再封装呢?
那现在就来说一下再封装的意义是什么?
最重要的意义差不多就是统一接口(这个也是封装的一个作用,如果不了解封装的同学可以去看看封装的用处,是个提高效率的非常有效的办法),这一点要是再多人项目中尤其能体现出来,我的一个同事用的是系统自带的MKNetworking,很多人可能听都没听过,他虽然用的很好,我也能看的懂,但是还是感觉看起来很难受,因为我根本不想看到他的具体用法和实现是什么样子的(虽然真正敲起来可能也只是多了两行代码而已),只需要调一个接口就什么都用了不就好了,为什么还要敲那么多重复的代码呢(Don't repeat yourself)?
好,下面我就来对AFNetworking再封装:
首先,还是说一下封装的事情,如果是你自己用,那么你可以随便写一写,因为你不用注释也能看的懂。但是如果是给几个人用,你可以直接告诉他们,或者说是写一个比较详细的注释,以便他们日后忘记了看一下就知道每个参数的意义是什么了!!!我将网络请求封装成了单例,详细代码见下:
那么我在网络请求的时候究竟最常用的网络请求有哪些呢?
我最常用到的就是get,post,upload及download了。(这几中请求方式也可以去了解一下他们的区别)
说了这么多的废话了来点干货。
上传文件的参数文件UploadParam.h:
@interface UploadParam : NSObject /** * 图片的二进制数据 */ @property (nonatomic, strong) NSData *data; /** * 服务器对应的参数名称 */ @property (nonatomic, copy) NSString *name; /** * 文件的名称(上传到服务器后,服务器保存的文件名) */ @property (nonatomic, copy) NSString *filename; /** * 文件的MIME类型(image/png,image/jpg等) */ @property (nonatomic, copy) NSString *mimeType; @end
HttpRequest.h的申明:
@class UploadParam; /** * 网络请求类型 */ typedef NS_ENUM(NSUInteger,HttpRequestType) { /** * get请求 */ HttpRequestTypeGet = 0, /** * post请求 */ HttpRequestTypePost }; @interface HttpRequest : NSObject + (instancetype)sharedInstance; /** * 发送get请求 * * @param URLString 请求的网址字符串 * @param parameters 请求的参数 * @param success 请求成功的回调 * @param failure 请求失败的回调 */ - (void)getWithURLString:(NSString *)URLString parameters:(id)parameters success:(void (^)(id responseObject))success failure:(void (^)(NSError *error))failure; /** * 发送post请求 * * @param URLString 请求的网址字符串 * @param parameters 请求的参数 * @param success 请求成功的回调 * @param failure 请求失败的回调 */ - (void)postWithURLString:(NSString *)URLString parameters:(id)parameters success:(void (^)(id responseObject))success failure:(void (^)(NSError *error))failure; /** * 发送网络请求 * * @param URLString 请求的网址字符串 * @param parameters 请求的参数 * @param type 请求的类型 * @param resultBlock 请求的结果 */ - (void)requestWithURLString:(NSString *)URLString parameters:(id)parameters type:(HttpRequestType)type success:(void (^)(id responseObject))success failure:(void (^)(NSError *error))failure; /** * 上传图片 * * @param URLString 上传图片的网址字符串 * @param parameters 上传图片的参数 * @param uploadParam 上传图片的信息 * @param success 上传成功的回调 * @param failure 上传失败的回调 */ - (void)uploadWithURLString:(NSString *)URLString parameters:(id)parameters uploadParam:(NSArray <UploadParam *> *)uploadParams success:(void (^)())success failure:(void (^)(NSError *error))failure; /** * 下载数据 * * @param URLString 下载数据的网址 * @param parameters 下载数据的参数 * @param success 下载成功的回调 * @param failure 下载失败的回调 */ - (void)downLoadWithURLString:(NSString *)URLString parameters:(id)parameters progerss:(void (^)())progress success:(void (^)())success failure:(void (^)(NSError *error))failure; @end
@implementation HttpRequest static id _instance = nil; + (instancetype)sharedInstance { return [[self alloc] init]; } + (instancetype)allocWithZone:(struct _NSZone *)zone { static dispatch_once_t onceToken; dispatch_once(&onceToken, ^{ _instance = [super allocWithZone:zone]; }); return _instance; } - (instancetype)init { static dispatch_once_t onceToken; dispatch_once(&onceToken, ^{ _instance = [super init]; AFNetworkReachabilityManager *manager = [AFNetworkReachabilityManager sharedManager]; [manager startMonitoring]; [manager setReachabilityStatusChangeBlock:^(AFNetworkReachabilityStatus status) { switch (status) { case AFNetworkReachabilityStatusUnknown: { // 位置网络 NSLog(@"位置网络"); } break; case AFNetworkReachabilityStatusNotReachable: { // 无法联网 NSLog(@"无法联网"); } break; case AFNetworkReachabilityStatusReachableViaWiFi: { // 手机自带网络 NSLog(@"当前使用的是2G/3G/4G网络"); } break; case AFNetworkReachabilityStatusReachableViaWWAN: { // WIFI NSLog(@"当前在WIFI网络下"); } } }]; }); return _instance; } #pragma mark -- GET请求 -- - (void)getWithURLString:(NSString *)URLString parameters:(id)parameters success:(void (^)(id))success failure:(void (^)(NSError *))failure { AFHTTPSessionManager *manager = [AFHTTPSessionManager manager]; /** * 可以接受的类型 */ manager.responseSerializer = [AFHTTPResponseSerializer serializer]; /** * 请求队列的最大并发数 */ // manager.operationQueue.maxConcurrentOperationCount = 5; /** * 请求超时的时间 */ manager.requestSerializer.timeoutInterval = 30; [manager GET:URLString parameters:nil progress:nil success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) { if (success) { success(responseObject); } } failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) { if (failure) { failure(error); } }]; } #pragma mark -- POST请求 -- - (void)postWithURLString:(NSString *)URLString parameters:(id)parameters success:(void (^)(id))success failure:(void (^)(NSError *))failure { AFHTTPSessionManager *manager = [AFHTTPSessionManager manager]; manager.responseSerializer = [AFHTTPResponseSerializer serializer]; [manager POST:URLString parameters:parameters progress:nil success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) { if (success) { success(responseObject); } } failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) { if (failure) { failure(error); } }]; } #pragma mark -- POST/GET网络请求 -- - (void)requestWithURLString:(NSString *)URLString parameters:(id)parameters type:(HttpRequestType)type success:(void (^)(id))success failure:(void (^)(NSError *))failure { AFHTTPSessionManager *manager = [AFHTTPSessionManager manager]; manager.responseSerializer = [AFHTTPResponseSerializer serializer]; switch (type) { case HttpRequestTypeGet: { [manager GET:URLString parameters:nil progress:nil success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) { if (success) { success(responseObject); } } failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) { if (failure) { failure(error); } }]; } break; case HttpRequestTypePost: { [manager POST:URLString parameters:parameters progress:nil success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) { if (success) { success(responseObject); } } failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) { if (failure) { failure(error); } }]; } break; } } - (void)uploadWithURLString:(NSString *)URLString parameters:(id)parameters uploadParam:(NSArray<UploadParam *> *)uploadParams success:(void (^)())success failure:(void (^)(NSError *))failure { AFHTTPSessionManager *manager = [AFHTTPSessionManager manager]; manager.responseSerializer = [AFHTTPResponseSerializer serializer]; [manager POST:URLString parameters:parameters constructingBodyWithBlock:^(id<AFMultipartFormData> _Nonnull formData) { for (UploadParam *uploadParam in uploadParams) { [formData appendPartWithFileData:uploadParam.data name:uploadParam.name fileName:uploadParam.filename mimeType:uploadParam.mimeType]; } } progress:nil success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) { if (success) { success(responseObject); } } failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) { if (failure) { failure(error); } }]; } #pragma mark - 下载数据 - (void)downLoadWithURLString:(NSString *)URLString parameters:(id)parameters progerss:(void (^)())progress success:(void (^)())success failure:(void (^)(NSError *))failure { AFHTTPSessionManager *manager = [[AFHTTPSessionManager alloc] initWithSessionConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration]]; NSURLRequest *request = [NSURLRequest requestWithURL:[NSURL URLWithString:URLString]]; NSURLSessionDownloadTask *downLoadTask = [manager downloadTaskWithRequest:request progress:^(NSProgress * _Nonnull downloadProgress) { if (progress) { progress(); } } destination:^NSURL * _Nonnull(NSURL * _Nonnull targetPath, NSURLResponse * _Nonnull response) { return targetPath; } completionHandler:^(NSURLResponse * _Nonnull response, NSURL * _Nullable filePath, NSError * _Nullable error) { if (failure) { failure(error); } }]; [downLoadTask resume]; } @end
我把我的demo也传到我的git上了,欢迎大家下载,下载地址为:https://git.oschina.net/wuhongxing/HXNetWorking.git。我用的是cocospod导入三方库的,如果下载了不能使用的,也可以联系我!