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

前言

作iOS开发,除非你作的是单机应用,不然必定避免不了接口调用,也就是所谓的API调用。git

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

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

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

这些不变的东西,包括以下几种:网络

  • 错误码
  • 错误消息
  • 业务数据

而对于错误码又能够分以下几类:app

  • 成功
  • 失败
  • token失效

基于以上的分析,造成了一个开源库,但愿能在必定程度上方便你们的开发。 开源地址:github.com/wochen85/FK…post

下面进行使用的详细说明:spa

FKApiInvoker

iOS 平台网络接口调用封装code

安装

pod 'FKApiInvoker'
复制代码

使用

1. 初始化配置,能够放在Appdelegate的- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(nullable NSDictionary *)launchOptions方法中,或者其余你认为合适的地方,

假设后台返回的json格式以下:token

{"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.

相关文章
相关标签/搜索