版本记录

前言

iOS圈内有几个人大家基本都知道，比如说王巍、唐巧，还有YYKit框架的作者现任职于滴滴的郭曜源 - ibireme等。这里有一篇唐巧对他的专访，还有他的 GitHub - Yaoyuan 和 博客，这里贴出来框架YYKit 框架。接下来几篇我们就一起来看一下这个框架。感兴趣的可以看上面写的几篇。
1. YYKit源码探究（一） —— 基本概览
2. YYKit源码探究（二） —— NSString分类之Hash（一）
3. YYKit源码探究（三） —— NSString分类之Encode and decode（二）
4. YYKit源码探究（四） —— NSString分类之Drawing（三）
5. YYKit源码探究（五） —— NSString分类之Regular Expression（四）
6. YYKit源码探究（六） —— NSString分类之NSNumber Compatible（五）
7. YYKit源码探究（七） —— NSString分类之Utilities（六）
8. YYKit源码探究（八） —— NSNumber分类（一）
9. YYKit源码探究（九） —— UIFont分类之架构分析和Font Traits（一）
10. YYKit源码探究（十） —— UIFont分类之Create font（二）
11. YYKit源码探究（十一） —— UIFont分类之Load and unload font（三）
12. YYKit源码探究（十二） —— UIFont分类之Dump font data（四）
13. YYKit源码探究（十三） —— UIImage分类之框架结构和Create image部分（一）
14. YYKit源码探究（十四） —— UIImage分类之Image Info（二）
15. YYKit源码探究（十五） —— UIImage分类之Modify Image（三）
16. YYKit源码探究（十六） —— UIImage分类之Image Effect（四）
17. YYKit源码探究（十七） —— UIImageView分类之架构和image部分（一）
18. YYKit源码探究（十八） —— UIImageView分类之highlight image部分（二）
19. YYKit源码探究（十九） —— UIScreen分类（一）
20. YYKit源码探究（二十） —— UIScrollView分类（一）
21. YYKit源码探究（二十一） —— UITableView分类（一）
22. YYKit源码探究（二十二） —— UITextField分类（一）
23. YYKit源码探究（二十三） —— UIView分类（一）
24. YYKit源码探究（二十四） —— UIPasteboard分类（一）
25. YYKit源码探究（二十五） —— UIGestureRecognizer分类（一）
26. YYKit源码探究（二十六） —— UIDevice分类框架及Device Information（一）
27. YYKit源码探究（二十七） —— UIDevice分类之Network Information（二）
28. YYKit源码探究（二十八） —— UIDevice分类之Disk Space（三）
29. YYKit源码探究（二十九） —— UIDevice分类之Memory Information（四）
30. YYKit源码探究（三十） —— UIDevice分类之CPU Information（五）
31. YYKit源码探究（三十一） —— UIControl分类（一）
32. YYKit源码探究（三十二） —— UIColor分类之Create a UIColor Object（一）
33. YYKit源码探究（三十三） —— UIColor分类之Get color's description（二）
34. YYKit源码探究（三十四） —— UIColor分类之Retrieving Color Information（三）
35. YYKit源码探究（三十五） —— UIButton分类之image（一）
36. YYKit源码探究（三十六） —— UIButton分类之background image（二）
37. YYKit源码探究（三十七） —— UIBezierPath分类（一）
38. YYKit源码探究（三十八） —— UIBarButtonItem分类（一）
39. YYKit源码探究（三十九） —— UIApplication分类（一）
40. YYKit源码探究（四十） —— NSTimer分类（一）
41. YYKit源码探究（四十一） —— NSParagraphStyle分类（一）
42. YYKit源码探究（四十二） —— NSObject分类之YYModel（一）
43. YYKit源码探究（四十三） —— NSObject分类之KVO（二）
44. YYKit源码探究（四十四） —— NSObject分类之Sending messages with variable parameters（三）
45. YYKit源码探究（四十五） —— NSObject分类之Swap method (Swizzling)（四）
46. YYKit源码探究（四十六） —— NSObject分类之Associate value（五）
47. YYKit源码探究（四十七） —— NSObject分类之Other（六）
48. YYKit源码探究（四十八） —— NSNotificationCenter分类（一）
49. YYKit源码探究（四十九） —— NSKeyedUnarchiver分类（一）
50. YYKit源码探究（五十） —— NSDictionary分类之Dictionary Convertor（一）
51. YYKit源码探究（五十一） —— NSDictionary分类之Dictionary Value Getter（二）
52. YYKit源码探究（五十二） —— NSDictionary分类之NSMutableDictionary（三）
53. YYKit源码探究（五十三） —— NSDate分类之Component Properties（一）
54. YYKit源码探究（五十四） —— NSDate分类之Date modify（二）
55. YYKit源码探究（五十五） —— NSDate分类之Date Format（三）
56. YYKit源码探究（五十六） —— NSData分类之Hash（一）
57. YYKit源码探究（五十七） —— NSData分类之Encrypt and Decrypt（二）
58. YYKit源码探究（五十八） —— NSData分类之Encode and decode（三）
59. YYKit源码探究（五十九） —— NSData分类之Inflate and deflate（四）
60. YYKit源码探究（六十） —— NSData分类之Others（五）
61. YYKit源码探究（六十一） —— NSBundle分类（一）
62. YYKit源码探究（六十二） —— NSAttributedString分类之基本（一）
63. YYKit源码探究（六十三） —— NSAttributedString分类之Retrieving character attribute information（二）
64. YYKit源码探究（六十四） —— NSAttributedString分类之Get character attribute as property（三）
65. YYKit源码探究（六十五） —— NSAttributedString分类之Get paragraph attribute as property（四）
66. YYKit源码探究（六十六） —— NSAttributedString分类之Get YYText attribute as property（五）
67. YYKit源码探究（六十七） —— NSAttributedString分类之Query for YYText（六）
68. YYKit源码探究（六十八） —— NSAttributedString分类之Create attachment string for YYText（七）
69. YYKit源码探究（六十九） —— NSAttributedString分类之Utility（八）
70. YYKit源码探究（七十） —— NSMutableAttributedString分类之Set character attribute（九）
71. YYKit源码探究（七十一） —— NSMutableAttributedString分类之Set character attribute as property（十）
72. YYKit源码探究（七十二） —— NSMutableAttributedString分类之Set paragraph attribute as property（十一）
73. YYKit源码探究（七十三） —— NSMutableAttributedString分类之Set YYText attribute as property（十二）
74. YYKit源码探究（七十四） —— NSMutableAttributedString分类之Set discontinuous attribute for range（十三）
75. YYKit源码探究（七十五） —— NSMutableAttributedString分类之Convenience methods for text highlight（十四）
76. YYKit源码探究（七十六） —— NSMutableAttributedString分类之Utilities（十五）
77. YYKit源码探究（七十七） —— NSArray分类（一）
78. YYKit源码探究（七十八） —— NSMutableArray分类（一）
79. YYKit源码探究（七十九） —— MKAnnotationView分类（一）
80. YYKit源码探究（八十） —— CALayer分类之YYWebImage（一）
81. YYKit源码探究（八十一） —— CALayer分类之YYAdd（二）
82. YYKit源码探究（八十二） —— 网络相关YYReachability（一）
83. YYKit源码探究（八十三） —— 线程安全计数器YYSentinel（一）

