YYKit源码探究（七十八） —— NSMutableArray分类（一）

版本记录

版本号	时间
V1.0	2018.04.01

前言

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分类（一）

回顾

上一篇主要介绍了NSArray分类，这一篇主要看一下NSMutableArray分类部分。

---

API

下面我们看一下API

/**
 Creates and returns an array from a specified property list data.
 
 @param plist   A property list data whose root object is an array.
 @return A new array created from the binary plist data, or nil if an error occurs.
 */
+ (nullable NSMutableArray *)arrayWithPlistData:(NSData *)plist;

/**
 Creates and returns an array from a specified property list xml string.
 
 @param plist   A property list xml string whose root object is an array.
 @return A new array created from the plist string, or nil if an error occurs.
 */
+ (nullable NSMutableArray *)arrayWithPlistString:(NSString *)plist;

/**
 Removes the object with the lowest-valued index in the array.
 If the array is empty, this method has no effect.
 
 @discussion Apple has implemented this method, but did not make it public.
 Override for safe.
 */
- (void)removeFirstObject;

/**
 Removes the object with the highest-valued index in the array.
 If the array is empty, this method has no effect.
 
 @discussion Apple's implementation said it raises an NSRangeException if the
 array is empty, but in fact nothing will happen. Override for safe.
 */
- (void)removeLastObject;

/**
 Removes and returns the object with the lowest-valued index in the array.
 If the array is empty, it just returns nil.
 
 @return The first object, or nil.
 */
- (nullable id)popFirstObject;

/**
 Removes and returns the object with the highest-valued index in the array.
 If the array is empty, it just returns nil.
 
 @return The first object, or nil.
 */
- (nullable id)popLastObject;

/**
 Inserts a given object at the end of the array.
 
 @param anObject The object to add to the end of the array's content.
 This value must not be nil. Raises an NSInvalidArgumentException if anObject is nil.
 */
- (void)appendObject:(id)anObject;

/**
 Inserts a given object at the beginning of the array.
 
 @param anObject The object to add to the end of the array's content.
 This value must not be nil. Raises an NSInvalidArgumentException if anObject is nil.
 */
- (void)prependObject:(id)anObject;

/**
 Adds the objects contained in another given array to the end of the receiving
 array's content.
 
 @param objects An array of objects to add to the end of the receiving array's
 content. If the objects is empty or nil, this method has no effect.
 */
- (void)appendObjects:(NSArray *)objects;

/**
 Adds the objects contained in another given array to the beginnin of the receiving
 array's content.
 
 @param objects An array of objects to add to the beginning of the receiving array's
 content. If the objects is empty or nil, this method has no effect.
 */
- (void)prependObjects:(NSArray *)objects;

/**
 Adds the objects contained in another given array at the index of the receiving
 array's content.
 
 @param objects An array of objects to add to the receiving array's
 content. If the objects is empty or nil, this method has no effect.
 
 @param index The index in the array at which to insert objects. This value must
 not be greater than the count of elements in the array. Raises an
 NSRangeException if index is greater than the number of elements in the array.
 */
- (void)insertObjects:(NSArray *)objects atIndex:(NSUInteger)index;

/**
 Reverse the index of object in this array.
 Example: Before @[ @1, @2, @3 ], After @[ @3, @2, @1 ].
 */
- (void)reverse;

/**
 Sort the object in this array randomly.
 */
- (void)shuffle;

下面我们详细的看一下

1. + (nullable NSMutableArray *)arrayWithPlistData:(NSData *)plist;

根据指定的property list 数据，创建并实例化一个数组。

方法实现

+ (NSMutableArray *)arrayWithPlistData:(NSData *)plist {
    if (!plist) return nil;
    NSMutableArray *array = [NSPropertyListSerialization propertyListWithData:plist options:NSPropertyListMutableContainersAndLeaves format:NULL error:NULL];
    if ([array isKindOfClass:[NSMutableArray class]]) return array;
    return nil;
}

2. + (nullable NSMutableArray *)arrayWithPlistString:(NSString *)plist;

根据指定的property list xml字符串，创建并返回一个数组。

方法实现

+ (NSMutableArray *)arrayWithPlistString:(NSString *)plist {
    if (!plist) return nil;
    NSData *data = [plist dataUsingEncoding:NSUTF8StringEncoding];
    return [self arrayWithPlistData:data];
}

3. - (void)removeFirstObject;

移除首个元素。

方法实现

- (void)removeFirstObject {
    if (self.count) {
        [self removeObjectAtIndex:0];
    }
}

4. - (void)removeLastObject;

移除最后一个元素。

方法实现

- (void)removeLastObject {
    if (self.count) {
        [self removeObjectAtIndex:self.count - 1];
    }
}

5. - (nullable id)popFirstObject;

移除并返回数组中最低索引的对象。

方法实现

- (id)popFirstObject {
    id obj = nil;
    if (self.count) {
        obj = self.firstObject;
        [self removeFirstObject];
    }
    return obj;
}

6. - (nullable id)popLastObject;

移除并返回最大索引值对象。

方法实现

- (id)popLastObject {
    id obj = nil;
    if (self.count) {
        obj = self.lastObject;
        [self removeLastObject];
    }
    return obj;
}

7. - (void)appendObject:(id)anObject;

在数组中添加新的元素，如果anObject是nil，那么会引起NSInvalidArgumentException异常。

方法实现

- (void)appendObject:(id)anObject {
    [self addObject:anObject];
}

8. - (void)prependObject:(id)anObject;

将给定的对象插入到数组的开始位置。

方法实现

- (void)prependObject:(id)anObject {
    [self insertObject:anObject atIndex:0];
}

9. - (void)appendObjects:(NSArray *)objects;

在数组中拼接给定的数组。

方法实现

- (void)appendObjects:(NSArray *)objects {
    if (!objects) return;
    [self addObjectsFromArray:objects];
}

10. - (void)prependObjects:(NSArray *)objects;

将给定数组对象添加到数组的头部。

方法实现

- (void)prependObjects:(NSArray *)objects {
    if (!objects) return;
    NSUInteger i = 0;
    for (id obj in objects) {
        [self insertObject:obj atIndex:i++];
    }
}

11. - (void)insertObjects:(NSArray *)objects atIndex:(NSUInteger)index;

在任意索引处插入数组元素。

方法实现

- (void)insertObjects:(NSArray *)objects atIndex:(NSUInteger)index {
    NSUInteger i = index;
    for (id obj in objects) {
        [self insertObject:obj atIndex:i++];
    }
}

12. - (void)reverse;

将数组中的元素进行反向排列。例如：Before @[ @1, @2, @3 ], After @[ @3, @2, @1 ]。

方法实现

- (void)reverse {
    NSUInteger count = self.count;
    int mid = floor(count / 2.0);
    for (NSUInteger i = 0; i < mid; i++) {
        [self exchangeObjectAtIndex:i withObjectAtIndex:(count - (i + 1))];
    }
}

13. - (void)shuffle;

对这个数组中的对象进行随机排序。

方法实现

- (void)shuffle {
    for (NSUInteger i = self.count; i > 1; i--) {
        [self exchangeObjectAtIndex:(i - 1)
                  withObjectAtIndex:arc4random_uniform((u_int32_t)i)];
    }
}

后记

本篇主要介绍了NSMutableArray分类，感兴趣给个赞或者关注~~~