由AFN网络请求失败不曾返回错误信息引发的思考:
业务场景:
-
前置条件:
我们的服务端给我们返回接口请求失败(比如说参数错误等)是在AFN的success回调中获取的,是一个名为
Result
的Model
,里面有ResultCode
属性和一个ResultDesc
属性。客户端所有的提示都是直接提示resultDesc。 -
问题:
问题出现在登录中,当用户输错N次密码后账户将被锁定,无法登录。输入账号密码登录应当提示
账户已被锁定
,但是我们调用接口后只能获得http的错误码401,无法获得服务端提供给我们的Result。 -
查看:
经过断点查看,其实服务端是返回给我们相应的错误码的,问题在于AFN在error回调中并不会将responseObject返回给我们,返回给我们的只有
(dataTask, error)
。代码如下(AFHTTPSessionManager.m 中的POST方法):
(NSURLSessionDataTask*)dataTaskWithHTTPMethod:(NSString*)method
URLString:(NSString*)URLString
parameters:(id)parameters
uploadProgress:(nullablevoid(^)(NSProgress*uploadProgress)) uploadProgress
downloadProgress:(nullablevoid(^)(NSProgress*downloadProgress)) downloadProgress
success:(void(^)(NSURLSessionDataTask*, id))success
failure:(void(^)(NSURLSessionDataTask*, NSError*))failure
{
NSError*serializationError=nil;
NSMutableURLRequest*request=[self.requestSerializerrequestWithMethod:methodURLString:[[NSURLURLWithString:URLStringrelativeToURL:self.baseURL] absoluteString] parameters:parameterserror:&serializationError];
if(serializationError) {
if(failure) {
dispatch_async(self.completionQueue?: dispatch_get_main_queue(), ^{
failure(nil, serializationError);
});
}
returnnil;
}
__blockNSURLSessionDataTask*dataTask=nil;
dataTask=[selfdataTaskWithRequest:request
uploadProgress:uploadProgress
downloadProgress:downloadProgress
completionHandler:^(NSURLResponse*__unusedresponse, idresponseObject, NSError*error) {
if(error) {
if(failure) {
failure(dataTask, error);
}
} else{
if(success) {
success(dataTask, responseObject);
}
}
}];
returndataTask;
}
- 解决方法:
经过查找资料发现我们可以在error中获得服务器返回的信息。
NSData*errorData=[error.userInfoobjectForKey:AFNetworkingOperationFailingURLResponseDataErrorKey];
NSDictionary*dic=[NSJSONSerializationJSONObjectWithData:errorDataoptions:NSJSONReadingAllowFragmentserror:nil];
Error 的返回包括了下述三个字段,都可以在error.userInfo中取出,其中的AFNetworkingOperationFailingURLResponseDataErrorKey就是我们需要的错误信息。将其转化为DIctionary就可以获取我需要的值了。
NSString*constAFURLResponseSerializationErrorDomain=@"com.alamofire.error.serialization.response";
NSString*constAFNetworkingOperationFailingURLResponseErrorKey=@"com.alamofire.serialization.response.error.response";
NSString*constAFNetworkingOperationFailingURLResponseDataErrorKey=@"com.alamofire.serialization.response.error.data";
思考
为什么失败信息会在成功回调和失败回调中都返回,这样的话AFN区分成功回调和失败回调有什么意义呢?
问了公司大佬得到的解释:
我说到的两种错误信息是不同的,错误信息包括网络错误信息和业务错误信息。
- 网络错误由http返回,有一个统一的行业标准,从1xx到5xx,基本涵盖了所有的错误。http错误码解析 。
- 业务错误千奇百怪,就无法一一罗列形成统一的行业标准,所以在200里返回一个
result
模型,包含resultCode和ResultDesc。
为了适应公司的需求,我们认为把AFN提供的success
和failure
的回调合成一个completionHandler
,返回信息包括responseObject会更合适一点。最后封装成如下的方式:
+(NSURLSessionTask*) doPost:(AFHTTPSessionManager*) manageUrl:(NSString*) urlParams:(NSDictionary*) paramsCompletionHandler:(void(^)(NSURLSessionDataTask*task, idresponseObject)) completionHandler{
return[managePOST:urlparameters:paramsprogress:nilsuccess:^(NSURLSessionDataTask*_Nonnulltask, id _NonnullresponseObject) {
completionHandler(task, responseObject);
} failure:^(NSURLSessionDataTask*_Nullabletask, NSError*_Nonnullerror) {
NSData*errorData=[error.userInfoobjectForKey:AFNetworkingOperationFailingURLResponseDataErrorKey];
NSDictionary*dic=[NSJSONSerializationJSONObjectWithData:errorDataoptions:NSJSONReadingAllowFragmentserror:nil];
completionHandler(task, dic);
}];
}