回顾

上一篇主要介绍了线程安全计数器YYSentinel部分，这一篇主要看一下线程安全的可变数组子类YYThreadSafeArray部分。

API

下面我们就看一下API文档。

/**
 A simple implementation of thread safe mutable array.
 
 @discussion Generally, access performance is lower than NSMutableArray, 
 but higher than using @synchronized, NSLock, or pthread_mutex_t.
 
 @discussion It's also compatible with the custom methods in `NSArray(YYAdd)`
 and `NSMutableArray(YYAdd)`
 
 @warning Fast enumerate(for..in) and enumerator is not thread safe,
 use enumerate using block instead. When enumerate or sort with block/callback,
 do *NOT* send message to the array inside the block/callback.
 */
@interface YYThreadSafeArray : NSMutableArray

@end

这个类主要就是线程安全可变数组的简单实现。

通常，访问性能低于NSMutableArray，但高于使用@synchronized，NSLock或pthread_mutex_t。

与NSArray(YYAdd)和 NSMutableArray(YYAdd)中的自定义方法兼容。

快速枚举enumerate(for..in)和枚举器不是线程安全的，使用block进行遍历枚举。当使用block/callback进行遍历时，不要向block/callback内部的数组发送消息。

方法实现

下面我们看一下方法实现。

//
//  YYThreadSafeArray.m
//  YYKit <https://github.com/ibireme/YYKit>
//
//  Created by ibireme on 14/10/21.
//  Copyright (c) 2015 ibireme.
//
//  This source code is licensed under the MIT-style license found in the
//  LICENSE file in the root directory of this source tree.
//

