【iOS】—— Foundation框架（五）- 字典（NSDictionary与NSMutableDictionary）

7.8 字典（NSDictionary与NSMutableDictionary）

NSDictionary用于保存具有映射关系的数据，因此，NSDictionary集合里保存着两组值，一组值用于保存NSDictionary里的key，另一组值用于保存NSDictionary里的value。

注意：key和value都可以是任何引用类型的数据，Map的key不允许重复。

key和value之间存在单向一对一关系，即通过指定的key，总能找到唯一的、确定的value。

从NSDictionary中取出数据时，只要给出指定的key，就可以取出对应的value。

key和value之间的关系：

从图中可以看出，如果把NSDictionary里的所有key放在一起，它们就组成了一个Set集合（即所有的key没有顺序，且key与key之间不能重复），实际上，NSDictionary包含了一个allKeys方法，用于返回NSDictionary所有key组成的集合。但是，NSDictionary把allKeys方法的返回值设为NSArray——这说明该方法经过了进一步转换，它已经把NSSet集合转换成了NSArray集合。

---

7.8.1 NSDictionary的功能和用法

NSDictionary集合由多组key-value对组成，因此创建NSDictionary时需要同时指定多组key、value对。NSDictionary分别提供了类方法和实例方法来创建NSDictionary，两种创建方式需要传入的参数基本相似，只是类方法以dictionary开始，而实例方法则以init开头。

创建NSDictionary对象的几类常见方法：

• dictionary：创建一个不包含任何key-value对的NSDictionary。
• dictionaryWithContentsOfFile:/initWithContentsOfFile:：读取指定文件的内容，使用指定的文件内容来初始化NSDictionary。该文件通常是由NSDictionary自己输出生成的。
• dictionaryWithDictionary:/initWithDictionary:：使用已有的NSDictionary包含的key-value对来初始化NSDictionary对象。
• dictionaryWithObject:forKey:：使用单个key-value对来创建NSDictionary对象。
• dictionaryWithObjects:forKeys:/initWithObjects:forKeys:：使用两个NSArray分别指定key、value集合，可以创建包含多组key-value对的NSDictionary.
• dictionaryWithObjectsAndKeys:/initWithObjectsAndKeys:：调用该方法时，需要按value1，key1，value2，key2，…，nil的格式传入多个key-value对。

访问NSDictionary集合所包含的key或vlaue的方法：

• count：该方法返回该NSDictionary所包含的key-value对的数量。
• allKeys：该方法返回该NSDictionary所包含的全部key。
• allKeysForObject:：该方法返回指定value对应的全部key。
• allValues：该方法返回该NSDictionary所包含的全部value。
• objectForKey:：该方法获取该NSDictionary中指定key对应的value。
• objectForKeyedSubscript:：通过该方法的支持，允许NSDictionary通过下标法来获取指定key对应的value。
• valueForKey:：该方法获取该NSDictionary中指定key对应的value。
• keyEnumerator：该方法返回用于遍历该NSDictionary所有key的NSEnumerator对象。
• objectEnumerator：该方法返回用于遍历该NSDictionary所有value的NSEnumerator对象。
• enumerateKeysAndObjectsUsingBlock:：使用指定的代码块来迭代执行该集合中所有的key-value对。
• enumerateKeysAndObjectsWithOptions:usingBlock:：使用指定的代码块来迭代执行该集合中所有的key-value对。该方法可以传入一个额外的NSEnumerationOptions参数。
• writeToFile:atomically:：将该NSDictionary对象的数据写入指定文件。

通过key来获取value的语法：

• 调用NSDictionary的objectForKey：方法即可根据key来获取对应的value。
• 直接使用下标法根据key来获取对应的value。

[dictionary objectForKey:key];
dictionary[key];
这两个是相同的

当程序调用dictionary[key]下标形式的语法来获取value时，实际上就是调用NSDictionary的objectForKeyedSubscript：方法进行访问。

NSDictionary的功能和用法：

