Objective-C環境下的靜態陣列實現

自定義靜態陣列的原因

就一個原因吧，Objective-C這傢伙沒有，只能自己搞一個。

內部的實現方案

建立一個陣列物件JKRArray，直接繼承自NSObject。 首先自定義陣列應該和Objective-C原生語言環境相匹配，那麼我們的靜態陣列也是應該和NSArray一樣，存放物件的指標，唯一的區別就是，自定義靜態陣列需要指定長度初始化，並且初始化之後是一個空陣列，並且可以在陣列長度範圍內的任意位置直接通過下標插入和取出元素，比如初始化一個長度為3的陣列後，陣列的內部結構應該是：

[nil, nil, nil]
複製程式碼

直接通過下標在array[1]插入一個@1後，陣列的內部結構應該是：

[nil, 1, nil]
複製程式碼

由於陣列需要儲存物件的指標，而且由於功能限制，內部必須要自己靜態陣列來存放指標，而Objective-C沒有這種功能，我們就只能夠通過C++的陣列來實現。將JKRArray.m檔案改為JKRArray.mm，在專案的TARGETS-BuildPhases-Compile Sources中將JKRArray.mm的Compiler Flags新增-fno-objc-arc。

物件的封裝

這裡儘量模仿Objective-C官方語言的介面設計風格，來達到便於記憶介面，方便使用的目的。

{
@protected
    void ** _array;
    NSUInteger _length;
}

- (instancetype)init __unavailable;
+ (instancetype)new __unavailable;

+ (instancetype)arrayWithLength:(NSUInteger)length;

- (instancetype)initWithLength:(NSUInteger)length;
- (NSUInteger)length;
- (void)setObject:(nullable ObjectType)object AtIndex:(NSUInteger)index;
- (nullable ObjectType)objectAtIndex:(NSUInteger)index;
- (void)removeObjectAtIndex:(NSUInteger)index;
- (NSUInteger)indexOfObject:(nullable ObjectType)object;
- (BOOL)containsObject:(ObjectType)object;

@end

@interface JKRArray<ObjectType> (JKRExtendedArray)

- (void)enumerateObjectsUsingBlock:(void (^)(_Nullable ObjectType obj, NSUInteger idx, BOOL *stop))block;
- (_Nullable ObjectType)objectAtIndexedSubscript:(NSUInteger)idx;
- (void)setObject:(_Nullable ObjectType)obj atIndexedSubscript:(NSUInteger)idx;

@end

@interface JKRArray<ObjectType> (NSGenericFastEnumeraiton) <NSFastEnumeration>

- (NSUInteger)countByEnumeratingWithState:(NSFastEnumerationState *)state objects:(id __unsafe_unretained _Nullable [_Nonnull])buffer count:(NSUInteger)len;

@end
複製程式碼

介面的定義和功能，都和官方的NSArray全部保持一致，所以大部分介面就不解釋了，這裡逐一說明一些NSArray存在單又不常用的和我們自定義的介面。

{
// 以下兩個成員變數的訪問許可權設定私有，因為它們不應該被更改
@private
    // 指標陣列，存放是加入到陣列中物件的指標
    void ** _array;
    // 陣列的長度
    NSUInteger _length;
}

// 以下定義是為了讓我們的陣列只能夠通過指定長度來建立，因為靜態資料必須要指定長度
- (instancetype)init __unavailable;
+ (instancetype)new __unavailable;
+ (instancetype)arrayWithLength:(NSUInteger)length;
- (instancetype)initWithLength:(NSUInteger)length;
/// 以下兩個方法的宣告和實現是為了讓我們自定義的陣列類能夠實現通過[]取值和賦值，例如id obj = array[10]、array[3] = [NSObject new]。
- (_Nullable ObjectType)objectAtIndexedSubscript:(NSUInteger)idx;
- (void)setObject:(_Nullable ObjectType)obj atIndexedSubscript:(NSUInteger)idx;

// <NSFastEnumeration>協議和這個方法是為了實現 for in 快速遍歷
- (NSUInteger)countByEnumeratingWithState:(NSFastEnumerationState *)state objects:(id __unsafe_unretained _Nullable [_Nonnull])buffer count:(NSUInteger)len;
複製程式碼

介面實現

初始化介面實現

初始化的同時，建立一個指標陣列，長度為初始化方法傳入的length。

#pragma mark - 初始化
+ (instancetype)arrayWithLength:(NSUInteger)length {
    // 手動管理類方法建立物件需要呼叫autorelease
    return [[[self alloc] initWithLength:length] autorelease];
}

- (instancetype)initWithLength:(NSUInteger)length {
    self = [super init];
    _length = length;
    // 建立一個指標陣列
    _array = new void*[length]();
    return self;
}
複製程式碼

邊界檢查

先封裝一個方法，用於所有關於index操作的方法執行前，先檢查時候越界

#pragma mark - 邊界檢查
- (void)checkRangeWithIndex:(NSUInteger)index {
    if (index < 0 || index >= _length) NSAssert(NO, @"Index: %zd, Length: %zd", index, _length);
}
複製程式碼

在index位置新增元素

時間複雜度：O(1)

#pragma mark - 新增元素
- (void)setObject:(id)object AtIndex:(NSUInteger)index {
    // 檢查傳入的index是否超過陣列的範圍
    [self checkRangeWithIndex:index];
    // 先獲取index位置原來存放的元素
    id oldObject = [self objectAtIndex:index];
    // 如果新增的元素和原來的元素一樣，則直接返回。
    if (oldObject == object) return;
    // 如果新增的元素是新元素，則舊元素引用計數-1
    if (oldObject != nil) [oldObject release];
    // 新新增元素引用計數+1
    if (object) [object retain];
    // 新元素指標新增到陣列中
    *(_array + index) = (__bridge void *)object;
}
複製程式碼