#import "YYThreadSafeArray.h"
#import "NSArray+YYAdd.h"


#define INIT(...) self = super.init; \
if (!self) return nil; \
__VA_ARGS__; \
if (!_arr) return nil; \
_lock = dispatch_semaphore_create(1); \
return self;


#define LOCK(...) dispatch_semaphore_wait(_lock, DISPATCH_TIME_FOREVER); \
__VA_ARGS__; \
dispatch_semaphore_signal(_lock);


@implementation YYThreadSafeArray {
    NSMutableArray *_arr;  //Subclass a class cluster...
    dispatch_semaphore_t _lock;
}

#pragma mark - init

- (instancetype)init {
    INIT(_arr = [[NSMutableArray alloc] init]);
}

- (instancetype)initWithCapacity:(NSUInteger)numItems {
    INIT(_arr = [[NSMutableArray alloc] initWithCapacity:numItems]);
}

- (instancetype)initWithArray:(NSArray *)array {
    INIT(_arr = [[NSMutableArray alloc] initWithArray:array]);
}

- (instancetype)initWithObjects:(const id[])objects count:(NSUInteger)cnt {
    INIT(_arr = [[NSMutableArray alloc] initWithObjects:objects count:cnt]);
}

- (instancetype)initWithContentsOfFile:(NSString *)path {
    INIT(_arr = [[NSMutableArray alloc] initWithContentsOfFile:path]);
}

- (instancetype)initWithContentsOfURL:(NSURL *)url {
    INIT(_arr = [[NSMutableArray alloc] initWithContentsOfURL:url]);
}

#pragma mark - method

- (NSUInteger)count {
    LOCK(NSUInteger count = _arr.count); return count;
}

- (id)objectAtIndex:(NSUInteger)index {
    LOCK(id obj = [_arr objectAtIndex:index]); return obj;
}

- (NSArray *)arrayByAddingObject:(id)anObject {
    LOCK(NSArray * arr = [_arr arrayByAddingObject:anObject]); return arr;
}

- (NSArray *)arrayByAddingObjectsFromArray:(NSArray *)otherArray {
    LOCK(NSArray * arr = [_arr arrayByAddingObjectsFromArray:otherArray]); return arr;
}

- (NSString *)componentsJoinedByString:(NSString *)separator {
    LOCK(NSString * str = [_arr componentsJoinedByString:separator]); return str;
}

- (BOOL)containsObject:(id)anObject {
    LOCK(BOOL c = [_arr containsObject:anObject]); return c;
}

- (NSString *)description {
    LOCK(NSString * d = _arr.description); return d;
}

- (NSString *)descriptionWithLocale:(id)locale {
    LOCK(NSString * d = [_arr descriptionWithLocale:locale]); return d;
}

- (NSString *)descriptionWithLocale:(id)locale indent:(NSUInteger)level {
    LOCK(NSString * d = [_arr descriptionWithLocale:locale indent:level]); return d;
}

- (id)firstObjectCommonWithArray:(NSArray *)otherArray {
    LOCK(id o = [_arr firstObjectCommonWithArray:otherArray]); return o;
}

- (void)getObjects:(id __unsafe_unretained[])objects range:(NSRange)range {
    LOCK([_arr getObjects:objects range:range]);
}

- (NSUInteger)indexOfObject:(id)anObject {
    LOCK(NSUInteger i = [_arr indexOfObject:anObject]); return i;
}

- (NSUInteger)indexOfObject:(id)anObject inRange:(NSRange)range {
    LOCK(NSUInteger i = [_arr indexOfObject:anObject inRange:range]); return i;
}

