关于后台接口返回错误信息的格式规范思考

大部分的iOS项目用的网络请求工具都是基于AFNetworking封装的。很多时候,会遇到关于网络请求失败,后台接口返回的错误信息格式的规范问题。

比如下面这张图,数据请求成功了,但是返回的数据其实是一个错误信息。像这种是属于后台接口设计的不规范。

为什么会有这个思考呢。因为最近在项目中发现,后台给的那些接口,有的错误信息时直接在error里返回的,有的是在responseObj里返回的。这样不统一,移动端很难做数据处理。你总不能在写两个判断吧,这并不是一个好的解决方式。

Snip20180711_24.png

那么什么是规范化的接口设计呢?

对于后台来说,数据请求成功后的JSON数据和失败的JSON数据是分为两个变量返回的。在成功的JSON数据里(responseObj),应该只返回我们需要请求的数据。错误信息只放在失败的JSON数据里返回(error)。但很多接口的定义不规范,比如喜欢在这串成功的JSON数据里加一个键值对,参数名为什么errorMessage或者sucessCode之类的,将一个错误信息码放在成功信息里返回,这是不规范的。不过,虽然不规范,但如果确保项目里所有的接口都按这种标准来返回,也是可行的,因为只要可以保证移动端能够通过返回数据中的一个参数能确定数据请求的成功或失败即可。

但如果后台不能保证所有的接口都是这么做的时候,移动端就很头疼了,判断失去了唯一性。毕竟并不是每家公司的开发环境和配置都那么的成熟。这种情况可以提供修改AFNetworking的源码来解决。

我拿GET请求举一个列子。
以下是GET请求的源码

  __block NSURLSessionDataTask *dataTask = nil;
    dataTask = [self dataTaskWithRequest:request
                      uploadProgress:uploadProgress
                    downloadProgress:downloadProgress
                   completionHandler:^(NSURLResponse * __unused  response, id responseObject, NSError *error) {
       if (error) {
        if (failure) {
            failure(dataTask, error);
        }
    } else {
        if (success) {
            success(dataTask, responseObject);
        }
      }
   }];

  return dataTask;

我上面提到的成功返回数据(responseObj)和 错误返回数据(error)。其实都是通过AFN对外接口里的block回调中包含的参数。那这里的error并不会包含太多信息。举个错误码的例子,error打印如下:

     Request Failed with Error: Error Domain=AFNetworkingErrorDomain Code=-1016 "Expected content type {( "text/json", "application/json",            "text/JavaScript" )}, got text/html" UserInfo=0x6d7a730 {NSLocalizedRecoverySuggestion=index test, AFNetworkingOperationFailingURLResponseErrorKey=, NSErrorFailingURLKey=http://54.245.14.201/, NSLocalizedDescription=Expected content type {( "text/json", "application/json", "text/javascript" )}, got text/html, AFNetworkingOperationFailingURLRequestErrorKey=http://54.245.14.201/>}, { AFNetworkingOperationFailingURLRequestErrorKey = "http://54.245.14.201/>"; AFNetworkingOperationFailingURLResponseErrorKey = ""; NSErrorFailingURLKey = "http://54.245.14.201/"; NSLocalizedDescription = "Expected content type {(\n \"text/json\",\n \"application/json\",\n
 \"text/javascript\"\n)}, got text/html"; NSLocalizedRecoverySuggestion = "index test"; }

这里面的信息并不好做唯一的判断。
这是因为AFN的底层过滤掉了一些信息。
我们看到如果请求失败的话,实际上后台返回的参数有三个,而AFN只把dataTask,error回调给了上级,最后在AFN对外接口中暴露的错误返回信息只有error。我们可以将responseObject加到回调中,只要增加一个id类型指针就可以。然后在上级中也加入一个,最后在对外的接口中加入,这样我们就能拿到完成的后台返回的错误信息了。

很多人可能纳闷,直接判断是否走到error里面不就好了,走了error就代表返回错误,我就直接写请求错误的逻辑代码,为什么还要关心具体的错误原因是什么。因为以上只是分析,移动端确实不需要知道具体的错误信息是什么,但我们应该了解背后的设计规范。

事实上,我们可以在AFN的源码里做一些自定义的处理,在返回错误的时候让其返回我们想要知道的错误信息:

 __block NSURLSessionDataTask *dataTask = nil;
    dataTask = [self dataTaskWithRequest:request
                          uploadProgress:uploadProgress
                        downloadProgress:downloadProgress
                       completionHandler:^(NSURLResponse * __unused response, id responseObject, NSError *error) {
                           if (error) {
                               if (failure) {
                                   
                                   if ([URLString rangeOfString:@"/task/v2/"].location == NSNotFound ) {
                                       
                                       failure(dataTask, error);
                                       
                                   }else{//含有v2的URL请求
                                       
                                       @try {
                                           NSInteger errocode   = error.code;
                                           NSErrorDomain domain = error.domain;
                                           NSNumber *codeInt = [responseObject objectForKey:@"code"];
                                           NSString *messageStr =[responseObject objectForKey:@"message"];
                                           NSString *codeStr =codeInt.stringValue;
                                           if (messageStr.length >0  && codeStr.length >0){
                                               
                                               NSDictionary *userInfoCustom = @{@"RSQErrorCode":codeStr,@"RSQErrorMessage":messageStr};
                                               //自定义错误信息字典
                                               NSError *errorNow = [[NSError alloc] initWithDomain:domain code:errocode userInfo:userInfoCustom];
                                               failure(dataTask, errorNow);
                                           }else{
                                               failure(dataTask, error);
                                           }
                                       }
                                       @catch (NSException *exception) {
                                           // 捕获到的异常exception
                                           failure(dataTask, error);
                                       }
                                   }
                               }
                           } else {
                               if (success) {
                                   success(dataTask, responseObject);
                               }
                           }
                       }];
    
    return dataTask;
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 135,739评论 19 139
  • 国家电网公司企业标准(Q/GDW)- 面向对象的用电信息数据交换协议 - 报批稿:20170802 前言: 排版 ...
    庭说阅读 13,885评论 6 13
  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 14,254评论 4 61
  • 银行家的儿子问爸爸:“爸爸,银行里的钱都是客户和储户的。那你是怎样赚来房子、奔驰车和游艇的呢?”银行家:“儿子,冰...
    小树幽默阅读 3,449评论 0 0
  • 我爱你,简单地三个字! 当你等待了很久的“她”终于出现时,一句:“坐在你门口的路边感觉很好”,就连奥斯卡影后梅丽尔...
    伊滴墨阅读 3,146评论 7 6