本文Demo的完整工程代碼, 參考這里的EqualAndHashDemo

目錄
為什么要有isEqual方法?

如何重寫自己的isEqual方法?

為什么要有hash方法?

hash方法什么時(shí)候被調(diào)用?

hash方法與判等的關(guān)系?

如何重寫自己的hash方法?

為什么要有isEqual方法?

isEqual方法的作用大家肯定是知道的:

判斷兩個(gè)對(duì)象是否相等

但是判斷相等不是已經(jīng)有==運(yùn)算符了么, 為什么還要isEqual方法?
這是因?yàn)?

對(duì)于基本類型, ==運(yùn)算符比較的是值; 對(duì)于對(duì)象類型, ==運(yùn)算符比較的是對(duì)象的地址(即是否為同一對(duì)象)

注意: 上述==運(yùn)算符的說(shuō)明適用于Objective-C和Java等不支持運(yùn)算符重載的語(yǔ)言, 支持運(yùn)算符重載的語(yǔ)言有C++
所以要理清==運(yùn)算符和isEqual方法的區(qū)別, 問(wèn)題就集中在
什么叫比較對(duì)象的地址, 什么叫比較對(duì)象
我們通過(guò)下面的例子來(lái)說(shuō)明這個(gè)問(wèn)題

    UITapGestureRecognizer * tap = [[UITapGestureRecognizer alloc]initWithTarget:self action:@selector(tapClick)];
    [self.window addGestureRecognizer:tap];
    UIColor *color1 = [UIColor colorWithRed:0.5 green:0.5 blue:0.5 alpha:1.0];
    UIColor *color2 = [UIColor colorWithRed:0.5 green:0.5 blue:0.5 alpha:1.0];
    NSLog(@"color1 == color2 = %@", color1 == color2 ? @"YES" : @"NO");
    NSLog(@"[color1 isEqual:color2] = %@", [color1 isEqual:color2] ? @"YES" : @"NO");

打印結(jié)果如下

color1 == color2 = NO
[color1 isEqual:color2] = YES

從上面的例子可以看出, ==運(yùn)算符只是簡(jiǎn)單地判斷是否是同一個(gè)對(duì)象, 而isEqual方法可以判斷對(duì)象是否相同, 例如UIColor對(duì)象表示的color是否相同

如何重寫自己的isEqual方法?

對(duì)于Cocoa Framework中定義的類型, 例如上面例子中的UIColor, isEqual方法已經(jīng)實(shí)現(xiàn)好了

常見(jiàn)類型的isEqual方法還有NSString isEqualToString / NSDate isEqualToDate / NSArray isEqualToArray / NSDictionary isEqualToDictionary / NSSet isEqualToSet, 更多參考Equality

但對(duì)于自定義類型來(lái)說(shuō), 通常需要重寫isEqual方法
通過(guò)下面的例子, 我們來(lái)看看重寫isEqual方法的正確姿勢(shì)

首先定義Person類如下

    @interface Person : NSObject
    
    @property (nonatomic, copy) NSString *name;
    @property (nonatomic, strong) NSDate *birthday;
    
    @end

Person類中實(shí)現(xiàn)的isEqual方法如下

    - (BOOL)isEqual:(id)object {
        if (self == object) {
            return YES;
        }
        
        if (![object isKindOfClass:[Person class]]) {
            return NO;
        }
        
        return [self isEqualToPerson:(Person *)object];
    }
    
    - (BOOL)isEqualToPerson:(Person *)person {
        if (!person) {
            return NO;
        }
        
        BOOL haveEqualNames = (!self.name && !person.name) || [self.name isEqualToString:person.name];
        BOOL haveEqualBirthdays = (!self.birthday && !person.birthday) || [self.birthday isEqualToDate:person.birthday];
        
        return haveEqualNames && haveEqualBirthdays;
    }

上述代碼主要步驟如下

• Step 1: ==運(yùn)算符判斷是否是同一對(duì)象, 因?yàn)橥粚?duì)象必然完全相同

• Step 2: 判斷是否是同一類型, 這樣不僅可以提高判等的效率, 還可以避免隱式類型轉(zhuǎn)換帶來(lái)的潛在風(fēng)險(xiǎn)

• Step 3: 通過(guò)封裝的isEqualToPerson方法, 提高代碼復(fù)用性

