天天看點

【iOS】—— Foundation架構(五)- 字典(NSDictionary與NSMutableDictionary)7.8 字典(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之間的關系:

【iOS】—— Foundation架構(五)- 字典(NSDictionary與NSMutableDictionary)7.8 字典(NSDictionary與NSMutableDictionary)
從圖中可以看出,如果把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;
}
           

輸出結果為:

【iOS】—— Foundation架構(五)- 字典(NSDictionary與NSMutableDictionary)7.8 字典(NSDictionary與NSMutableDictionary)
【iOS】—— Foundation架構(五)- 字典(NSDictionary與NSMutableDictionary)7.8 字典(NSDictionary與NSMutableDictionary)

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

輸出結果為:

【iOS】—— Foundation架構(五)- 字典(NSDictionary與NSMutableDictionary)7.8 字典(NSDictionary與NSMutableDictionary)
該程式使用了兩種排序方法,第一種根據字元串編碼進行判斷,第二種根據字元串長度進行判斷。

搜尋儲存到的檔案夾,打開可以看到:

【iOS】—— Foundation架構(五)- 字典(NSDictionary與NSMutableDictionary)7.8 字典(NSDictionary與NSMutableDictionary)

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

輸出結果為:

【iOS】—— Foundation架構(五)- 字典(NSDictionary與NSMutableDictionary)7.8 字典(NSDictionary與NSMutableDictionary)

上面程式使用代碼塊對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并不會受到任何影響。

輸出結果為:

【iOS】—— Foundation架構(五)- 字典(NSDictionary與NSMutableDictionary)7.8 字典(NSDictionary與NSMutableDictionary)
從上面的輸出結果可以看到,程式依次調用了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;
}
           

輸出結果為:

【iOS】—— Foundation架構(五)- 字典(NSDictionary與NSMutableDictionary)7.8 字典(NSDictionary與NSMutableDictionary)