詳解iOS平臺呼叫後臺介面的正確姿勢
前言
做iOS開發,除非你做的是單機應用,否則一定避免不了介面呼叫,也就是所謂的API呼叫。
而對於這方面,每個公司定義介面的格式不盡相同,從而導致我們的程式碼沒法達到通用。
甚至你接私活的話,更會遇到五花八門的介面格式。那麼有沒有一種通用的方式來處理這些不通用的格式呢?
我嘗試從變化的介面格式中找到不變的東西,把這些不變的東西進行可配置,從而形成以不變應萬變的介面呼叫方式。
這些不變的東西,包括如下幾種:
- 錯誤碼
- 錯誤訊息
- 業務資料
而對於錯誤碼又可以分如下幾類:
- 成功
- 失敗
- token失效
基於以上的分析,形成了一個開源庫,希望能在一定程度上方便大家的開發。
開源地址:https://github.com/wochen85/FKApiInvoker
下面進行使用的詳細說明:
FKApiInvoker
iOS 平臺網路介面呼叫封裝
安裝
pod 'FKApiInvoker'
使用
1. 初始化配置,可以放在Appdelegate的- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(nullable NSDictionary *)launchOptions方法中,或者其他你認為合適的地方,假設後臺返回的json格式如下:
{"code":0,"msg":"成功","data":{"name":"CHAT","age":18}}
其中 code是錯誤碼(0代表處理成功,127代表token過期),msg是提示訊息,data 是具體的業務資料
那麼做如下配置:
FKApiInvokerConfig* config = [[FKApiInvokerConfig alloc] initWithBaseUrls:@[@"http://www.httpbin.org",@"http://www.httpbin.org",@"http://www.httpbin.org"] commonHeaders:@{@"test": @"test"} respCodeKey:@"code" respMsgKey:@"msg" respDataKey:@"data" successCode:0 tokenExpiredCode:127]; [[FKApiInvoker sharedInvoker] configInvoker:config]; [FKApiInvoker sharedInvoker].tokenExpiredBlk = ^{ //token失效,跳轉登入頁面 };
2. 呼叫後臺API
[FKApiInvoker fire:@"post" path:@"/personinfo/login" param:nil headers:headers body:body responseModelClass:[LoginResp class] success:^(LoginResp* model) { //成功處理 } failure:^(NSError *error) { //失敗處理 }];
3. 使用mock資料
[FKApiInvoker fireWithMockData:mockData method:@"post" path:@"/personinfo/login" param:nil headers:headers body:body responseModelClass:[LoginResp class] success:^(LoginResp* model) { //成功處理 } failure:^(NSError *error) { //失敗處理 }];
其他情況
1. 後臺返回的業務資料和錯誤碼、錯誤訊息平級:
{"code":0,"name":"CHAT","age":18}
則在初始化配置的時候改成這種:
FKApiInvokerConfig* config = [[FKApiInvokerConfig alloc] initWithBaseUrls:@[@"http://www.httpbin.org",@"http://www.httpbin.org"] commonHeaders:@{@"test": @"test"} respCodeKey:@"code" respMsgKey:@"msg" respDataKey:nil successCode:0 tokenExpiredCode:127]; [[FKApiInvoker sharedInvoker] configInvoker:config]; [FKApiInvoker sharedInvoker].tokenExpiredBlk = ^{ //token失效,跳轉登入頁面 };
即respDataKey引數傳nil
2. 如果通用頭在初始化配置之後可能發生變化,這種情況常見於使用者登入之後,通用頭裡面需要加入形如token的欄位
那麼呼叫如下方法:
[[FKApiInvoker sharedInvoker] configCommonHeaders:@{@"token": @"token string"}];
3. 需要做其他更加靈活的json格式的http請求?
可以直接使用我寫的另一個庫:JsonModelHttp
事實上FKApiInvoker底層也是依賴的JsonModelHttp.
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支援我們。