写在前面:在接口的设计上,一般来说都会有两个 statusCode:一个代表通讯协议层面,一个代表业务层面。但是,在某些特定的场景,这两者之间可能混淆。也就是说,程序需要在通讯失败的情况下,获取服务器返回给前端的一些报文信息。
-
为什么会存在这样的问题
1.正常情况下,交易应该是:通讯状态码(200)+业务逻辑状态码(自定义)去处理每只交易的。但某个例存在,通讯状态码(非200)+业务逻辑状态码(自定义)去处理某些特殊情况。
2.在AF3.0版本中 当交易处理完毕时,当http通讯协议级别上返回的状态码是200时,框架会将业务逻辑报文返回给上一层;在通讯失败时,返回的是 错误信息,并没有将我们需要的报文返回给上一层。
-
该问题适用的场景
-
AF2.0 ,获取服务器返回的错误信息
AFHTTPRequestOperation *operation =[[AFHTTPRequestOperation alloc]initWithRequest:request];
[operation setCompletionBlockWithSuccess:^(AFHTTPRequestOperation *operation, id responseObject)
{
success(operation, responseObject);
} failure:^(AFHTTPRequestOperation *operation, NSError *error) {
//通讯协议状态码
NSInteger statusCode = operation.response.statusCode;
//服务器返回的业务逻辑报文信息
NSDictionary *dict = operation.responseObject;
failure(operation,error);
}];
为了简洁上面的代码删除了一些公共方法,在af的失败回调方法中,operation的这两个方法,可以将服务器返回的信息帮你取到。
那么,为什么2.0会如此轻易完成目标呢,我们不妨看一下其post方法是如何实现的。
#pragma mark - AFHTTPRequestOperation
-(void)setCompletionBlockWithSuccess:(void (^)(AFHTTPRequestOperation *operation, id responseObject))success
failure:(void (^)(AFHTTPRequestOperation *operation, NSError *error))failure
{
// completionBlock is manually nilled out in AFURLConnectionOperation to break the retain cycle.
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-retain-cycles"
#pragma clang diagnostic ignored "-Wgnu"
self.completionBlock = ^{
if (self.completionGroup) {
dispatch_group_enter(self.completionGroup);
}
//在这个位置 我们已经找到了 请求完毕时处理方法
dispatch_async(http_request_operation_processing_queue(), ^{
//当通讯失败的时候,failure返回的是(self,self.error),而这个self指代的当前对象是AFHTTPRequestOperation实例,在它的属性方法中,存在responseObject,因此2.0方法,天然的可以解决此类问题
if (self.error) {
if (failure) {
dispatch_group_async(self.completionGroup ?: http_request_operation_completion_group(), self.completionQueue ?: dispatch_get_main_queue(), ^{
failure(self, self.error);
});
}
} else {
id responseObject = self.responseObject;
if (self.error) {
if (failure) {
dispatch_group_async(self.completionGroup ?: http_request_operation_completion_group(), self.completionQueue ?: dispatch_get_main_queue(), ^{
failure(self, self.error);
});
}
} else {
if (success) {
dispatch_group_async(self.completionGroup ?: http_request_operation_completion_group(), self.completionQueue ?: dispatch_get_main_queue(), ^{
success(self, responseObject);
});
}
}
}
if (self.completionGroup) {
dispatch_group_leave(self.completionGroup);
}
});
};
#pragma clang diagnostic pop
}
从源码中,我们可以发现:当通讯失败的时候,failure返回的是(self,self.error),而这个self指代的当前对象是AFHTTPRequestOperation实例,在它的属性方法中,存在responseObject,因此2.0版本,天然的可以解决此类问题
-
AF3.0 ,如何获取服务器返回的部分信息
[manager POST:urlStr parameters:parameters progress:nil success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) {
success(manager,responseObject);
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
NSHTTPURLResponse *response = (NSHTTPURLResponse*)task.response;
//通讯协议状态码
NSInteger statusCode = response.statusCode;
//服务器返回的业务逻辑报文信息
NSDictionary *json = __dataSource.loginTimeOutDic;
failure(task,error);
}];
在3.0版本中,通讯协议的状态码还是很容易获取到的。但是,业务逻辑报文就没那么容易拿到了。这个问题,我们可以往下研究一下3.0的实现代码。
1.3.0版本的post请求方法
-(NSURLSessionDataTask *)POST:(NSString *)URLString
parameters:(id)parameters
progress:(void (^)(NSProgress * _Nonnull))uploadProgress
success:(void (^)(NSURLSessionDataTask * _Nonnull, id _Nullable))success
failure:(void (^)(NSURLSessionDataTask * _Nullable, NSError * _Nonnull))failure
{
//在这里发情了请求,我们继续往下探寻
NSURLSessionDataTask *dataTask = [self dataTaskWithHTTPMethod:@"POST" URLString:URLString parameters:parameters uploadProgress:uploadProgress downloadProgress:nil success:success failure:failure];
[dataTask resume];
return dataTask;
}
-(NSURLSessionDataTask *)dataTaskWithHTTPMethod:(NSString *)method
URLString:(NSString *)URLString
parameters:(id)parameters
uploadProgress:(nullable void (^)(NSProgress *uploadProgress)) uploadProgress
downloadProgress:(nullable void (^)(NSProgress *downloadProgress)) downloadProgress
success:(void (^)(NSURLSessionDataTask *, id))success
failure:(void (^)(NSURLSessionDataTask *, NSError *))failure
{
NSError *serializationError = nil;
NSMutableURLRequest *request = [self.requestSerializer requestWithMethod:method URLString:[[NSURL URLWithString:URLString relativeToURL:self.baseURL] absoluteString] parameters:parameters error:&serializationError];
if (serializationError) {
if (failure) {
dispatch_async(self.completionQueue ?: dispatch_get_main_queue(), ^{
failure(nil, serializationError);
});
}
return nil;
}
//在这个位置 我们找到了 post请求处理完毕时的回调方法
__block NSURLSessionDataTask *dataTask = nil;
dataTask = [self dataTaskWithRequest:request
uploadProgress:uploadProgress
downloadProgress:downloadProgress
completionHandler:^(NSURLResponse * __unused response, id responseObject, NSError *error) {
if (error) {
if (failure) {
//先使用一种low逼的方法 用一个全局变量将逻辑报文信息带回
__dataSource.loginTimeOutDic = responseObject;
//原因在这里,3.0版本并没有将逻辑报文返回到上一页面
failure(dataTask, error);
}
} else {
if (success) {
success(dataTask, responseObject);
}
}
}];
return dataTask;
}
2.这种修改第三方成熟框架的方法,从个人开发经验来说,并不推崇。
当使用cocopods管理第三方工具的时候,并没有办法去修改第三方的框架,当更新之后,会出现代码被覆盖掉的问题。而且,修改这类代码可能会出现意想不到的问题,虽然可以通过扩展的方式,不影响原代码逻辑,但毕竟是不方便。因此,我推荐用下面这种方法去实现,这个功能。
[manager POST:urlStr parameters:parameters progress:nil success:^(NSURLSessionDataTask * _Nonnull task, id _Nullable responseObject) {
success(manager,responseObject);
} failure:^(NSURLSessionDataTask * _Nullable task, NSError * _Nonnull error) {
NSHTTPURLResponse *response = (NSHTTPURLResponse*)task.response;
//通讯协议状态码
NSInteger statusCode = response.statusCode;
//服务器返回的业务逻辑报文信息
NSString* errResponse = [[NSString alloc] initWithData:(NSData *)error.userInfo[AFNetworkingOperationFailingURLResponseDataErrorKey] encoding:NSUTF8StringEncoding];
NSDictionary *json = [self dictionaryWithJson_String:errResponse];
failure(task,error);
}];
注意,在这里取值的userInfo,是根据post请求完毕处理的方法,下面发现的代理方法中,