YYThreadSafeArray是YYKit中的一个工具类，旨在提供线程安全的数组。YYThreadSafeArray的原理是继承NSMutableArray的，并且对其中必要的方法加锁来保证线程安全。但是，虽然YYKit在开源界使用广泛，但是YYThreadSafeArray依然有一些多线程方面的问题。其中部分问题在我们的项目中暴露和修复。
问题1：调用枚举方法导致死锁
调用方式：
YYThreadSafeArray *array = [[YYThreadSafeArray alloc] initWithObjects:@"hello world", nil];
[array enumerateObjectsUsingBlock:^(id _Nonnull obj, NSUInteger idx, BOOL * _Nonnull stop) {
[array count];
}];
导致问题：
死锁。
原因分析：
YYThreadSafeArray使用加锁的方式保证线程安全。加的锁是信号量：dispatch_semaphore。
#define LOCK(...) dispatch_semaphore_wait(_lock, DISPATCH_TIME_FOREVER); \
__VA_ARGS__; \
dispatch_semaphore_signal(_lock);
dispatch_semaphore并不是可重入的。因此，遇到重入的情况，就会发生死锁问题。举的例子只是其中一个死锁场景。
YY选择使用dispatch_semaphore的原因，可能是判断dispatch_semaphore的执行效率较高。可以参考YY对各种锁的效率测评：https://blog.ibireme.com/2016/01/16/spinlock_is_unsafe_in_ios/
修复方法：
使用pthread_mutex替代dispatch_semaphore。pthread_mutex有参数可以设置为可重入。在YY测试的执行效率上，可重入的pthread_mutex是可重入锁中效率较高的一个。
问题2：判等导致死锁
在使用pthread_mutex替代dispatch_semaphore的方式修复了可重入锁的问题后，我们发现YYThreadSafeArray在判等处的代码是有死锁隐患的。
调用方式：
YYThreadSafeArray *threadSafeArrayA = [[YYThreadSafeArray alloc] init];
YYThreadSafeArray *threadSafeArrayB = [[YYThreadSafeArray alloc] init];
for (int i = 0; i < 1000000; i++) {
[threadSafeArrayA addObject:@(i)];
[threadSafeArrayB addObject:@(i)];
}
for (int i = 0; i < 10000; i++) {
dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
[threadSafeArrayB isEqualToArray:threadSafeArrayA];
});
[threadSafeArrayA isEqualToArray:threadSafeArrayB];
}
如果两个线程中，同时分别执行
[A isEqualToArray:B];
和
[B isEqualToArray:A];
则会有一定概率死锁。
原因分析：
我们查看YYThreadSafeArray中isEqualToArray方法的源码：
- (BOOL)isEqualToArray:(NSArray *)otherArray {
if (otherArray == self) return YES;
if ([otherArray isKindOfClass:YYThreadSafeArray.class]) {
YYThreadSafeArray *other = (id)otherArray;
BOOL isEqual;
dispatch_semaphore_wait(_lock, DISPATCH_TIME_FOREVER);
dispatch_semaphore_wait(other->_lock, DISPATCH_TIME_FOREVER);
isEqual = [_arr isEqualToArray:other->_arr];
dispatch_semaphore_signal(other->_lock);
dispatch_semaphore_signal(_lock);
return isEqual;
}
return NO;
}
在线程1中调用
[A isEqualToArray:B];
此时，执行完
dispatch_semaphore_wait(_lock, DISPATCH_TIME_FOREVER);
这行，A的_lock锁进入锁住状态。
同时，线程2调用
[B isEqualToArray:A];
执行完
dispatch_semaphore_wait(_lock, DISPATCH_TIME_FOREVER);
这行，B的_lock锁也进入锁住状态。
那么线程1在执行下一行
dispatch_semaphore_wait(other->_lock, DISPATCH_TIME_FOREVER);
时，由于B ->_lock已经被锁住，线程1不得不阻塞在此，等待B的锁被解锁。
而同时，B也在执行同一行代码时，在等待A的锁被解锁。
这就造成了死锁的情形。
代码类似的isEqual:方法也有一样的问题。
修复方法：
为了修复这个场景，我们引入了一个新的全局的锁，将整个方法锁起来，防止两个线程同时进入isEqualToArray:方法中。
问题3：for-in循环的线程不安全
YYThreadSafeArray在只用for-in循环时，是无法保证线程安全的。
调用方式：
YYThreadSafeArray *threadSafeArray = [[YYThreadSafeArray alloc] init];
for (int i = 0; i < 1000000; i++) {
[threadSafeArray addObject:@(i)];
}
dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
for (int i = 0; i < 100000; i++) {
[threadSafeArray removeLastObject];
}
});
for (id obj in threadSafeArray) {
(void)obj;
}
此时大概率会抛出异常：
*** Terminating app due to uncaught exception 'NSGenericException', reason: '*** Collection <YYThreadSafeArray: 0x60000165aa20> was mutated while being enumerated.'
原因分析：
在执行for-in循环时，会调用NSArray的
- (NSUInteger)countByEnumeratingWithState:(NSFastEnumerationState *)state
objects:(id __unsafe_unretained[])stackbuf
count:(NSUInteger)len;
方法。
for-in循环之所以有更高的效率，是因为在循环时，它并非每次都访问NSArray数组，而是直接将一段NSArray数组，当作一个C数组来访问，直接便利这个C数组。对于NSArray来说，state.itemsPtr字段将返回这个C数组的指针。
但在这个方法中加锁，锁住的只是寻找这个C数组的过程，并不能锁住整个for-in循环过程。所以，当多线程进入时，会抛出was mutated while being enumerated异常。
修复方法：
这个问题没有想到优雅的修复方法。有2种不怎么优雅的方式可选：
- 让调用方用enumerateObjectsUsingBlock这种遍历方法替代for-in循环，但在效率上肯定有折损；
- 将YYThreadSafeArray种的锁暴露出去，让业务方在for-in循环时自行加锁。
但这两种方法都依赖于调用方以一个特定的姿势来调用。如果调用姿势无法保证，YYThreadSafeArray也无法保证线程安全了。
