AFNetworking3.0以上版本的封裝--封裝程式碼（升級版）
阿新 • • 發佈：2019-02-06
這之前寫過一篇《AFN3.0以上版本的二次封裝》,主要為當時公司的專案服務，寫的針對性比較強。做過幾個不同的專案後，對網路請求的理解更加清晰了，因此寫下了這篇升級版。之前那篇文章寫過的一些細下模組，這裡就不做太多的重複介紹了，這裡主要寫下大眾適用模組。
封裝AFN目的：
1、降低工程程式碼耦合度，提高網路請求的內聚度。（比較官方的說法，主要是直接使用顯得太low）
2、降低程式碼工作量，統一管理呼叫。（懶人適用，減少工作量）
3、為以後接替這個工程的後期迭代、維護。（利人利己，還有一點程式碼潔癖）
老生常談：Request_method的規則（這裡的規則一定要和後臺人員溝通，以便後期寫請求的時候，各種隱患問題，還有就是既然給出這種規則，就一定具有它的道理
- GET：獲取資源，不會改動資源
- POST：建立記錄
- PATCH：改變資源狀態或更新部分屬性
- PUT：更新全部屬性
- DELETE：刪除資源
封裝AFN做法：
1、在新建的專案工程中引入AFNetworking（以下簡稱AFN），這裡的AFN最好使用cocoapods引入，版本在3.0及其以上。
2、新建類，繼承NSObject, 引入“AFNetworking.h”
#import <Foundation/Foundation.h>
#import "AFNetworking.h"
@interface PCNetworkManager : NSObject 封裝AFN程式碼：
.h檔案
// PCNetworkManager.h
// AFNTestDemo
#import <Foundation/Foundation.h>
#import "AFNetworking.h"
/**
* GET：獲取資源，不會改動資源
* POST：建立記錄
* PATCH：改變資源狀態或更新部分屬性
* PUT：更新全部屬性
* DELETE：刪除資源
*/
typedef NS_ENUM(NSUInteger, HTTPMethod) {
HTTPMethodGET,
HTTPMethodPOST,
HTTPMethodPUT,
HTTPMethodPATCH,
HTTPMethodDELETE,
};
@interface .m檔案
// PCNetworkManager.m
// AFNTestDemo
#import "PCNetworkManager.h"
@interface PCNetworkManager ()
@property (nonatomic, strong) AFHTTPSessionManager *sessionManager;
@end
@implementation PCNetworkManager
static PCNetworkManager *networkManager = nil;
/**
* 單例
*
* @return 網路請求類的例項，可在請求時直接呼叫方法，也是一個直接初始化的方式
*/
+ (instancetype)defaultManager {
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
if (!networkManager) {
networkManager = [[PCNetworkManager alloc] init];
}
});
return networkManager;
}
/**
初始化，APP每次啟動時會呼叫該方法，執行時不會呼叫
@return 基本的請求設定
*/
- (instancetype)init {
if (self = [super init]) {
self.sessionManager = [AFHTTPSessionManager manager];
// 設定請求以及相應的序列化器
self.sessionManager.requestSerializer = [AFJSONRequestSerializer serializer];
// 設定超時時間
self.sessionManager.requestSerializer.timeoutInterval = 10.0;
// 設定響應內容的型別
self.sessionManager.responseSerializer.acceptableContentTypes = [NSSet setWithObjects:@"application/json", @"text/json", @"text/javascript",@"text/html",nil];
}
return self;
}
#pragma mark 常用網路請求
/**
常用網路請求方式
@param requestMethod 請求方試
@param serverUrl 伺服器地址
@param apiPath 方法的連結
@param parameters 引數
@param progress 進度
@param success 成功
@param failure 失敗
@return return value description
*/
- (nullable NSURLSessionDataTask *)sendRequestMethod:(HTTPMethod)requestMethod
serverUrl:(nonnull NSString *)serverUrl
apiPath:(nonnull NSString *)apiPath
parameters:(nullable id)parameters
progress:(nullable void (^)(NSProgress * _Nullable progress))progress
success:(nullable void(^) (BOOL isSuccess, id _Nullable responseObject))success
failure:(nullable void(^) (NSString * _Nullable errorMessage))failure {
// 請求的地址
NSString *requestPath = [serverUrl stringByAppendingPathComponent:apiPath];
NSURLSessionDataTask * task = nil;
switch (requestMethod) {
case HTTPMethodGET:
{
task = [self.sessionManager GET:requestPath parameters:parameters progress:progress success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) {
if (success) {
success(YES,responseObject);
}
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
if (failure) {
failure([self failHandleWithErrorResponse:error task:task]);
}
}];
}
break;
case HTTPMethodPOST:
{
task = [self.sessionManager POST:requestPath parameters:parameters progress:progress success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) {
if (success) {
success(YES,responseObject);
}
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
if (failure) {
failure([self failHandleWithErrorResponse:error task:task]);
}
}];
}
break;
case HTTPMethodPUT:
{
task = [self.sessionManager PUT:requestPath parameters:parameters success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) {
if (success) {
success(YES,responseObject);
}
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
if (failure) {
failure([self failHandleWithErrorResponse:error task:task]);
}
}];
}
break;
case HTTPMethodPATCH:
{
task = [self.sessionManager PATCH:requestPath parameters:parameters success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) {
if (success) {
success(YES,responseObject);
}
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
if (failure) {
failure([self failHandleWithErrorResponse:error task:task]);
}
}];
}
break;
case HTTPMethodDELETE:
{
task = [self.sessionManager DELETE:requestPath parameters:parameters success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) {
if (success) {
success(YES,responseObject);
} } failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
if (failure) {
failure([self failHandleWithErrorResponse:error task:task]);
}
}];
}
break;
}
return task;
}
#pragma mark POST 上傳圖片
/**
上傳圖片
@param serverUrl 伺服器地址
@param apiPath 方法的連結
@param parameters 引數
@param imageArray 圖片
@param width 圖片寬度
@param progress 進度
@param success 成功
@param failure 失敗
@return return value description
*/
- (nullable NSURLSessionDataTask *)sendPOSTRequestWithserverUrl:(nonnull NSString *)serverUrl
apiPath:(nonnull NSString *)apiPath
parameters:(nullable id)parameters
imageArray:(NSArray *_Nullable)imageArray
targetWidth:(CGFloat )width
progress:(nullable void (^)(NSProgress * _Nullable progress))progress
success:(nullable void(^) (BOOL isSuccess, id _Nullable responseObject))success
failure:(nullable void(^) (NSString *_Nullable error))failure {
// 請求的地址
NSString *requestPath = [serverUrl stringByAppendingPathComponent:apiPath];
NSURLSessionDataTask * task = nil;
task = [self.sessionManager POST:requestPath parameters:parameters constructingBodyWithBlock:^(id<AFMultipartFormData> _Nonnull formData) {
NSUInteger i = 0 ;
// 上傳圖片時，為了使用者體驗或是考慮到效能需要進行壓縮
for (UIImage * image in imageArray) {
// 壓縮圖片，指定寬度（註釋：imageCompressed：withdefineWidth：圖片壓縮的category）
UIImage * resizedImage = [UIImage imageCompressed:image withdefineWidth:width];
NSData * imgData = UIImageJPEGRepresentation(resizedImage, 0.5);
// 拼接Data
[formData appendPartWithFileData:imgData name:[NSString stringWithFormat:@"picflie%ld",(long)i] fileName:@"image.png" mimeType:@" image/jpeg"];
i++;
}
} progress:progress success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) {
if (success)success(YES,responseObject);
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
if (failure) failure([self failHandleWithErrorResponse:error task:task]);
;
}];
return task;
}
#pragma mark 報錯資訊
/**
處理報錯資訊
@param error AFN返回的錯誤資訊
@param task 任務
@return description
*/
- (NSString *)failHandleWithErrorResponse:( NSError * _Nullable )error task:( NSURLSessionDataTask * _Nullable )task {
__block NSString *message = nil;
// 這裡可以直接設定錯誤反饋，也可以利用AFN 的error資訊直接解析展示
NSData *afNetworking_errorMsg = [error.userInfo objectForKey:AFNetworkingOperationFailingURLResponseDataErrorKey];
DebugLog(@"afNetworking_errorMsg == %@",[[NSString alloc]initWithData:afNetworking_errorMsg encoding:NSUTF8StringEncoding]);
if (!afNetworking_errorMsg) {
message = @"網路連線失敗";
}
NSHTTPURLResponse *response = (NSHTTPURLResponse *)task.response;
NSInteger responseStatue = response.statusCode;
if (responseStatue >= 500) { // 網路錯誤
message = @"伺服器維護升級中,請耐心等待";
} else if (responseStatue >= 400) {
// 錯誤資訊
NSDictionary *responseObject = [NSJSONSerialization JSONObjectWithData:afNetworking_errorMsg options:NSJSONReadingAllowFragments error:nil];
message = responseObject[@"error"];
}
DebugLog(@"error == %@",error);
return message;
}
@end注：如若發現錯誤請與我聯絡，我會及時修改本篇文章