通過index刪除元素

時間複雜度：O(1)

#pragma mark - 刪除元素
- (void)removeObjectAtIndex:(NSUInteger)index {
    // 檢查傳入的index是否超過陣列的範圍
    [self checkRangeWithIndex:index];
    // 將index位置元素取出
    id object = (__bridge id)(*(_array + index));
    // 如果該位置存放了元素，刪除引用計數-1（因為新增的時候+1）
    if (object) [object release];
    *(_array + index) = 0;
}
複製程式碼

通過index獲取元素

時間複雜度：O(1)

#pragma mark - 獲取元素
- (id)objectAtIndex:(NSUInteger)index {
    [self checkRangeWithIndex:index];
    // 直接在陣列指標中通過index取值即可
    id object = (__bridge id)(*(_array + index));
    return object;
}
複製程式碼

列舉所有元素

#pragma mark - 列舉
- (void)enumerateObjectsUsingBlock:(void (^)(id _Nullable, NSUInteger, BOOL * _Nonnull))block {
    BOOL stop = NO;
    // 遍歷長度範圍內的所有index取值
    for (NSUInteger i = 0; i < _length && !stop; i++) {
        id object = [self objectAtIndex:i];
        block(object, i, &stop);
    }
}
複製程式碼

獲取元素的index

時間複雜度：O(N)

#pragma mark - 元素在陣列中儲存的第一個下標
- (NSUInteger)indexOfObject:(id)object {
    // 如果找不到滿足條件的index，就返回NSUIntegerMax（這裡和NSArray處理一樣）
    __block NSUInteger index = NSUIntegerMax;
    // 通過遍歷，從index為0開始，找到第一個滿足的index
    [self enumerateObjectsUsingBlock:^(id  _Nullable obj, NSUInteger idx, BOOL * _Nonnull stop) {
        if (object == obj) {
            index = idx;
            *stop = YES;
        } else if ([object isEqual:obj]){
            index = idx;
            *stop = YES;
        } 
    }];
    return index;
}
複製程式碼

返回陣列是否包含某元素

時間複雜度：O(N)

#pragma mark - 是否包含
- (BOOL)containsObject:(id)object {
    // 檢視元素的index，如果index<_length則包含（不存在會index為NSUIntegerMax）
    NSUInteger index = [self indexOfObject:object];
    return index < _length;
}
複製程式碼

返回陣列長度

時間複雜度：O(1)

#pragma mark - 返回長度
- (NSUInteger)length {
    return _length;
}
複製程式碼

支援陣列運算子

#pragma mark - 支援陣列運算子
- (id)objectAtIndexedSubscript:(NSUInteger)idx {
    return [self objectAtIndex:idx];
}

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

複製程式碼

支援 for in 快速遍歷

#pragma mark - 快速遍歷
- (NSUInteger)countByEnumeratingWithState:(NSFastEnumerationState *)state objects:(id  _Nullable [])buffer count:(NSUInteger)len {
    if (state->state > 0) return 0;
    state->mutationsPtr = (unsigned long*)self;
    NSUInteger retCount = state->extra[0];
    state->itemsPtr = (id *)(_array + state->extra[1]);
    if (retCount == 0) retCount = _length;
    if (retCount > len) {
        state->extra[0] = retCount - len;
        state->extra[1] += len;
        retCount = len;
    } else {
        state->state++;
    }
    return retCount;
}
複製程式碼

重寫dealloc

#pragma mark - dealloc
- (void)dealloc {
    // dealloc之前，要將處理記憶體在的元素引用計數還原(-1)，否則會造成記憶體洩漏
    for (NSUInteger i = 0; i < _length; i++) {
        id object = [self objectAtIndex:i];
        if (object) [object release];
    }
    delete _array;
    [super dealloc];
}
複製程式碼

重寫 description方法

我們要讓自定義陣列也能像NSArray一樣，有陣列形式的列印

- (NSString *)description {
    NSMutableString *mutableString = [NSMutableString string];
    [mutableString appendString:[NSString stringWithFormat:@"<%@: %p>: \nlength: %zd\n{\n", self.class, self, _length]];
    for (NSUInteger i = 0; i < _length; i++) {
        if (i) [mutableString appendString:@"\n"];
        id object = [self objectAtIndex:i];
        if (object) {
            [mutableString appendString:@"   "];
            [mutableString appendString:[object description]];
        } else {
            [mutableString appendString:@"   "];
            [mutableString appendString:@"Null"];
        }
    }
    [mutableString appendString:@"\n}"];
    return mutableString;
}
複製程式碼

測試功能

初始化測試

JKRArray *array = [JKRArray arrayWithLength:6];
NSLog(@"%@", array);

列印：
<JKRArray: 0x102107cb0>: 
length: 6
{
   Null
   Null
   Null
   Null
   Null
   Null
}
複製程式碼

插入測試

array[2] = [Person new];
NSLog(@"%@", array);

列印：
<JKRArray: 0x1006079f0>: 
length: 6
{
   Null
   Null
   <Person: 0x10286bc60>
   Null
   Null
   Null
}
複製程式碼

刪除測試

array[2] = nil;
NSLog(@"%@", array);

列印：
<Person: 0x100713400> dealloc
<JKRArray: 0x100607e20>: 
length: 6
{
   Null
   Null
   Null
   Null
   Null
   Null
}
複製程式碼

原始碼

點選檢視原始碼