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

所属分类: 软件编程 / IOS 阅读数: 608
收藏 0 赞 0 分享

前言

做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",@"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.

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

更多精彩内容其他人还在看

IOS 使用Block二次封装AFNetworking 3.0详解

这篇文章主要介绍了IOS 使用Block二次封装AFNetworking 3.0详解的相关资料,需要的朋友可以参考下
收藏 0 赞 0 分享

IOS 开发之对象为空的判断(nil、null)详解

这篇文章主要介绍了IOS 开发之对象为空的判断(nil、null)详解的相关资料,需要的朋友可以参考下
收藏 0 赞 0 分享

iOS创建对象的不同姿势详解

这篇文章主要介绍了iOS创建对象的不同姿势,文中介绍的很详细,对大家具有一定的参考价值,有需要的朋友们下面来一起学习学习吧。
收藏 0 赞 0 分享

探究iOS多线程究竟不安全在哪里?

iOS多线程安全的概念在很多地方都会遇到,为什么不安全,不安全又该怎么去定义,其实是个值得深究的话题。那么通过下面这篇文章小编和大家一起来探究了iOS多线程究竟不安全在哪里?需要的朋友可以参考学习。
收藏 0 赞 0 分享

IOS购物车界面实现效果示例

本篇文章主要介绍了IOS购物车界面实现效果示例,有需要了解的朋友可参考。希望此文章对各位有所帮助。
收藏 0 赞 0 分享

iOS Touch ID 身份认证

本文主要介绍了iOS Touch ID 身份认证的相关知识。具有很好的参考价值,下面跟着小编一起来看下吧
收藏 0 赞 0 分享

iOS 使用 socket 实现即时通信示例(非第三方库)

这篇文章主要介绍了iOS 使用 socket 即时通信示例(非第三方库)的资料,这里整理了详细的代码,有需要的小伙伴可以参考下。
收藏 0 赞 0 分享

ios常见加密解密方法(RSA、DES 、AES、MD5)

本篇文章主要介绍了ios常见加密解密方法(RSA、DES 、AES、MD5),小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
收藏 0 赞 0 分享

iOS利用AFNetworking实现文件上传的示例代码

本篇文章主要介绍了iOS利用AFNetworking实现文件上传的示例代码,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
收藏 0 赞 0 分享

浅谈IOS中AFNetworking网络请求的get和post步骤

本篇文章主要介绍了浅谈IOS中AFNetworking网络请求的get和post步骤的相关资料,具有一定的参考价值,感兴趣的小伙伴们可以参考一下。
收藏 0 赞 0 分享
查看更多