• Step 4: 判斷person是否是nil, 做參數(shù)有效性檢查

• Step 5: 對(duì)各個(gè)屬性分別使用默認(rèn)判等方法進(jìn)行判斷

• Step 6: 返回所有屬性判等的與結(jié)果

isEqual的實(shí)現(xiàn)并不復(fù)雜, 但是從代碼質(zhì)量(效率, 安全, 復(fù)用)來(lái)說(shuō), 上述實(shí)現(xiàn)仍然值得仔細(xì)學(xué)習(xí)和借鑒
除了上面的最佳實(shí)踐, 還有一種最不佳實(shí)踐

 @implementation NSDate (Approximate)
    
    - (BOOL)isEqual:(id)object {
        return YES;
    }
    
    @end

這里的isEqual方法一直返回YES

NSLog(@"[self.date1 isEqual:@\"hello\"] = %@", [self.date1 isEqual:@"hello"] ? @"YES" : @"NO");

打印結(jié)果如下

[self.date1 isEqual:@"hello"] = YES

這個(gè)有趣的實(shí)驗(yàn)說(shuō)明: 對(duì)象的判等可以完全由您決定, 即使兩個(gè)完全不同的對(duì)象

為什么要有hash方法?

這個(gè)問(wèn)題要從Hash Table這種數(shù)據(jù)結(jié)構(gòu)說(shuō)起
首先我們看下如何在數(shù)組中查找某個(gè)成員

• Step 1: 遍歷數(shù)組中的成員

• Step 2: 將取出的值與目標(biāo)值比較, 如果相等, 則返回該成員

在數(shù)組未排序的情況下, 查找的時(shí)間復(fù)雜度是O(array_length)
為了提高查找的速度, Hash Table出現(xiàn)了
當(dāng)成員被加入到Hash Table中時(shí), 會(huì)給它分配一個(gè)hash值, 以標(biāo)識(shí)該成員在集合中的位置
通過(guò)這個(gè)位置標(biāo)識(shí)可以將查找的時(shí)間復(fù)雜度優(yōu)化到O(1), 當(dāng)然如果多個(gè)成員都是同一個(gè)位置標(biāo)識(shí), 那么查找就不能達(dá)到O(1)了
重點(diǎn)來(lái)了:

分配的這個(gè)hash值(即用于查找集合中成員的位置標(biāo)識(shí)), 就是通過(guò)hash方法計(jì)算得來(lái)的, 且hash方法返回的hash值最好唯一

和數(shù)組相比, 基于hash值索引的Hash Table查找某個(gè)成員的過(guò)程就是

• Step 1: 通過(guò)hash值直接找到查找目標(biāo)的位置

• Step 2: 如果目標(biāo)位置上有多個(gè)相同hash值得成員, 此時(shí)再按照數(shù)組方式進(jìn)行查找

hash方法什么時(shí)候被調(diào)用?

帶著這個(gè)問(wèn)題, 我們來(lái)看下面的例子

Person *person1 = [Person personWithName:kName1 birthday:self.date1];
    Person *person2 = [Person personWithName:kName2 birthday:self.date2];
    
    NSMutableArray *array1 = [NSMutableArray array];
    [array1 addObject:person1];
    NSMutableArray *array2 = [NSMutableArray array];
    [array2 addObject:person2];
    NSLog(@"array end -------------------------------");
    
    NSMutableSet *set1 = [NSMutableSet set];
    [set1 addObject:person1];
    NSMutableSet *set2 = [NSMutableSet set];
    [set2 addObject:person2];
    NSLog(@"set end -------------------------------");
    
    NSMutableDictionary *dictionaryValue1 = [NSMutableDictionary dictionary];
    [dictionaryValue1 setObject:person1 forKey:kKey1];
    NSMutableDictionary *dictionaryValue2 = [NSMutableDictionary dictionary];
    [dictionaryValue2 setObject:person2 forKey:kKey2];
    NSLog(@"dictionary value end -------------------------------");
    
    NSMutableDictionary *dictionaryKey1 = [NSMutableDictionary dictionary];
    [dictionaryKey1 setObject:kValue1 forKey:person1];
    NSMutableDictionary *dictionaryKey2 = [NSMutableDictionary dictionary];
    [dictionaryKey2 setObject:kValue2 forKey:person2];
    NSLog(@"dictionary key end -------------------------------");