为了能够直接看到NSDictionary中包含的key-value对的详细，扩展了一个print类别，在该类别中为NSDictionary扩展了print方法，用于打印NSDictionary中key-value对的详情：

#import <Foundation/Foundation.h>

NS_ASSUME_NONNULL_BEGIN

@interface NSDictionary (print)
- (void) print;
@end

NS_ASSUME_NONNULL_END


#import "NSDictionary+print.h"

@implementation NSDictionary (print)
- (void) print {
    NSMutableString* result = [NSMutableString stringWithString:@"{"];
    //使用快速枚举语法来遍历NSDictionary，
    //循环计数器将依次等于该NSDictionary的每个key
    for (id key in self) {
        [result appendString:[key description]];
        [result appendString:@"="];
        [result appendString:[self[key] description]];
        [result appendString:@","];
    }
    NSUInteger len = [result length];
    [result deleteCharactersInRange:NSMakeRange(len - 1, 1)];
    [result appendString:@"}"];
    NSLog(@"%@", result);
}
@end

上面的程序示范来NSDictionary的两个基本用法，程序可以使用快速枚举来遍历NSDictionary的所有key。

FKUser类：

#import <Foundation/Foundation.h>

NS_ASSUME_NONNULL_BEGIN

@interface FKUser : NSObject
@property (nonatomic, copy) NSString* name;
@property (nonatomic, copy) NSString* pass;
- (id) initWithName: (NSString*) aName pass: (NSString*) aPass;
- (void) say: (NSString*) content;
@end

NS_ASSUME_NONNULL_END


#import "FKUser.h"

@implementation FKUser
@synthesize name;
@synthesize pass;
- (id) initWithName:(NSString *) aName pass:(NSString *) aPass {
    if (self = [super init]) {
        self.name = aName;
        self.pass = aPass;
    }
    return self;
}
- (void) say:(NSString *) content {
    NSLog(@"%@说:%@", self.name, content);
}
//重写isEqual:方法，重写该方法的比较标准是，
//如果两个FKUser的name、pass相等，即可认为它们相等
- (BOOL) isEqual: (id) other {
    if (self == other) {
        return  YES;
    }
    //如果两个的类是相同的话就进入
    if ([other class] == FKUser.class) {
        FKUser* target = (FKUser*)other;
        return [self.name isEqualToString:target.name]
        && [self.pass isEqualToString:target.pass];
    }
    return  NO;
}
//重写description方法，可以直接看到FKUser对象的状态
- (NSString*) description {
    return [NSString stringWithFormat:
            @"<FKUser[name = %@, pass = %@]>"
            , self.name, self.pass];
}

//重写Hash方法，重写该方法的比较标准是，
//如果两个FKUser的name、pass相等，两个FKUser的Hash方法返回值相等
- (NSUInteger) hash {
    NSLog(@"===hash===");
    NSUInteger nameHash = name == nil ? 0 : [name hash];
    NSUInteger passHash = pass == nil ? 0 : [pass hash];
    return nameHash * 31 + passHash;
}
@end

主函数的使用：

#import <Foundation/Foundation.h>
#import "NSDictionary+print.h"
#import "FKUser.h"

int main(int argc, char* argv[]) {
    @autoreleasepool {
        //直接使用多个value，key的形式创建NSDictionary对象
        NSDictionary* dict = [NSDictionary
                              dictionaryWithObjectsAndKeys:
                              [[FKUser alloc] initWithName:@"sun" pass:@"123"], @"one",
                              [[FKUser alloc] initWithName:@"bai" pass:@"345"], @"two",
                              [[FKUser alloc] initWithName:@"sun" pass:@"123"], @"three",
                              [[FKUser alloc] initWithName:@"tang" pass:@"178"], @"four",
                              [[FKUser alloc] initWithName:@"niu" pass:@"155"], @"five", nil];
        [dict print];
        NSLog(@"dict包含%ld个key-value对", [dict count]);
        NSLog(@"dict的所有key为：%@", [dict allKeys]);
        NSLog(@"<FKUser[name = sun, pass = 123]>对应的所有key为：%@",
              [dict allKeysForObject:[[FKUser alloc] initWithName:@"sun" pass:@"123"]]);
        //获取遍历dict所有value的枚举器
        NSEnumerator* en = [dict objectEnumerator];
        NSObject* value;
        //使用枚举器遍历dict中所有value
        while (value = [en nextObject]) {
            NSLog(@"%@", value);
        }
        //使用指定代码块迭代执行该集合中所有key-value对
        [dict enumerateKeysAndObjectsUsingBlock:
         //该集合包含多个key-value对，下面的代码块就执行相应的次数
         ^(id key, id value, BOOL* stop) {
            NSLog(@"key的值为：%@", key);
            [value say:@"疯狂iOS讲义"];
        }];
    }
    return 0;
}

