前言
做ios开发，除非你做的是单机应用，否则一定避免不了接口调用，也就是所谓的api调用。
而对于这方面，每个公司定义接口的格式不尽相同，从而导致我们的代码没法达到通用。
甚至你接私活的话，更会遇到五花八门的接口格式。那么有没有一种通用的方式来处理这些不通用的格式呢？
我尝试从变化的接口格式中找到不变的东西，把这些不变的东西进行可配置，从而形成以不变应万变的接口调用方式。
这些不变的东西，包括如下几种：
- 错误码
- 错误消息
- 业务数据
而对于错误码又可以分如下几类：
- 成功
- 失败
- token失效
基于以上的分析，形成了一个开源库，希望能在一定程度上方便大家的开发。
开源地址：https://github.com/wochen85/fkapiinvoker
下面进行使用的详细说明：
fkapiinvoker
ios 平台网络接口调用封装
安装
|
1
|
pod 'fkapiinvoker' |
使用
1. 初始化配置，可以放在appdelegate的- (bool)application:(uiapplication *)application didfinishlaunchingwithoptions:(nullable nsdictionary *)launchoptions方法中，或者其他你认为合适的地方，假设后台返回的json格式如下：
|
1
2
3
4
|
{"code":0,"msg":"成功","data":{"name":"chat", "age":18}} |
其中 code是错误码（0代表处理成功，127代表token过期），msg是提示消息，data 是具体的业务数据
那么做如下配置：
|
1
2
3
4
5
|
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
|
1
2
3
4
5
|
[fkapiinvoker fire:@"post" path:@"/personinfo/login" param:nil headers:headers body:body responsemodelclass:[loginresp class] success:^(loginresp* model) { //成功处理 } failure:^(nserror *error) { //失败处理 }]; |
3. 使用mock数据
|
1
2
3
4
5
|
[fkapiinvoker firewithmockdata:mockdata method:@"post" path:@"/personinfo/login" param:nil headers:headers body:body responsemodelclass:[loginresp class] success:^(loginresp* model) { //成功处理 } failure:^(nserror *error) { //失败处理 }]; |
其他情况
1. 后台返回的业务数据和错误码、错误消息平级：
|
1
2
3
4
|
{"code":0, "msg":"成功", "name":"chat", "age":18} |
则在初始化配置的时候改成这种：
|
1
2
3
4
5
|
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的字段
那么调用如下方法：
|
1
|
[[fkapiinvoker sharedinvoker] configcommonheaders:@{@"token": @"token string"}]; |
3. 需要做其他更加灵活的json格式的http请求？
可以直接使用我写的另一个库：jsonmodelhttp
事实上fkapiinvoker底层也是依赖的jsonmodelhttp.
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持服务器之家。
原文链接：https://juejin.im/post/5db01830518825645f5ad038
