解析和重写NSObject 的isEqual和hash方法

前言

NSObject给我们提供了-isEqual和-hash方法,下面我们具体介绍一下这两个方法主要功能是什么,会在什么时候被调用,如何根据自己定制化的需求进行重写.

isEqual

我们先查看一下方法的声明- (BOOL)isEqual:(id)object;,拿另一个对象与当前object进行对比,返回一个布尔值,来确认这两个对象是否相等.
在进一步解释这个方法之前,我们先看一下相等的定义.

什么是相等

我们知道==运算符和isEqual都可以用来判断相等,他们有什么区别呢?
我们下面对相等进行一些定义,在不同的条件下,我们对相等的定义也会发生变化,大致分为以下几种

1. 内存地址相等
2. 自定义的某些属性相等

内存地址相等,是说这是两个完全相等的对象
某些属性相等,这是需要我们关注和扩展的部分,自定义相等的条件

系统有哪些自定义的相等

• NSAttributedString -isEqualToAttributedString:
• NSData -isEqualToData:
• NSDate -isEqualToDate:
• NSDictionary -isEqualToDictionary:
• NSHashTable -isEqualToHashTable:
• NSIndexSet -isEqualToIndexSet:
• NSNumber -isEqualToNumber:
• NSOrderedSet -isEqualToOrderedSet:
• NSSet -isEqualToSet:
• NSString -isEqualToString:
• NSTimeZone -isEqualToTimeZone:
• NSValue -isEqualToValue:

如何自定义-isEqual

假设我们有一个Person类

@interface Person
@property(nonatomic, copy) NSString *firstName;
@property(nonatomic, copy) NSString *secondName
@property(nonatomic, strong) NSDate *birthday;
@end

我们先自定义一下相等的概念,这里我们举例,如果firstName和secondName相等,就视为person相等.
下面要做的就是先增加自定义的相等方法:- (BOOL)isEqualToPerson:(Person *)person;
在.m的实现如下

@implementation Person

- (BOOL)isEqualToPerson:(Person *)person {
  if (!person) {
    return NO;
  }

  BOOL isFirstNameEqual = (!self.firstName && !person.firstName) || [self.firstName isEqualToString:person.firstName];
  BOOL isSecondNameEqual = (!self.secondName && !person.secondName) || [self.secondName isEqualToString:person.secondName];

  return isFirstNameEqual && isSecondNameEqual;
}

#pragma mark - NSObject

- (BOOL)isEqual:(id)object {
  if (self == object) {
    return YES;
  }

  if (![object isKindOfClass:[Person class]]) {
    return NO;
  }

  return [self isEqualToPerson:(Person *)object];
}

- (NSUInteger)hash {
  return [self.firstName hash << 8] ^ [self.secondName hash];
}

下面分步解析一下:

1. 重写父类的isEqual方法,首先判断是否内存地址相等self == object
2. 判断![object isKindOfClass:[Person class]]如果Class不相等则直接返回NO
3. 调用我们自定义的判等方法- (BOOL)isEqualToPerson:(Person *)person.

isEqual什么时候会被调用

1. 我们可以直接调用isEqual方法来判断两个对象是否相等
2. NSArray的containObject:方法,会遍历数组的元素,并通过isEqual来判断是否相等
3. NSSet的containObject:方法,会先调用-hash,如果-hash不相等,直接返回false,如果hash相等,则会再调用isEqual

说到这里问题来了,什么是-hash方法,它的作用是什么?

hash方法

- (NSUInteger)hash返回一个整数,这个数代表的就是当前对象的哈希值
有一个很重要的规范 : 如果两个对象相等,他们的hash值必须相等, 如果某个类自定义了isEqual方法,并且这个类的实例有可能会被加入到集合中,一点要确保hash方法被重新定义

和数组把元素存储在一系列连续的地址中不同，哈希算法使得 NSSet 和 NSDictionary 能够非常快速地(O(1)) 进行元素查找,哈希表会在内存中分配n个位置，然后使用一个函数来计算出位置范围之内的某个具体位置.
在数组和hash表中要判断一个元素是不是存在的算法和效率是不一样的，数组需要对数组中每个元素的位置都进行检查,hash有一个更快速的查找方式.

一个好的 hash函数在不需要太多计算量的情况下，可以使得生成的位置分布接近于均匀分布,当两个不同的对象计算出相同的散列值时，我们称其为发生了 哈希碰撞 。当出现碰撞时，哈希表会从碰撞产生的位置开始向后寻找，把新的元素放在第一个可供放置的位置,随着哈希表变得越来越致密，发生碰撞的可能性也会随之增加，导致查找可用位置花费的时间也会增加（这也是为什么我们希望哈希函数的结果分布更接近于均匀分布).
大家对于哈希碰撞和哈希算法有一个基本的概念就可以,这一块之后会单独拿出来进行分析,敬请期待.好了,我们我们继续针对我们上面的isEqual需求进行讲解.

自定义-hash方法

如果两个对象相等,他们的hash值必须相等, 如果某个类自定义了isEqual方法,并且这个类的实例有可能会被加入到集合中,一点要确保hash方法被重新定义
自定义了两个对象相等的规则,那么hash要做的是保证在规则下了个对象的hash值要相等.
我们可以通过

- (NSUInteger)hash {
  //不完善的示例
  return [self.firstName hash] ^ [self.secondName hash];
}

来实现,但是为什么要对firstName进行位移呢?
上面我们说过,hash的设计是为了快速查找,要尽可能的避免hash冲突,也就是不满足isEqueal的两个元素,尽量hash不相等,在设计hash的时候要考虑,是否会比较轻易的使得两个不等的对象hash值相等,如果是,那么hash算法就要重新设计.
对于上面的示例来说,john smith 和smith john就会有问题,虽然无法避免hash冲突,但是不应该这么轻易冲突,为了解决这个易见的hash冲突,可以使用以下

- (NSUInteger)hash {
  return [self.firstName hash << 8] ^ [self.secondName hash];
}

总结

通过以上的讲解和示例,我们已经可以实现自定义isEqual和hash方法了.
对于hash方法,我们提到我们希望哈希函数的结果分布更接近于均匀分布,也就是在避免显而易见的哈希冲突前提下,使得哈希算法在我们现有的范围内有一定的冲突,目的是为了快速查找,这一块内容对于本篇来说有一点超纲,如果你感兴趣,可以继续关注我之后的文章,我会针对哈希冲突进行一个比较全面的分析.