输出结果为：

---

7.8.2 对NSDictionary的key排序

NSDictionary还提供了方法对NSDictionary的所有key执行排序，这些方法执行完成后将放回排序完成后的所有key组成的NSArray。

NSDictionary提供的对key的排序方法：

• keysSortedByValueUsingSelecotor:：根据NSDictionary的所有value的指定方法的返回值对key排序；调用value的该方法必须返回NSOederedAscending、NSOrderedDescending、NSOrderedSame这三个值之一。
• keysSortedByValueUsingComparator:：该方法使用指定的代码块来遍历key-value对，并根据执行结果（执行结果必须返回NSOederedAscending、NSOrderedDescending、NSOrderedSame这三个值之一）对NSDictionary的所有key进行排序。
• keysSortedByValueWithOptions:usingComparator:：与前一个方法的功能相似，只是该方法可以传入一个额外的NSEnumerationOptions参数。

NSDictionary的key排序实例：

#import <Foundation/Foundation.h>
#import "NSDictionary+print.h"
int main(int argc, char* argv[]) {
    @autoreleasepool {
        //直接使用多个value，key的形式创建NSDictionary对象
        NSDictionary* dict = [NSDictionary
                              dictionaryWithObjectsAndKeys:
                              @"Objective-C", @"one",
                              @"Ruby", @"two",
                              @"Python", @"three",
                              @"Per", @"four", nil];
        //打印dict集合的所有元素
        [dict print];
        //获取所有直接调用value的compare:方法对所有的key进行排序
        //返回排好序的所有key组成的NSArray
        NSArray* keyArr1 = [dict keysSortedByValueUsingSelector:@selector(compare:)];
        NSLog(@"%@", keyArr1);
        NSArray* keyArr2 = [dict keysSortedByValueUsingComparator:
                            //对NSDictionary的value进行比较，字符串越长，即可认为该value越大
                            ^(id value1, id value2) {
            if ([value1 length] > [value2 length]) {
                return NSOrderedDescending;
            }
            if ([value1 length] < [value2 length]) {
                return NSOrderedAscending;
            }
            return NSOrderedSame;
        }];
        NSLog(@"%@", keyArr2);
        //将NSDictionary的内容输入到指定文件中
        [dict writeToFile:@"myDict.txt" atomically:YES];
    }
    return 0;
}

输出结果为：

该程序使用了两种排序方法，第一种根据字符串编码进行判断，第二种根据字符串长度进行判断。

搜索储存到的文件夹，打开可以看到：

---

7.8.3 对NSDictionary的key进行过滤

NSDictionary还提供了方法对NSDictionary的所有key进行过滤，这些方法执行完成后返回满足过滤条件的key组成的NSSet。

NSDictionary的过滤方法：

• keysOfEntriesPassingTest:：使用代码块迭代处理NSDictionary的每个key-value对。对NSDictionary的key-value进行过滤，该代码块必须返回BOOL类型的值，只有当该代码块返回YES时，该key才会被保留下来；该代码块可以接受三个参数，第一个参数代表正在迭代处理的key，第二个参数代表正在迭代处理的value，第三个参数代表是否还需要继续迭代，如果将第三个参数设为NO，该方法就会立即停止迭代。
• keysOfEntriesWithOptions:passingTest:：该方法的功能与前一个方法的功能基本相同。只是该方法可以额外传入一个附加的NSEnumerationOptions选项参数。

