詳解iOS平臺(tái)調(diào)用后臺(tái)接口的正確姿勢(shì)
前言
做iOS開發(fā),除非你做的是單機(jī)應(yīng)用,否則一定避免不了接口調(diào)用,也就是所謂的API調(diào)用。
而對(duì)于這方面,每個(gè)公司定義接口的格式不盡相同,從而導(dǎo)致我們的代碼沒法達(dá)到通用。
甚至你接私活的話,更會(huì)遇到五花八門的接口格式。那么有沒有一種通用的方式來處理這些不通用的格式呢?
我嘗試從變化的接口格式中找到不變的東西,把這些不變的東西進(jìn)行可配置,從而形成以不變應(yīng)萬(wàn)變的接口調(diào)用方式。
這些不變的東西,包括如下幾種:
- 錯(cuò)誤碼
- 錯(cuò)誤消息
- 業(yè)務(wù)數(shù)據(jù)
而對(duì)于錯(cuò)誤碼又可以分如下幾類:
- 成功
- 失敗
- token失效
基于以上的分析,形成了一個(gè)開源庫(kù),希望能在一定程度上方便大家的開發(fā)。
開源地址:https://github.com/wochen85/FKApiInvoker
下面進(jìn)行使用的詳細(xì)說明:
FKApiInvoker
iOS 平臺(tái)網(wǎng)絡(luò)接口調(diào)用封裝
安裝
pod 'FKApiInvoker'
使用
1. 初始化配置,可以放在Appdelegate的- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(nullable NSDictionary *)launchOptions方法中,或者其他你認(rèn)為合適的地方,假設(shè)后臺(tái)返回的json格式如下:
{"code":0, "msg":"成功", "data":{"name":"CHAT", "age":18}}
其中 code是錯(cuò)誤碼(0代表處理成功,127代表token過期),msg是提示消息,data 是具體的業(yè)務(wù)數(shù)據(jù)
那么做如下配置:
FKApiInvokerConfig* config = [[FKApiInvokerConfig alloc] initWithBaseUrls:@[@"http://www.httpbin.org",@"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失效,跳轉(zhuǎn)登錄頁(yè)面 };
2. 調(diào)用后臺(tái)API
[FKApiInvoker fire:@"post" path:@"/personinfo/login" param:nil headers:headers body:body responseModelClass:[LoginResp class] success:^(LoginResp* model) { //成功處理 } failure:^(NSError *error) { //失敗處理 }];
3. 使用mock數(shù)據(jù)
[FKApiInvoker fireWithMockData:mockData method:@"post" path:@"/personinfo/login" param:nil headers:headers body:body responseModelClass:[LoginResp class] success:^(LoginResp* model) { //成功處理 } failure:^(NSError *error) { //失敗處理 }];
其他情況
1. 后臺(tái)返回的業(yè)務(wù)數(shù)據(jù)和錯(cuò)誤碼、錯(cuò)誤消息平級(jí):
{"code":0, "msg":"成功", "name":"CHAT", "age":18}
則在初始化配置的時(shí)候改成這種:
FKApiInvokerConfig* config = [[FKApiInvokerConfig alloc] initWithBaseUrls:@[@"http://www.httpbin.org",@"http://www.httpbin.org",@"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失效,跳轉(zhuǎn)登錄頁(yè)面 };
即respDataKey參數(shù)傳nil
2. 如果通用頭在初始化配置之后可能發(fā)生變化,這種情況常見于用戶登錄之后,通用頭里面需要加入形如token的字段
那么調(diào)用如下方法:
[[FKApiInvoker sharedInvoker] configCommonHeaders:@{@"token": @"token string"}];
3. 需要做其他更加靈活的json格式的http請(qǐng)求?
可以直接使用我寫的另一個(gè)庫(kù):JsonModelHttp
事實(shí)上FKApiInvoker底層也是依賴的JsonModelHttp.
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
iOS中長(zhǎng)條藍(lán)色按鈕(button)實(shí)現(xiàn)代碼
本文通過實(shí)例代碼給大家介紹了iOS中長(zhǎng)條藍(lán)色按鈕(button)實(shí)現(xiàn)方法,代碼簡(jiǎn)單易懂,非常不錯(cuò),具有參考借鑒價(jià)值,需要的朋友參考下吧2017-08-08iOS10 App適配權(quán)限 Push Notifications 字體Frame 遇到的問題
這篇文章主要介紹了iOS10 App適配權(quán)限 Push Notifications 字體Frame 遇到的問題,非常不錯(cuò),具有參考借鑒價(jià)值,需要的朋友可以參考下2016-09-09iOS自帶文本轉(zhuǎn)語(yǔ)音技術(shù)(TTS)的實(shí)現(xiàn)即語(yǔ)音播報(bào)的實(shí)踐
這篇文章主要介紹了iOS自帶文本轉(zhuǎn)語(yǔ)音技術(shù)(TTS)的實(shí)現(xiàn)即語(yǔ)音播報(bào)的實(shí)踐,本文介紹的非常詳細(xì),具有參考借鑒價(jià)值,需要的朋友可以參考下2016-09-09IOS 聊天界面(自適應(yīng)文字)的實(shí)現(xiàn)
本文主要介紹一個(gè)實(shí)現(xiàn)聊天界面的思路過程,具有很好的參考價(jià)值。下面跟著小編一起來看下吧2017-03-03iOS關(guān)鍵字static extern const使用示例詳解
這篇文章主要為大家介紹了iOS關(guān)鍵字static extern const使用示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-11-11iOS自定義UIBarButtonItem的target和action示例代碼
這篇文章主要給大家介紹了關(guān)于iOS自定義UIBarButtonItem的target和action的相關(guān)資料,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面來一起學(xué)習(xí)學(xué)習(xí)吧2019-02-02iOS中利用CoreAnimation實(shí)現(xiàn)一個(gè)時(shí)間的進(jìn)度條效果
在iOS中實(shí)現(xiàn)進(jìn)度條通常都是通過不停的設(shè)置progress來完成的,這樣的進(jìn)度條適用于網(wǎng)絡(luò)加載(上傳下載文件、圖片等)。下面通過本文給大家介紹iOS中利用CoreAnimation實(shí)現(xiàn)一個(gè)時(shí)間的進(jìn)度條,需要的的朋友參考下吧2017-09-09