NSDictionary底层实现原理

NSDictionary介绍

NSDictionary(字典)是使用 hash表来实现key和value之间的映射和存储的, hash函数设计的好坏影响着数据的查找访问效率。数据在hash表中分布的越均匀,其访问效率越高。而在Objective-C中,通常都是利用NSString 来作为键值,其内部使用的hash函数也是通过使用 NSString对象作为键值来保证数据的各个节点在hash表中均匀分布。

NSDictionary内部结构

NSDictionary使用NSMapTable实现,NSMapTable同样是一个key-value的容器。

typedef struct {
   NSMapTable        *table;
   NSInteger          i;
   struct _NSMapNode *j;
} NSMapEnumerator;

上述结构体描述了遍历一个NSMapTable时的一个指针对象,其中包含table对象自身的指针,计数值,和节点指针。

typedef struct {
   NSUInteger (*hash)(NSMapTable *table,const void *);
   BOOL (*isEqual)(NSMapTable *table,const void *,const void *);
   void (*retain)(NSMapTable *table,const void *);
   void (*release)(NSMapTable *table,void *);
   NSString  *(*describe)(NSMapTable *table,const void *);
   const void *notAKeyMarker;
} NSMapTableKeyCallBacks;

上述结构体中存放的是几个函数指针,用于计算key的hash值,判断key是否相等,retain,release操作。

typedef struct {
   void       (*retain)(NSMapTable *table,const void *);
   void       (*release)(NSMapTable *table,void *);
   NSString  *(*describe)(NSMapTable *table, const void *);
} NSMapTableValueCallBacks;

上述存放的三个函数指针,定义在对NSMapTable插入一对key-value时,对value对象的操作。

@interface NSMapTable : NSObject {
   NSMapTableKeyCallBacks   *keyCallBacks;
   NSMapTableValueCallBacks *valueCallBacks;
   NSUInteger             count;
   NSUInteger             nBuckets;
   struct _NSMapNode  **buckets;
}

可以看出来NSMapTable是一个哈希+链表的数据结构,因此在NSMapTable中插入或者删除一对对象时,
寻找的时间是O(1)+O(m),m最坏时可能为n。

  • O(1):为对key进行hash得到bucket的位置
  • O(m):遍历该bucket后面冲突的value,通过链表连接起来。

因此NSDictionary中的Key-Value遍历时是无序的,至如按照什么样的顺序,跟hash函数相关。NSMapTable使用NSObject的哈希函数。

- (NSUInteger)hash {
   return (NSUInteger)self>>4;
}

上述是NSObject的哈希值的计算方式,简单通过移位实现。右移4位,左边补0。因为对象大多存于堆中,地址相差4位应该很正常。

NSDictionary使用

NSDictionary的Key值

NSDictionary中最常用的一个方法原型:

- (void)setObject:(id)anObject forKey:(id <NSCopying>)aKey;  

从这个方法中可以知道,要作为Key值,必须遵循NSCopying协议。也就是说在NSDictionary内部,会对aKey对象Copy一份新的。而anObject 对象在其内部是作为强引用(retain或strong)。所以在MRC下,向该方法发送消息之后,我们会向anObject发送release消息进行释放。

既然知道了作为key值,必须遵循NSCopying协议,说明除了NSString对象之外,我们还可以使用其他类型对象来作为NSDictionary的 key值。不过这还不够,作为key值,该类型还必须继承于NSObject并且要重载一下两个方法:

- (NSUInteger)hash;  
- (BOOL)isEqual:(id)object;  

其中,hash 方法是用来计算该对象的 hash 值,最终的 hash 值决定了该对象在 hash 表中存储的位置。所以同样,如果想重写该方法,我们尽量设计一个能让数据分布均匀的 hash 函数。

所以如果对象key的hash值相同,那在hash表里面的对应的value值是相同的(value值被更新了)

isEqual方法是为了通过hash值来找到对象在hash表中的位置。

KeyObject.h文件:

//
//  KeyObject.h
//  testD
//
//  Created by jackyshan on 2018/5/22.
//  Copyright © 2018年 GCI. All rights reserved.
//

#import <Foundation/Foundation.h>

@interface KeyObject : NSObject<NSCopying>//实现Copying协议

- (instancetype)initWithHashI:(NSUInteger)i;

@end

KeyObject.m文件

//
//  KeyObject.m
//  testD
//
//  Created by jackyshan on 2018/5/22.
//  Copyright © 2018年 GCI. All rights reserved.
//

#import "KeyObject.h"