对NSDictionary进行过滤：

#import <Foundation/Foundation.h>
#import "NSDictionary+print.h"
int main(int argc, char* argv[]) {
    @autoreleasepool {
        //直接使用多个value，key的形式创建NSDictionary对象
        NSDictionary* dict = [NSDictionary
                              dictionaryWithObjectsAndKeys:
                              [NSNumber numberWithInt:89], @"Objective-C",
                              [NSNumber numberWithInt:69], @"Ruby",
                              [NSNumber numberWithInt:75], @"Python",
                              [NSNumber numberWithInt:109], @"Perl", nil];
        //打印dict集合的所有元素
        [dict print];
        //对NSDictionary的所有key进行过滤
        NSSet* keySet = [dict keysOfEntriesPassingTest:
                         //对NSDictionary的value进行比较，字符串越长，即可认为该value越大
                         ^(id key, id value, BOOL* stop) {
            //当value的值大于80时返回YES
            //这意味着只有value的值大于80的key才会被保留下来
            return (BOOL)([value intValue] > 80);
        }];
        NSLog(@"%@", keySet);
    }
    return 0;
}

输出结果为：

上面程序使用代码块对NSDictionary的key-value对进行迭代处理，代码块的判断标准是，只有当value的值大于80时才会返回YES，这表明只有当value的值大于80时，才会保留对应的key。

---

7.8.4 使用自定义类作为NSDictionary的key

前面NSDictionary的key都是NSString类型。

自定义类作为key的要求：

• 该自定义类正确重写过isEqual:和hash方法。所谓正确重写，是指当两个对象通过isEqual:方法判断相等时，两个对象的Hash方法返回值也相等。
• 该自定义类必须实现了copyWithZone:方法，该方法最好能返回对象的不可变副本。

NSDictionary为何要求自定义key类必须实现copyWithZone:方法（最好能让该类实现NSCopying协议）呢？

这是因为NSDictionary处于安全性的考虑。当程序把多个key-value放入NSDictionary集合之后，对于NSDictionary而言，key是非常关键的，NSDictionary需要根据key来访问value——从这个意义上看，key相当于NSDictionary元素的索引。如果key本身是可变的，且程序可以通过其他变量来修改NSDictionary的key，这就可能导致NSDictionary的“索引”值被破坏，从而导致NSDictionary的完整性被破坏。

所以，为了避免上面描述的情况出现，NSDictionary采用了更安全的做法，只要程序把任何对象都作为key放入NSDictionary时，NSDictionary总会先调用该key的copy方法来复制该对象的不可变副本，然后使用该副本作为NSDictionary的key。

FKUser实现copyWithZone:方法如下：

为了让前面的FKUser类可作为NSDictionary的key，还需要让该FKUser类实现NSCopying协议（这是可选的，通常建议实现该协议），并让该FKUser类实现copyWithZone:方法。

FKUser的实现部分补充：

- (id) copyWithZone: (NSZone*) zone {
    NSLog(@"---正在复制---");
    //复制一个对象
    FKUser* newUser = [[[self class] allocWithZone:zone] init];
    //将被复制对象的实变量的值赋给新对象的实例变量
    newUser->name = name;
    newUser->pass = pass;
    return newUser;
}

FKUser对象作为NSDictionary的key，程序如下：

#import <Foundation/Foundation.h>
#import "NSDictionary+print.h"
#import "FKUser.h"
int main(int argc, char* argv[]) {
    @autoreleasepool {
        FKUser* u1 = [[FKUser alloc] initWithName:@"bai" pass:@"345"];
        //直接使用多个value，key的形式创建NSDictionary对象
        NSDictionary* dict = [NSDictionary
                              dictionaryWithObjectsAndKeys:
                              @"one", [[FKUser alloc] initWithName:@"sun" pass:@"123"],
                              @"two", u1,
                              @"three", [[FKUser alloc] initWithName:@"sun" pass:@"123"],
                              @"four", [[FKUser alloc] initWithName:@"tang" pass:@"178"],
                              @"five", [[FKUser alloc] initWithName:@"miu" pass:@"155"],nil];
        //将u1的密码设为nil
        u1.pass = nil;
        //由于NSDictioneary并未直接使用u1所指向的FKUser作为key，
        //而是先复制了u1所指向对象的副本，然后以该副本作为key，
        //因此程序将可以看到dict的key不会收到任何影响
        [dict print];
    }
    return 0;
}

