每個專案都要發請求,每次都從 manager 開始寫一遍太囉嗦。把 AFNetworking 包成一個類方法,GET 和 POST 共用同一個入口,呼叫端只要傳網址、參數與回呼 block 就好。
新增一個名為 HTTPMethod(名字自取)的 Objective-C 類別,用來放封裝後的方法。
從 GitHub 下載最新版後匯入,或在 Podfile 中加入 pod 'AFNetworking'。
#import "AFNetworking.h"
// 參數說明:
// urlString 請求的網址
// bodyDic POST 時攜帶的參數
// dataBlock 請求成功後回傳資料的回呼
+ (void)getDataByString:(NSString *)urlString
BodyDic:(NSDictionary *)bodyDic
WithDataBlock:(void (^)(id data))dataBlock;
+ (void)getDataByString:(NSString *)urlString
BodyDic:(NSDictionary *)bodyDic
WithDataBlock:(void (^)(id))dataBlock {
// (1) 網址轉碼,處理中文與特殊字元
urlString = [urlString stringByAddingPercentEncodingWithAllowedCharacters:
[NSCharacterSet characterSetWithCharactersInString:urlString]];
// (2) 建立 session manager
AFHTTPSessionManager *manager = [AFHTTPSessionManager manager];
// (3) 放宽可接受的 content type。
// AFNetworking 3.x 預設只接受 application/json 與 text/json,
// 遇到回傳 text/html 或 text/plain 的後端會直接判定失敗,這行是必要的
manager.responseSerializer.acceptableContentTypes =
[NSSet setWithObjects:@"text/plain",
@"text/json",
@"application/json",
@"text/javascript",
@"text/html",
@"application/javascript",
@"text/js", nil];
// (4) 依是否有 body 決定用 GET 還是 POST
if (!bodyDic) {
[manager GET:urlString
parameters:nil
success:^(NSURLSessionDataTask * _Nonnull task, id _Nonnull responseObject) {
dataBlock(responseObject);
}
failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
NSLog(@"請求失敗:%@", error);
}];
} else {
[manager POST:urlString
parameters:bodyDic
success:^(NSURLSessionDataTask * _Nonnull task, id _Nonnull responseObject) {
dataBlock(responseObject);
}
failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
NSLog(@"請求失敗:%@", error);
}];
}
}
acceptableContentTypes 那行是必要之惡。AFNetworking 2.x 預設接受 text/html,3.x 之後收緊為只有 JSON 類型。許多老舊後端仍回傳 text/html 包 JSON,就會出現「responseObject 為 nil」的狀況。這行設定能解決,但更根本的做法是請後端回傳正確的 Content-Type。
failure 應該把錯誤往外傳。目前只 NSLog 一行,呼叫端無從得知失敗原因。建議把回呼改成 ^(id data, NSError *error) 兩個參數,或至少回傳統一的錯誤結構。
成功回呼也該區分業務錯誤。HTTP 狀態碼 200 但 body 裡 {"code": 500} 是很常見的後端慣例。封裝層最好統一解析並把業務錯誤碼一起帶出,避免每個呼叫點都重寫一遍判斷。
manager 應該重複利用。每次請求都 new 一個 AFHTTPSessionManager,等於放棄了連線池與 cookie 共用。實務上會做成單例或至少一個全域實例。
用 class method 就無法設定共通的 header。若要統一帶 token、裝置資訊,建議改成實例方法並在初始化時設定 requestSerializer 的 header,或改用 AFHTTPSessionManager 的 category。