- (NSUInteger)indexOfObjectIdenticalTo:(id)anObject {
    LOCK(NSUInteger i = [_arr indexOfObjectIdenticalTo:anObject]); return i;
}

- (NSUInteger)indexOfObjectIdenticalTo:(id)anObject inRange:(NSRange)range {
    LOCK(NSUInteger i = [_arr indexOfObjectIdenticalTo:anObject inRange:range]); return i;
}

- (id)firstObject {
    LOCK(id o = _arr.firstObject); return o;
}

- (id)lastObject {
    LOCK(id o = _arr.lastObject); return o;
}

- (NSEnumerator *)objectEnumerator {
    LOCK(NSEnumerator * e = [_arr objectEnumerator]); return e;
}

- (NSEnumerator *)reverseObjectEnumerator {
    LOCK(NSEnumerator * e = [_arr reverseObjectEnumerator]); return e;
}

- (NSData *)sortedArrayHint {
    LOCK(NSData * d = [_arr sortedArrayHint]); return d;
}

- (NSArray *)sortedArrayUsingFunction:(NSInteger (*)(id, id, void *))comparator context:(void *)context {
    LOCK(NSArray * arr = [_arr sortedArrayUsingFunction:comparator context:context]) return arr;
}

- (NSArray *)sortedArrayUsingFunction:(NSInteger (*)(id, id, void *))comparator context:(void *)context hint:(NSData *)hint {
    LOCK(NSArray * arr = [_arr sortedArrayUsingFunction:comparator context:context hint:hint]); return arr;
}

- (NSArray *)sortedArrayUsingSelector:(SEL)comparator {
    LOCK(NSArray * arr = [_arr sortedArrayUsingSelector:comparator]); return arr;
}

- (NSArray *)subarrayWithRange:(NSRange)range {
    LOCK(NSArray * arr = [_arr subarrayWithRange:range]) return arr;
}

- (void)makeObjectsPerformSelector:(SEL)aSelector {
    LOCK([_arr makeObjectsPerformSelector:aSelector]);
}

- (void)makeObjectsPerformSelector:(SEL)aSelector withObject:(id)argument {
    LOCK([_arr makeObjectsPerformSelector:aSelector withObject:argument]);
}

- (NSArray *)objectsAtIndexes:(NSIndexSet *)indexes {
    LOCK(NSArray * arr = [_arr objectsAtIndexes:indexes]); return arr;
}

- (id)objectAtIndexedSubscript:(NSUInteger)idx {
    LOCK(id o = [_arr objectAtIndexedSubscript:idx]); return o;
}

- (void)enumerateObjectsUsingBlock:(void (^)(id obj, NSUInteger idx, BOOL *stop))block {
    LOCK([_arr enumerateObjectsUsingBlock:block]);
}

- (void)enumerateObjectsWithOptions:(NSEnumerationOptions)opts usingBlock:(void (^)(id obj, NSUInteger idx, BOOL *stop))block {
    LOCK([_arr enumerateObjectsWithOptions:opts usingBlock:block]);
}

- (void)enumerateObjectsAtIndexes:(NSIndexSet *)s options:(NSEnumerationOptions)opts usingBlock:(void (^)(id obj, NSUInteger idx, BOOL *stop))block {
    LOCK([_arr enumerateObjectsAtIndexes:s options:opts usingBlock:block]);
}

- (NSUInteger)indexOfObjectPassingTest:(BOOL (^)(id obj, NSUInteger idx, BOOL *stop))predicate {
    LOCK(NSUInteger i = [_arr indexOfObjectPassingTest:predicate]); return i;
}

- (NSUInteger)indexOfObjectWithOptions:(NSEnumerationOptions)opts passingTest:(BOOL (^)(id obj, NSUInteger idx, BOOL *stop))predicate {
    LOCK(NSUInteger i = [_arr indexOfObjectWithOptions:opts passingTest:predicate]); return i;
}

- (NSUInteger)indexOfObjectAtIndexes:(NSIndexSet *)s options:(NSEnumerationOptions)opts passingTest:(BOOL (^)(id obj, NSUInteger idx, BOOL *stop))predicate {
    LOCK(NSUInteger i = [_arr indexOfObjectAtIndexes:s options:opts passingTest:predicate]); return i;
}

