Hash 在 iOS 中的应用

Hash的使用参考了网上的文章 ，对网上的例子进行了验证，同时将验证结果与文章进行对比，不一致的地方也做了修改。

iOS系统API给我们提供一个自动过滤重复元素的容器 NSMutableSet/NSSet，如：当我们向该实例对象中添加字符串时，如果重复添加两个相同的字符串，集合中只会保留一个。NSMutableSet/NSSet内部一些实现机制要比我们自己写的滤重方法效率高。但是对于自定义一个类如Person，如果想利用NSMutableSet/NSSet来过滤重复元素（如多个Person实例的uid相同），我们必须要同时实现- (BOOL)isEqual:和- (NSUInteger)hash这两个方法。这里先简单介绍他们的关系：两个相等的实例，他们的hash值一定相等。但是hash值相等的两个实例，不一定相等。重点来了，利用 NSMutableSet/NSSet 具体如何实现过滤 Person 重复元素 ？

关于- (BOOL)isEqual:方法

• 为什么要有isEqual方法？

OC 中 == 运算符判断的是指针是否相等, 而 isEqual 方法内部除了判断指针是否相等，还要判断对象的属性是否相等。

首先贴个苹果官方重写isEqual 的demo

- (BOOL)isEqual:(id)other {  
 if (other == self)   
 return YES;  
 if (!other || ![other isKindOfClass:[self class]])  
 return NO;  
 return [self isEqualToWidget:other];  
}  
 
- (BOOL)isEqualToWidget:(MyWidget *)aWidget {  
 if (self == aWidget)  
 return YES;  
 if (![(id)[self name] isEqual:[aWidget name]])  
 return NO;  
 if (![[self data] isEqualToData:[aWidget data]])  
 return NO;  
 return YES;  
}

简单说一下：

首先都会判断 指针是否相等 ，相等直接返回YES，

不相等再判断是否是同类对象或非空，空或非同类对象直接返回NO，

而后依次判断对象对应的属性是否相等，若均相等，返回YES

• 如何重写isEqual方法？

但对于自定义类型来说, 做判等时通常需要重写isEqual方法。

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

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

上述代码主要步骤如下:
1、 ==运算符判断指针是否相同, 如果相同，那么对象也相同
2、 判断是否是同一类型, 这样不仅可以提高判等的效率, 还可以避免隐式类型转换带来的潜在风险
3、通过封装的isEqualToPerson方法, 提高代码复用性
4、 判断person是否是nil, 做参数有效性检查
5、 对各个属性分别使用默认判等方法进行判断
6、 返回所有属性判等的与结果

关于- (NSUInteger)hash方法

• hash方法什么时候被调用?

如果在 Person 类中重写- (NSUInteger)hash方法，该方法只在 Person 实例对象被添加至NSSet或将Person实例对象设置为NSDictionary的key 时会调用。注意是设置为 key 而不是 value

• hash方法和判等的关系？

为了优化判等的效率, 基于 hash 的 NSSet 和 NSDictionary 在判断成员是否相等时, 通常会这样做:
首先判断 hash 值是否和目标 hash 值相等。如果相同再进行对象之后的判等逻辑, 作为判等的结果； 如果不等, 直接判断为不相等。

• 如何重写 hash 方法？

很多人在iOS开发中, 都是这么重写hash方法的，如果自己亲自测试一下会发现直接重写父类方法并不能实现过滤重复元素的功能。

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

对于上面的 Person 类正确的 Hash 实现方法应该是借助位运算。代码如下：

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

实现- (BOOL)isEqual: 和 - (NSUInteger)hash方法，实现过滤自定义实例的功能

person.h

@interface Person : NSObject

@property (nonatomic, assign) NSInteger uid;
@property (nonatomic, strong) NSString *name;

- (instancetype)initWithID:(NSInteger)uid name:(NSString *)name;

@end

person.m

#import "Person.h"

@implementation Person

- (instancetype)initWithID:(NSInteger)uid name:(NSString *)name{
    if (self = [super init]) {
        self.uid = uid;
        self.name = name;
    }
    return self;
}

- (BOOL)isEqual:(Person *)object{
    BOOL result;
    if (self == object) {
        result = YES;
    }else{
        if (object.uid == self.uid) {
            result = YES;
        }else{
            result = NO;
        }
    }
    NSLog(@"%@ compare with %@ result = %@",self,object,result ? @"Equal":@"NO Equal");
    return result;
}

- (NSUInteger)hash{
    NSUInteger hashValue = self.uid;
    //在这里只需要比较uid就行。这样的话就满足如果两个实例相等，那么他们的 hash 一定相等，但反过来hash值相等，那么两个实例不一定相等。但是在 Person 这个实例中，hash值相等那么实例一定相等。（不考虑继承之类的）
    NSLog(@"hash = %lu,addressValue = %lu,address = %p",(NSUInteger)hashValue,(NSUInteger)self,self);
    // 如果返回的 值 与  之前返回的值不一样  则不会继续判断 isEqual 方法
    return hashValue;
}


- (NSString *)description{
    return [NSString stringWithFormat:@"%p(%ld,%@)",self,self.uid,self.name];
}


@end

调用的地方

- (void)viewDidLoad {
    [super viewDidLoad];
    NSMutableSet *mutSet = [NSMutableSet set];
    
    Person *person1 = [[Person alloc] initWithID:1 name:@"nihao"];
    NSLog(@"begin add %@",person1);
    [mutSet addObject:person1];
    person1.name = @"nihaoma";
    [mutSet addObject:person1];
    
    Person *person2 = [[Person alloc] initWithID:1 name:@"wohao"];
    NSLog(@"begin add %@",person2);
    [mutSet addObject:person2];
    
    // count 上述的两次操作  只会保留第一次操作结果
    NSLog(@"count = %lu",(unsigned long)mutSet.count);
    
    Person *person3 = [[Person alloc] initWithID:2 name:@"tahao"];
    NSLog(@"begin add %@",person3);
    [mutSet addObject:person3];
    
    // count
    NSLog(@"count = %lu",(unsigned long)mutSet.count);
    
    // Do any additional setup after loading the view, typically from a nib.
}

注解：

• NSMutableSet/NSSet中添加 Person 对象的时候，就会调用- (NSUInteger)hash方法。

• 第一次添加person1 的时候 只会调用 - (NSUInteger)hash 方法 ，判等的方法不会走。

• NSMutableSet/NSSet中添加 person2 对象的时候，如果NSMutableSet/NSSet 中之前就已经存在 person1对象，且 person1 对象的 - (NSUInteger)hash返回值和person2的- (NSUInteger)hash返回值相等, 则 会继续调用- (BOOL)isEqual:方法 ，其中此方法以person2 为参数；否则不等, 继续下一个元素判断。

• 如果再次添加person3对象，hash值也是一样的话，那么就会在上述步骤的基础上，继续调用判等方法。