MKNetworkKit 回调次数多于请求数问题分析

问题现象

前一段时间遇到一个关于dispatch_group 使用时的崩溃问题，崩溃原因很明确，就是在配对使用dispatch_group_enter(group) 和 dispatch_group_leave(group)时，多调用了一次dispatch_leave，引起崩溃。但在检查代码逻辑后，没有发现可能引起不匹配的点。大概的代码逻辑如下：

[_queryEventLock lock];
for (int i=0; i<[tasks count]; i++) {
     dispatch_group_enter(group);
       [HttpRequesMehtod complete:^{
           dispatch_group_leave(group);
       }];
}
dispatch_group_notify(group,  queue, ^{
    if (callBackBlock) {
        callBackBlock();
    }
    [_queryEventLock unlock];
});

原因分析

最后通过打印发现，dispatch_group_leave()确实会多调一次，能想到的唯一的可能就是Http请求的回调会多回调一次。
刚好看到这篇文章iOS疑难问题排查之深入探究dispatch_group crash，就想我们的网络请求库是否也有类似的问题。
我们目前工程中使用的MKNetworkKit 网络请求框架，通过一步步对源码梳理，发现其确实也有类似的问题。

关键代码如下:

NSArray *operations = _sharedNetworkQueue.operations;
NSUInteger index = [operations indexOfObject:operation];
BOOL operationFinished = NO;
if(index != NSNotFound) {
  MKNetworkOperation *queuedOperation = (MKNetworkOperation*) (operations)[index];
  operationFinished = [queuedOperation isFinished];
  if(!operationFinished) {
     dispatch_async(dispatch_get_main_queue(), ^{
      [queuedOperation updateHandlersFromOperation:operation];
    });
  }
}

if(expiryTimeInSeconds <= 0 || forceReload || operationFinished) {
    [_sharedNetworkQueue addOperation:operation];
}

其中updateHandlersFromOperation:operation的方法实现如下，其主要的实现为将operation的回调block加入到当前的回调block列表中

-(void) updateHandlersFromOperation:(MKNetworkOperation*) operation {
  [self.responseBlocks addObjectsFromArray:operation.responseBlocks];
  [self.errorBlocks addObjectsFromArray:operation.errorBlocks];
  [self.errorBlocksType2 addObjectsFromArray:operation.errorBlocksType2];
  [self.notModifiedHandlers addObjectsFromArray:operation.notModifiedHandlers];
  [self.uploadProgressChangedHandlers addObjectsFromArray:operation.uploadProgressChangedHandlers];
  [self.downloadProgressChangedHandlers addObjectsFromArray:operation.downloadProgressChangedHandlers];
  [self.downloadStreams addObjectsFromArray:operation.downloadStreams];
}

其中的如self.responseBlocks会在请求真实的网络请求结束后被调用:

-(void) operationSucceeded {
  for(MKNKResponseBlock responseBlock in self.responseBlocks)
    responseBlock(self);
}

//MKNetworkOperation类的方法
-(NSString*) uniqueIdentifier {
  
  NSMutableString *str = [NSMutableString stringWithFormat:@"%@ %@", self.request.HTTPMethod, self.url];
  
  if(self.username || self.password) {
    
    [str appendFormat:@" [%@:%@]",
     self.username ? self.username : @"",
     self.password ? self.password : @""];
  }
  
  if(self.freezable) {
    
    [str appendString:self.uniqueId];
  }
  return [str md5];
}

下面来对第一段代码进行分析，如果在非常相近的时间发出了两个相同的请求（猜想其是根据上面的-(NSString*) uniqueIdentifier方法的值来判断，假设为OperationA和OperationB）。OperationA走到这里时，没有正在进行中的请求，operationFinished为NO，会走到[_sharedNetworkQueue addOperation:operation];方法，然后去执行真正的网络请求。然后当OperationB走到这里时，由于OperationA和OperationB请求相同，所以会执行[queuedOperation updateHandlersFromOperation:operation];方法，把第二次请求的回调block添加到OperationA的回调列表中。但是，由于 我们的服务器不支持缓存，所以expiryTimeInSeconds始终是0，所以，还是会走到[_sharedNetworkQueue addOperation:operation];方法中，就是两个请求都会被实际发送出去。这样的结果是，OperationA请求结束后，执行的回调是OperationA和OperationB两个请求的回调，OperationB请求结束后，又执行了一遍OperationB的回调。这就是刚开始说到的会多回调一次的原因。
写一个小的Demo，打印结果也验证了自己的想法:

    dispatch_async(dispatch_get_global_queue(0, 0), ^{
        [UVHttpApi getUpgradeInfoWithErrorHandler:^(ELYTHttpResponse *httpResponse) {
            NSLog(@"KKKKK:get upgrade info error-1");
        } successHandler:^(ELYTHttpResponse *httpResponse) {
            NSLog(@"KKKKK:get upgrade info-1");
        }];
    });
    dispatch_async(dispatch_get_global_queue(0, 0), ^{
        [UVHttpApi getUpgradeInfoWithErrorHandler:^(ELYTHttpResponse *httpResponse) {
            NSLog(@"KKKKK:get upgrade info error-2");
        } successHandler:^(ELYTHttpResponse *httpResponse) {
            NSLog(@"KKKKK:get upgrade info-2");
        }];
    });

最终打印结果如下:

2019-04-19 09:29:30.073459+0800 EZView[1713:520236] KKKKK:operation succeed
2019-04-19 09:29:30.088405+0800 EZView[1713:520236] KKKKK:get upgrade info-2
2019-04-19 09:29:30.089059+0800 EZView[1713:520236] KKKKK:get upgrade info-1
2019-04-19 09:29:30.091497+0800 EZView[1713:520236] KKKKK:operation succeed
2019-04-19 09:29:30.092106+0800 EZView[1713:520236] KKKKK:get upgrade info-1

这里应该是第二个请求先被创建，第一个后被创建的打印结果。

在MKNetworkKit的issues里面也有人提出了类似的问题，不过没有人回复。
onCompletion block is executing X times (more than twice!)。

问题解决

我最终解决问题的方法是将operation的shouldNotCacheResponse属性设置为YES，即将请求设置为不支持缓存，这样就不会去判断是否已有正在进行中的相同请求及后续操作，所以不会有此问题。

PS:
这里有一个地方没有想明白

NSArray *operations = _sharedNetworkQueue.operations;
        NSUInteger index = [operations indexOfObject:operation];
        BOOL operationFinished = NO;
        if(index != NSNotFound) {
          
          MKNetworkOperation *queuedOperation = (MKNetworkOperation*) (operations)[index];
          operationFinished = [queuedOperation isFinished];
          if(!operationFinished) {
            dispatch_async(dispatch_get_main_queue(), ^{
              NSLog(@"queueOperation:%p, operation:%p", queuedOperation, operation);
              [queuedOperation updateHandlersFromOperation:operation];
            });
          }
        }

2019-04-19 09:29:16.690035+0800 EZView[1713:520236] queueOperation:0x10432ab60, operation:0x104310030

这里的operation和queuedOperation看起来是同一个对象，但按照逻辑和打印结果都显示其是不同对象，还没能很好的理解这段代码。