
授權轉載,作者:Coder_CYX(微博)
在《十分鐘搭建主流框架_簡單的網路部分(OC)》一文中,我們靠 AFN 順利完成了網路請求並取回有用資料,但對 AFN 的依賴實在太重。這篇就來動手重構一次。
源碼位址:https://github.com/CYXiang/CYXTenMinDemo
談到網路請求,多半離不開這幾個第三方庫:AFNetworking、MJExtension、MBProgressHUD(或 SVProgressHUD)。初學階段,我們通常把它們全部寫進 Controller:
[[AFHTTPSessionManager manager] GET:CYXRequestURL parameters:params success:^(NSURLSessionDataTask * _Nonnull task, id _Nonnull responseObject) {
NSLog(@"請求成功");
// 利用 MJExtension 框架進行字典轉模型
weakSelf.menus = [CYXMenu objectArrayWithKeyValuesArray:responseObject[@"result"]];
// 刷新數據(若不刷新數據會顯示不出)
[weakSelf.tableView reloadData];
} failure:^(NSURLSessionDataTask * _Nonnull task, NSError * _Nonnull error) {
NSLog(@"請求失敗 原因:%@", error);
}];這樣寫耦合度過高、靈活性也很差。因此 AFN 作者本人也建議不要直接使用,而是繼承 AFHTTPSessionManager 另建一個網路請求類別。
於是有了第二版:
// CYXHTTPSessionManager.h
#import <AFNetworking/AFNetworking.h>
@interface CYXHTTPSessionManager : AFHTTPSessionManager
@end
// CYXHTTPSessionManager.m
#import "CYXHTTPSessionManager.h"
@implementation CYXHTTPSessionManager
+ (instancetype)manager {
CYXHTTPSessionManager *mgr = [super manager];
// 這裡可以做一些統一配置
// mgr.responseSerializer = ;
// mgr.requestSerializer = ;
return mgr;
}
@end呼叫方式:
/** 請求管理者 */
@property (nonatomic, weak) CYXHTTPSessionManager *manager;
// 發送請求
[self.manager GET:CYXRequestURL parameters:params success:^(NSURLSessionDataTask * _Nonnull task, id _Nonnull responseObject) {
// 存儲 maxtime
weakSelf.maxtime = responseObject[@"info"][@"maxtime"];
weakSelf.topics = [CYXTopic objectArrayWithKeyValuesArray:responseObject[@"list"]];
CYXLog(@"%@", responseObject[@"list"]);
[weakSelf.tableView reloadData];
// 結束刷新
[weakSelf.tableView.header endRefreshing];
} failure:^(NSURLSessionDataTask * _Nonnull task, NSError * _Nonnull error) {
[weakSelf.tableView.header endRefreshing];
}];這下耦合度降低了一些,也不必每個 Controller 都引入 AFN。但對 MJExtension 的依賴依然存在。
仔細觀察會發現,大部分 GET 與 POST 請求的前置步驟幾乎一樣:
1. 透過 AFN 拿回 JSON 資料。
2. 從 JSON 中取出要用的字典陣列或字典。
3. 用字典轉模型框架(MJExtension)把字典陣列轉成模型陣列、字典轉成模型。
既然這三步每次都一樣,為什麼不封裝起來?這正是「Don't repeat yourself」這條經典法則的用武之地。
以下以 POST 為例。
CYXHttpRequest.h:
#import <Foundation/Foundation.h>
#import "AFNetworking.h"
@interface CYXHttpRequest : NSObject
/**
* 發送一個 POST 請求
*
* @param url 請求路徑
* @param params 請求參數
* @param success 請求成功後的回調
* @param failure 請求失敗後的回調
*/
+ (void)post:(NSString *)url
params:(NSDictionary *)params
success:(void (^)(id responseObj))success
failure:(void (^)(NSError *error))failure;
@endCYXHttpRequest.m:
#import "CYXHttpRequest.h"
@implementation CYXHttpRequest
+ (void)post:(NSString *)url params:(NSDictionary *)params success:(void (^)(id))success failure:(void (^)(NSError *))failure {
// 1. 獲得請求管理者
AFHTTPSessionManager *mgr = [AFHTTPSessionManager manager];
// 2. 聲明返回的結果是 text/html 類型
mgr.responseSerializer = [AFHTTPResponseSerializer serializer];
// 3. 設置超時時間為 10s
mgr.requestSerializer.timeoutInterval = 10;
// 4. 發送 POST 請求
[mgr POST:url parameters:params progress:^(NSProgress * _Nonnull uploadProgress) {
} success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) {
if (success) {
success(responseObject);
}
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
if (failure) {
failure(error);
}
}];
}
@end現在資料已經能取回來了,接著處理第二步:從 JSON 中取出需要的字典陣列。舉個簡單例子,假設回傳結構如下:
{
"error_code": 0,
"reason": "Success",
"result": [
{
"id": 370622,
"title": "西紅柿蒜薹炒雞蛋",
"tags": "廚房用具;廚具;加工工藝;基本工藝;菜品;菜肴;家常菜;炒;炒鍋;熱菜;防輻射;開胃;蔬菜類;果實類;蒜薹;西紅柿;禽蛋類;蛋;雞蛋;",
"intro": "我這的蒜薹雞蛋都愛加西紅柿、辣椒一起炒的,這是習慣所致,愛吃西紅柿,愛吃辣椒,還愛把菜搭配的顏色亮麗,當然味道也不差。",
"ingredients": "西紅柿:1個;蒜薹:200g;雞蛋:2個;",
"burden": "油:適量;鹽:適量;青辣椒:1個;紅辣椒:1個;",
"albums": "https://imgs.haoservice.com/CaiPu/pic/recipe/l/be/a7/370622_86e12b.jpg"
},
{
"id": 433079,
"title": "西紅柿酸奶",
"tags": "促進食欲;減肥;懶人食譜;消暑食譜;美容養顏;",
"intro": "新疆人愛吃西紅柿那是有目共睹的,菜裡面加西紅柿的數不勝數,就連舌尖2在吐魯番拍的葡萄干抓飯裡面都加西紅柿。",
"ingredients": "酸奶:400g;西紅柿:200g;",
"burden": "白糖:20g;",
"albums": "https://imgs.haoservice.com/CaiPu/pic/recipe/l/b7/9b/433079_377373.jpg"
}
]
}我們真正要用的只有 result 這個陣列(並對應到 CYXMenu 模型)。在團隊開發中,後端介面通常有較好的規範,每個欄位的命名與結構是統一的,這讓我們可以再往上封裝一層 CYXBaseRequest。
CYXBaseRequest 的實作思路:
1)呼叫 CYXHttpRequest 發請求,從回傳資料中取出 result。
2)用 MJExtension 把 result 字典陣列轉成 CYXMenu 模型陣列並回傳。
3)外部只需要傳入一個 resultClass 即可。
CYXBaseRequest.h:
#import <Foundation/Foundation.h>
@interface CYXBaseRequest : NSObject
/**
* 返回 result 數據模型
*/
+ (void)postResultWithUrl:(NSString *)url param:(id)param
resultClass:(Class)resultClass
success:(void (^)(id result))success
warn:(void (^)(NSString *warnMsg))warn
failure:(void (^)(NSError *error))failure
tokenInvalid:(void (^)())tokenInvalid;
/**
* 返回 result 數據模型(帶 HUD)
*/
+ (void)postResultHUDWithUrl:(NSString *)url param:(id)param
resultClass:(Class)resultClass
success:(void (^)(id result))success
warn:(void (^)(NSString *warnMsg))warn
failure:(void (^)(NSError *error))failure
tokenInvalid:(void (^)())tokenInvalid;
/**
* 組合請求參數
*/
+ (NSMutableDictionary *)requestParams:(NSDictionary *)dict;
@endCYXBaseRequest.m:
#import "CYXBaseRequest.h"
#import "CYXHttpRequest.h"
#import "ExceptionMsgTips.h"
#import "MJExtension.h"
@implementation CYXBaseRequest
/** 返回 result 數據模型(HUD) */
+ (void)postResultHUDWithUrl:(NSString *)url param:(id)param
resultClass:(Class)resultClass
success:(void (^)(id result))success
warn:(void (^)(NSString *warnMsg))warn
failure:(void (^)(NSError *error))failure
tokenInvalid:(void (^)())tokenInvalid {
[self postBaseHUDWithUrl:url param:param resultClass:resultClass success:^(id responseObj) {
if (!resultClass) {
success(nil);
return;
}
success([resultClass mj_objectArrayWithKeyValuesArray:responseObj[@"result"]]);
} warn:warn failure:failure tokenInvalid:tokenInvalid];
}
/** 返回 result 數據模型 */
+ (void)postResultWithUrl:(NSString *)url param:(id)param
resultClass:(Class)resultClass
success:(void (^)(id result))success
warn:(void (^)(NSString *warnMsg))warn
failure:(void (^)(NSError *error))failure
tokenInvalid:(void (^)())tokenInvalid {
[self postBaseWithUrl:url param:param resultClass:resultClass success:^(id responseObj) {
if (!resultClass) {
success(nil);
return;
}
success([resultClass mj_objectArrayWithKeyValuesArray:responseObj[@"result"]]);
} warn:warn failure:failure tokenInvalid:tokenInvalid];
}
/** 數據模型基類方法 */
+ (void)postBaseWithUrl:(NSString *)url param:(id)param
resultClass:(Class)resultClass
success:(void (^)(id result))success
warn:(void (^)(NSString *warnMsg))warn
failure:(void (^)(NSError *error))failure
tokenInvalid:(void (^)())tokenInvalid {
CYXLog(@"\n請求鏈接地址---> %@", url);
// 狀態欄菊花
[UIApplication sharedApplication].networkActivityIndicatorVisible = YES;
[CYXHttpRequest post:url params:param success:^(id responseObj) {
if (success) {
NSDictionary *dictData = [NSJSONSerialization JSONObjectWithData:responseObj options:kNilOptions error:nil];
CYXLog(@"請求成功,返回數據 : %@", dictData);
success(dictData);
}
// 狀態欄菊花
[UIApplication sharedApplication].networkActivityIndicatorVisible = NO;
} failure:^(NSError *error) {
if (failure) {
failure(error);
CYXLog(@"請求失敗:%@", error);
}
// 狀態欄菊花
[UIApplication sharedApplication].networkActivityIndicatorVisible = NO;
}];
}
/** 數據模型基類(帶 HUD) */
+ (void)postBaseHUDWithUrl:(NSString *)url param:(id)param
resultClass:(Class)resultClass
success:(void (^)(id result))success
warn:(void (^)(NSString *warnMsg))warn
failure:(void (^)(NSError *error))failure
tokenInvalid:(void (^)())tokenInvalid {
[SVProgressHUD showWithStatus:@""];
[self postBaseWithUrl:url param:param resultClass:resultClass success:^(id responseObj) {
[SVProgressHUD dismiss]; // 隱藏 loading
success(responseObj);
} warn:^(NSString *warnMsg) {
[SVProgressHUD dismiss];
warn(warnMsg);
} failure:^(NSError *fail) {
[SVProgressHUD dismiss];
failure(fail);
} tokenInvalid:^{
[SVProgressHUD dismiss];
tokenInvalid();
}];
}
@end至此,輕量級封裝就介紹完了,更多進階功能留給讀者自行發揮。
1. 把上述兩個類別的 .h/.m 拖進專案,建議新建一個 request 資料夾存放。
2. 在需要發請求的 Controller 中 #import "CYXBaseRequest.h"。
3. 呼叫方式如下(使用 CYXBaseRequest):
#pragma mark - 請求數據方法
- (void)loadData {
self.pn = 1;
// 請求參數(根據接口文檔編寫)
NSMutableDictionary *params = [NSMutableDictionary dictionary];
params[@"menu"] = @"西紅柿";
params[@"pn"] = @(self.pn);
params[@"rn"] = @"10";
params[@"key"] = @"fcfdb87c50c1485e9e7fa9f839c4b1a8";
[CYXBaseRequest postResultWithUrl:CYXRequestURL param:params resultClass:[CYXMenu class] success:^(id result) {
CYXLog(@"請求成功,返回數據 : %@", result);
self.menus = result;
self.pn++;
// 刷新數據
[self.tableView reloadData];
[self.tableView.mj_header endRefreshing];
} warn:^(NSString *warnMsg) {
} failure:^(NSError *error) {
CYXLog(@"請求失敗 原因:%@", error);
[self.tableView.mj_header endRefreshing];
} tokenInvalid:^{
// 有登錄操作的業務,這裡返回登錄狀態
}];
}對照一下不使用封裝時的寫法:
#pragma mark - 請求數據方法
- (void)loadData {
self.pn = 1;
NSMutableDictionary *params = [NSMutableDictionary dictionary];
params[@"menu"] = @"西紅柿";
params[@"pn"] = @(self.pn);
params[@"rn"] = @"10";
params[@"key"] = @"fcfdb87c50c1485e9e7fa9f839c4b1a8";
[self.manager.tasks makeObjectsPerformSelector:@selector(cancel)];
[self.manager.responseSerializer setAcceptableContentTypes:[NSSet setWithObject:@"text/html"]];
[self.manager POST:CYXRequestURL parameters:params progress:^(NSProgress * _Nonnull downloadProgress) {
} success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) {
CYXLog(@"請求成功,返回數據 : %@", responseObject);
// 利用 MJExtension 框架進行字典轉模型
weakSelf.menus = [CYXMenu mj_objectArrayWithKeyValuesArray:responseObject[@"result"]];
weakSelf.pn++;
[weakSelf.tableView reloadData];
[weakSelf.tableView.mj_header endRefreshing];
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
CYXLog(@"請求失敗 原因:%@", error);
[weakSelf.tableView.mj_header endRefreshing];
}];
}從行數上看差異似乎不大(只是少幾行),但實質差別在於:前者降低了对 AFN 等框架的依賴,也免去了每次手動轉模型的麻煩——現在只要把 resultClass 傳進去,回傳的就是已轉好的模型。同時封裝內部還統一印出了請求網址與回傳資料,方便除錯;介面設計也延續 AFN 的風格,上手毫無成本。
TIPS:建議為每個業務模組各建立一個 Request 類別(繼承 CYXBaseRequest),統一管理該模組的網路請求,後續維護會輕扶手。
本文的封裝只針對網路請求做了初步的簡化,適用於中小型專案,並不涉及快取、簽名校驗等高階功能。若有這類需求,建議研究猿題庫團隊的 YTKNetwork。
附:源碼 GitHub 位址。