iOS平台调用后台接口的正确姿势

2019-10-23  本文已影响0人  妙手空虚

前言

做iOS开发,除非你做的是单机应用,否则一定避免不了接口调用,也就是所谓的API调用。

而对于这方面,每个公司定义接口的格式不尽相同,从而导致我们的代码没法达到通用。

甚至你接私活的话,更会遇到五花八门的接口格式。那么有没有一种通用的方式来处理这些不通用的格式呢?

我尝试从变化的接口格式中找到不变的东西,把这些不变的东西进行可配置,从而形成以不变应万变的接口调用方式。

这些不变的东西,包括如下几种:

而对于错误码又可以分如下几类:

基于以上的分析,形成了一个开源库,希望能在一定程度上方便大家的开发。
开源地址: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",@"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,
    "msg":"成功",
    "name":"CHAT",
    "age":18}

则在初始化配置的时候改成这种:

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失效,跳转登录页面
    };

即respDataKey参数传nil

2. 如果通用头在初始化配置之后可能发生变化,这种情况常见于用户登录之后,通用头里面需要加入形如token的字段

那么调用如下方法:

[[FKApiInvoker sharedInvoker] configCommonHeaders:@{@"token": @"token string"}];

3. 需要做其他更加灵活的json格式的http请求?

可以直接使用我写的另一个库:
JsonModelHttp

事实上FKApiInvoker底层也是依赖的JsonModelHttp.

上一篇下一篇

猜你喜欢

热点阅读