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

所属分类: 软件编程 / IOS 阅读数: 571
收藏 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基础动画教程分享

这篇文章主要为大家详细介绍了iOS几种基础动画教程,包括位置动画、透明度动画、大小动画等,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
收藏 0 赞 0 分享

iOS如何获取屏幕宽高、设备型号、系统版本信息

这篇文章主要介绍了iOS如何获取屏幕宽高、设备型号、系统版本信息的相关代码,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
收藏 0 赞 0 分享

iOS中给自定义tabBar的按钮添加点击放大缩小的动画效果

这篇文章主要介绍了iOS中给自定义tabBar的按钮添加点击放大缩小的动画效果的相关资料,非常不错,具有参考解决价值,需要的朋友可以参考下
收藏 0 赞 0 分享

详解iOS使用Keychain中的kSecClassGenericPassword存储数据

iOS设备中的Keychain是一个安全的存储容器,本篇文章主要介绍了iOS使用Keychain中的kSecClassGenericPassword存储数据,有兴趣的可以了解一下。
收藏 0 赞 0 分享

详解IOS四种保存数据的方式

本篇文章主要介绍了OS四种保存数据的方式,现在分享给大家,也给大家做个参考。感兴趣的小伙伴们可以参考一下。
收藏 0 赞 0 分享

iOS图片界面翻页切换效果

这篇文章主要为大家详细介绍了iOS图片界面翻页切换效果,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
收藏 0 赞 0 分享

IOS中对Url进行编码和解码示例

本篇文章主要介绍了IOS中对Url进行编码和解码示例,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
收藏 0 赞 0 分享

iOS实现圆角箭头矩形的提示框

不知道大家发现了没,在现在的很多App中常使用圆角箭头矩形, 如微博分组提示框, 地图坐标显示点等。iPad 中有 UIPopoverController 类供开发使用, iPhone中就需要开发人员定制了。那么下面这篇文中就来聊聊定制圆角箭头矩形提示框,有需要的朋友们可以参考借
收藏 0 赞 0 分享

iOS将视频录像切成一张张缩略图

这篇文章主要为大家详细介绍了iOS将视频录像切成一张张缩略图的相关代码,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
收藏 0 赞 0 分享

iOS获取验证码倒计时效果

这篇文章主要为大家详细介绍了iOS获取验证码倒计时效果,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
收藏 0 赞 0 分享
查看更多