為了看清楚hash方法是否被調(diào)用, 我們重寫hash方法如下

- (NSUInteger)hash {
        NSUInteger hash = [super hash];
        NSLog(@"hash = %ld", hash);
        return hash;
    }

打印結(jié)果如下

person1 == person2 = NO
    [person1 isEqual:person2] = NO
    isEqual end -------------------------------
    array end -------------------------------
    hash = 7809196951631946839
    hash = 7809196951631946839
    hash = 7809191961023760480
    hash = 7809191961023760480
    set end -------------------------------
    dictionary value end -------------------------------
    hash = 7809196951631946839
    hash = 7809196951631946839
    hash = 7809191961023760480
    hash = 7809191961023760480
    dictionary key end -------------------------------

從打印結(jié)果可以看到:

hash方法只在對(duì)象被添加至NSSet和設(shè)置為NSDictionary的key時(shí)會(huì)調(diào)用

NSSet添加新成員時(shí), 需要根據(jù)hash值來(lái)快速查找成員, 以保證集合中是否已經(jīng)存在該成員
NSDictionary在查找key時(shí), 也利用了key的hash值來(lái)提高查找的效率
hash方法與判等的關(guān)系?
hash方法主要是用于在Hash Table查詢成員用的, 那么和我們要討論的isEqual()有什么關(guān)系呢?
為了優(yōu)化判等的效率, 基于hash的NSSet和NSDictionary在判斷成員是否相等時(shí), 會(huì)這樣做
Step 1: 集成成員的hash值是否和目標(biāo)hash值相等, 如果相同進(jìn)入Step 2, 如果不等, 直接判斷不相等

Step 2: hash值相同(即Step 1)的情況下, 再進(jìn)行對(duì)象判等, 作為判等的結(jié)果

簡(jiǎn)單地說(shuō)就是

hash值是對(duì)象判等的必要非充分條件

如何重寫自己的hash方法?

很多人在iOS開(kāi)發(fā)中, 都是這么重寫hash方法的

- (NSUInteger)hash {
        return [super hash];
    }

這樣寫有問(wèn)題么? 帶著這個(gè)問(wèn)題, 我們先來(lái)看下[super hash]的值到底是什么

Person *person = [[Person alloc] init];
    NSLog(@"person = %ld", (NSUInteger)person);
    NSLog(@"[person1 getSuperHash] = %ld", [person getSuperHash]);

打印結(jié)果如下

person = 140643147498880
[person1 getSuperHash] = 140643147498880

由此可以看出, [super hash]返回的就是該對(duì)象的內(nèi)存地址
聯(lián)想到前面對(duì)hash值唯一性的要求, 使用對(duì)象的內(nèi)存地址作為hash值不是很好么?
別急, 我們添加如下兩個(gè)對(duì)象到NSSet中試試

Person *person1 = [Person personWithName:kName1 birthday:self.date1];
Person *person2 = [Person personWithName:kName1 birthday:self.date1];
NSLog(@"[person1 isEqual:person2] = %@", [person1 isEqual:person2] ? @"YES" : @"NO");

NSMutableSet *set = [NSMutableSet set];
[set addObject:person1];
[set addObject:person2];
NSLog(@"set count = %ld", set.count);

此時(shí)打印結(jié)果如下

[person1 isEqual:person2] = YES
set count = 2

isEqual相等的兩個(gè)對(duì)象都加入到了NSSet中(set count = 2), 所以直接返回[super hash]是不正確的
那么hash方法的最佳實(shí)踐到底是什么呢?
大神Mattt Thompson在Equality中給出的結(jié)論就是

In reality, a simple XOR over the hash values of critical properties is sufficient 99% of the time(對(duì)關(guān)鍵屬性的hash值進(jìn)行位或運(yùn)算作為hash值)

對(duì)于上面Person類的hash方法實(shí)現(xiàn)如下

- (NSUInteger)hash {
    return [self.name hash] ^ [self.birthday hash];
}

更多關(guān)于位運(yùn)算的討論, 參考Implementing Equality and Hashing

參考
Equality

Implementing Equality and Hashing

NSObject的hash方法

淺拷貝深拷貝以及 Hash/Equal