@interface KeyObject() {
    NSUInteger _hashValue;
}

@end

@implementation KeyObject

- (instancetype)initWithHashI:(NSUInteger)i {
    if (self = [super init]) {
        _hashValue = i;
    }
    
    return self;
}

#pragma mark - overload method

- (BOOL)isEqual:(id)object {
    //根据hash值判断是否是同一个键值
    return ([self hashKeyValue] == [(typeof(self))object hashKeyValue]);
}

- (NSUInteger)hash {
    //返回hash值
    return [self hashKeyValue];
}

#pragma mark - NSCopying
- (id)copyWithZone:(NSZone *)zone {
    KeyObject *obj = [KeyObject allocWithZone:zone];
    obj->_hashValue = _hashValue;
    return obj;
}

#pragma mark - private method

- (NSUInteger)hashKeyValue {
    return _hashValue % 3;
}

@end

测试

//
//  main.m
//  testD
//
//  Created by jackyshan on 2018/5/22.
//  Copyright © 2018年 GCI. All rights reserved.
//

#import <Foundation/Foundation.h>
#import "KeyObject.h"

int main(int argc, const char * argv[]) {
    @autoreleasepool {
        // insert code here...
        
        NSMutableDictionary *dic = [NSMutableDictionary dictionary];
        
        KeyObject *key1 = [[KeyObject alloc] initWithHashI:1];
        [dic setObject:@"key1value" forKey:key1];
        
        KeyObject *key2 = [[KeyObject alloc] initWithHashI:4];
        [dic setObject:@"key2value" forKey:key2];
        
        KeyObject *key3 = [[KeyObject alloc] initWithHashI:8];
        [dic setObject:@"key3value" forKey:key3];
        
        NSLog(@"key1--->%@", [dic objectForKey:key1]);
        NSLog(@"key2--->%@", [dic objectForKey:key2]);
        NSLog(@"key3--->%@", [dic objectForKey:key3]);
        
        NSLog(@"allKeys--->%@", [dic allKeys]);
        NSLog(@"allValues--->%@", [dic allValues]);
    }
    return 0;
}

打印结果:
2018-05-22 15:40:06.429379+0800 testD[6350:1441941] key1--->key1value
2018-05-22 15:40:06.454114+0800 testD[6350:1441941] key2--->key2value
2018-05-22 15:40:06.454137+0800 testD[6350:1441941] key3--->key3value
2018-05-22 15:40:06.454634+0800 testD[6350:1441941] allKeys--->(
"<KeyObject: 0x100403440>",
"<KeyObject: 0x100406b10>"
)
2018-05-22 15:40:06.454779+0800 testD[6350:1441941] allValues--->(
key2value,
key3value
)
Program ended with exit code: 0

从打印结果来看,key1和key2对象的hash值是一样的,所以他们value是相等的,key1的value被key2更新了。

NSDictionary的KVC实现

@implementation NSDictionary (NSKeyValueCoding)
- (id)valueForKey:(NSString*)key {
    if([key hasPrefix:@"@"])
        return [super valueForKey:[key substringFromIndex:1]];
    return [self objectForKey:key];
}

- (void)setValue:(id)value forKey:(NSString*)key {
    [NSException raise:NSInvalidArgumentException format:@"%@ called on immutable dictionary %@", NSStringFromSelector(_cmd), self];
}

@end


@implementation NSMutableDictionary (NSKeyValueCoding)

- (void)setValue:(id)value forKey:(NSString*)key {
    if(value)
        [self setObject:value forKey:key];
    else
        [self removeObjectForKey:key];
}

@end
  • setValue和setObject的区别
- (void)setObject:(ObjectType)anObject forKey:(KeyType <NSCopying>)aKey;
- (void)setValue:(nullable ObjectType)value forKey:(NSString *)key;

setObject: ForKey:是NSMutableDictionary特有的;setValue: ForKey:是KVC的主要方法。

(1) setValue: ForKey:的value是可以为nil的(但是当value为nil的时候,会自动调用removeObject:forKey方法);
setObject: ForKey:的value则不可以为nil。
(2) setValue: ForKey:的key必须是不为nil的字符串类型;

setObject: ForKey:的key可以是不为nil的所有继承NSCopying的类型。

关注我

欢迎关注公众号:jackyshan,技术干货首发微信,第一时间推送。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,847评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,208评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,587评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,942评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,332评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,587评论 1 218
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,853评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,568评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,273评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,542评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,033评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,373评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,031评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,073评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,830评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,628评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,537评论 2 269

推荐阅读更多精彩内容