- (NSIndexSet *)indexesOfObjectsPassingTest:(BOOL (^)(id obj, NSUInteger idx, BOOL *stop))predicate {
    LOCK(NSIndexSet * i = [_arr indexesOfObjectsPassingTest:predicate]); return i;
}

- (NSIndexSet *)indexesOfObjectsWithOptions:(NSEnumerationOptions)opts passingTest:(BOOL (^)(id obj, NSUInteger idx, BOOL *stop))predicate {
    LOCK(NSIndexSet * i = [_arr indexesOfObjectsWithOptions:opts passingTest:predicate]); return i;
}

- (NSIndexSet *)indexesOfObjectsAtIndexes:(NSIndexSet *)s options:(NSEnumerationOptions)opts passingTest:(BOOL (^)(id obj, NSUInteger idx, BOOL *stop))predicate {
    LOCK(NSIndexSet * i = [_arr indexesOfObjectsAtIndexes:s options:opts passingTest:predicate]); return i;
}

- (NSArray *)sortedArrayUsingComparator:(NSComparator)cmptr {
    LOCK(NSArray * a = [_arr sortedArrayUsingComparator:cmptr]); return a;
}

- (NSArray *)sortedArrayWithOptions:(NSSortOptions)opts usingComparator:(NSComparator)cmptr {
    LOCK(NSArray * a = [_arr sortedArrayWithOptions:opts usingComparator:cmptr]); return a;
}

- (NSUInteger)indexOfObject:(id)obj inSortedRange:(NSRange)r options:(NSBinarySearchingOptions)opts usingComparator:(NSComparator)cmp {
    LOCK(NSUInteger i = [_arr indexOfObject:obj inSortedRange:r options:opts usingComparator:cmp]); return i;
}

#pragma mark - mutable

- (void)addObject:(id)anObject {
    LOCK([_arr addObject:anObject]);
}

- (void)insertObject:(id)anObject atIndex:(NSUInteger)index {
    LOCK([_arr insertObject:anObject atIndex:index]);
}

- (void)removeLastObject {
    LOCK([_arr removeLastObject]);
}

- (void)removeObjectAtIndex:(NSUInteger)index {
    LOCK([_arr removeObjectAtIndex:index]);
}

- (void)replaceObjectAtIndex:(NSUInteger)index withObject:(id)anObject {
    LOCK([_arr replaceObjectAtIndex:index withObject:anObject]);
}

- (void)addObjectsFromArray:(NSArray *)otherArray {
    LOCK([_arr addObjectsFromArray:otherArray]);
}

- (void)exchangeObjectAtIndex:(NSUInteger)idx1 withObjectAtIndex:(NSUInteger)idx2 {
    LOCK([_arr exchangeObjectAtIndex:idx1 withObjectAtIndex:idx2]);
}

- (void)removeAllObjects {
    LOCK([_arr removeAllObjects]);
}

- (void)removeObject:(id)anObject inRange:(NSRange)range {
    LOCK([_arr removeObject:anObject inRange:range]);
}

- (void)removeObject:(id)anObject {
    LOCK([_arr removeObject:anObject]);
}

- (void)removeObjectIdenticalTo:(id)anObject inRange:(NSRange)range {
    LOCK([_arr removeObjectIdenticalTo:anObject inRange:range]);
}

- (void)removeObjectIdenticalTo:(id)anObject {
    LOCK([_arr removeObjectIdenticalTo:anObject]);
}

- (void)removeObjectsInArray:(NSArray *)otherArray {
    LOCK([_arr removeObjectsInArray:otherArray]);
}

- (void)removeObjectsInRange:(NSRange)range {
    LOCK([_arr removeObjectsInRange:range]);
}

- (void)replaceObjectsInRange:(NSRange)range withObjectsFromArray:(NSArray *)otherArray range:(NSRange)otherRange {
    LOCK([_arr replaceObjectsInRange:range withObjectsFromArray:otherArray range:otherRange]);
}

- (void)replaceObjectsInRange:(NSRange)range withObjectsFromArray:(NSArray *)otherArray {
    LOCK([_arr replaceObjectsInRange:range withObjectsFromArray:otherArray]);
}