当程序使用任何对象作为key时，会先调用copy方法来复制该key的不可变副本（即它不会将该地址的值传给NSDictionary对象，而是先进行copy不可修改的复制，再把新复制的地址传给NSDictionary对象），实际上是以该副本作为NSDictionary的key。因此，上面程序对u1的pass进行修改，NSDictionary的所有key并不会受到任何影响。

输出结果为：

从上面的输出结果可以看到，程序依次调用了4次copyWithZone:方法来复制FKUser的副本，这是因为该NSDictionary中只包含了4个key-value对。虽然程序指定了5个key-value对，但其中有两个key（FKUser对象）的name、pass完全相同，这两个对象通过isEqual:比较会返回YES，并且它们的Hash方法返回值也相等，因此NSDictionary会认为这两个key是重复的，就只会保留一个。

---

7.8.5 NSMutableDictionary的功能与用法

NSMutableDictionary继承了NSDictionary，它代表一个key-value可变的NSDictionary集合。由于NSMutableDictionary可以动态添加key-value对，因此，创建NSMutableDictionary集合时可指定初始容量。

类似于NSMutableArray与NSArray的关系，NSMutableDictionary主要在NSDictionary基础上增加了添加key-value对、删除key-value对的放法。

NSMutableDictionary新增的方法：

• setobject:forKey：设置一个key-value对。如果NSDictionary中没有包含于该key相同的key-value，NSDictionary将会新增一个key-value对；否则该key-value将会覆盖已有的key-value对。
• setObject:forKeyedSubscript:：通过该方法的支持，允许程序通过下标法来设置key-value对。
• addEntriesFromDictionary:：将另一个NSDictionary中所有的key-value对复制到当前NSDictionary中。
• setDictionary:：用另一个NSDictionary中所有的key-value对替换当前NSDictionary中的key-value对。
• removeObjectForKey:：根据key来删除key-value对。
• removeAllObjects：清空该NSDictionary。
• removeObjectsForKeys:：使用多个key组成的NSArray作为参数，同时删除多个key对应的key-value对。

使用方法来动态改变NSMutableDictionary中的key-value对：

#import <Foundation/Foundation.h>
#import "NSDictionary+print.h"
int main(int argc, char* argv[]) {
    @autoreleasepool {
        //直接使用多个value，key的形式创建NSDictionary对象
        NSMutableDictionary* dict = [NSMutableDictionary
                                     dictionaryWithObjectsAndKeys:
                                     [NSNumber numberWithInt:89], @"疯狂iOS讲义",  nil];
        //使用下标法设置key-value对。由于NSDictionary中已存在该key，
        //因此此处设置的value会覆盖前面的value
        dict[@"疯狂Android讲义"] = [NSNumber numberWithInt:99];
        [dict print];
        NSLog(@"---再次添加key-value对---");
        dict[@"疯狂XML讲义"] = [NSNumber numberWithInt:69];
        [dict print];
        NSDictionary* dict2 = [NSDictionary
                               dictionaryWithObjectsAndKeys:
                               [NSNumber numberWithInt:79], @"疯狂Ajax讲义",
                               [NSNumber numberWithInt:89], @"Struts 2.x权威指南", nil];
        //将另一个NSDictionary中的key-value对添加到当前NSDictionary中
        [dict addEntriesFromDictionary:dict2];
        [dict print];
        //根据key来删除key-value对
        [dict removeObjectForKey:@"Struts 2.x权威指南"];
        [dict print];
    }
    return 0;
}

输出结果为：