- (void)setArray:(NSArray *)otherArray {
    LOCK([_arr setArray:otherArray]);
}

- (void)sortUsingFunction:(NSInteger (*)(id, id, void *))compare context:(void *)context {
    LOCK([_arr sortUsingFunction:compare context:context]);
}

- (void)sortUsingSelector:(SEL)comparator {
    LOCK([_arr sortUsingSelector:comparator]);
}

- (void)insertObjects:(NSArray *)objects atIndexes:(NSIndexSet *)indexes {
    LOCK([_arr insertObjects:objects atIndexes:indexes]);
}

- (void)removeObjectsAtIndexes:(NSIndexSet *)indexes {
    LOCK([_arr removeObjectsAtIndexes:indexes]);
}

- (void)replaceObjectsAtIndexes:(NSIndexSet *)indexes withObjects:(NSArray *)objects {
    LOCK([_arr replaceObjectsAtIndexes:indexes withObjects:objects]);
}

- (void)setObject:(id)obj atIndexedSubscript:(NSUInteger)idx {
    LOCK([_arr setObject:obj atIndexedSubscript:idx]);
}

- (void)sortUsingComparator:(NSComparator)cmptr {
    LOCK([_arr sortUsingComparator:cmptr]);
}

- (void)sortWithOptions:(NSSortOptions)opts usingComparator:(NSComparator)cmptr {
    LOCK([_arr sortWithOptions:opts usingComparator:cmptr]);
}

- (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;
}

#pragma mark - protocol

- (id)copyWithZone:(NSZone *)zone {
    return [self mutableCopyWithZone:zone];
}

- (id)mutableCopyWithZone:(NSZone *)zone {
    LOCK(id copiedDictionary = [[self.class allocWithZone:zone] initWithArray:_arr]);
    return copiedDictionary;
}

- (NSUInteger)countByEnumeratingWithState:(NSFastEnumerationState *)state
                                  objects:(id __unsafe_unretained[])stackbuf
                                    count:(NSUInteger)len {
    LOCK(NSUInteger count = [_arr countByEnumeratingWithState:state objects:stackbuf count:len]);
    return count;
}

- (BOOL)isEqual:(id)object {
    if (object == self) return YES;
    
    if ([object isKindOfClass:YYThreadSafeArray.class]) {
        YYThreadSafeArray *other = object;
        BOOL isEqual;
        dispatch_semaphore_wait(_lock, DISPATCH_TIME_FOREVER);
        dispatch_semaphore_wait(other->_lock, DISPATCH_TIME_FOREVER);
        isEqual = [_arr isEqual:other->_arr];
        dispatch_semaphore_signal(other->_lock);
        dispatch_semaphore_signal(_lock);
        return isEqual;
    }
    return NO;
}

- (NSUInteger)hash {
    LOCK(NSUInteger hash = [_arr hash]);
    return hash;
}

#pragma mark - custom methods for NSArray(YYAdd)

- (id)randomObject {
    LOCK(id o = [_arr randomObject]) return o;
}

- (id)objectOrNilAtIndex:(NSUInteger)index {
    LOCK(id o = [_arr objectOrNilAtIndex:index]) return o;
}

- (void)removeFirstObject {
    LOCK([_arr removeFirstObject]);
}

- (id)popFirstObject {
    LOCK(id o = [_arr popFirstObject]) return o;
}

- (id)popLastObject {
    LOCK(id o = [_arr popLastObject]) return o;
}

- (void)appendObjects:(NSArray *)objects {
    LOCK([_arr appendObjects:objects]);
}

- (void)prependObjects:(NSArray *)objects {
    LOCK([_arr prependObjects:objects]);
}

- (void)insertObjects:(NSArray *)objects atIndex:(NSUInteger)index {
    LOCK([_arr insertObjects:objects atIndex:index]);
}

- (void)reverse {
    LOCK([_arr reverse]);
}

- (void)shuffle {
    LOCK([_arr shuffle]);
}

@end

后记

本篇主要介绍了线程安全的可变数组子类YYThreadSafeArray，感兴趣的给个赞或者关注~~~