如何编写hashCode

阅读经典——《Effective Java》05

上一篇文章介绍了如何覆盖equals方法,通常在覆盖了equals方法的类中也必须覆盖hashCode方法。否则该类就无法与基于散列的集合类一起工作,比如HashMap和HashSet。至于这些集合类如何用到hashCode方法,网络上有大量说明,本文重点讨论如何编写简洁、高效的hashCode方法。

  1. hashCode通用约定
  1. 如何编写hashCode

hashCode通用约定

Java规范中要求hashCode方法必须满足:

  • 如果两个对象equals结果为真,那么他们的hashCode结果必须一致。
  • 如果两个对象equals结果为假,那么他们的hashCode结果不一定不同。但是,不同的hashCode结果有利于提高散列表性能。

如何编写hashCode

理想情况下,散列函数应该把集合中不相等的实例均匀地分布到所有可能的散列值上。虽然很难做到,但下面的方案不失为一种良好的解决方法。

  • 1.把某个非零的常数值,比如17,保存在变量int result中。
  • 2.对于对象中每个关键域f(关键域指equals方法比较时用到的域),完成以下步骤:
  • a. 为该域计算int类型的散列码c:
    • i. 如果该域是boolean类型,则计算f ? 1:0
    • ii. 如果该域是byte、char、short或者int类型,则计算(int) f
    • iii. 如果该域是long类型,则计算(int) (f ^ (f >>> 32))
    • iv. 如果该域是float类型,则计算Float.floatToIntBits(f)
    • v. 如果该域是double类型,则计算Double.doubleToLongBits(f),然后按照步骤2.a.iii,为得到的long类型值计算散列值。
    • vi. 如果该域是一个对象引用,并且该类的equals方法通过递归地调用equals的方式来比较这个域,则同样为这个域递归地调用hashCode。
    • vii. 如果该域是一个数组,则要把每一个元素当做单独的域来处理。也就是说,递归地应用上述规则,对每一个重要的元素计算一个散列码,然后根据步骤2.b中的做法把这些散列值组合起来。如果数组域中的每个元素都很重要,可以利用Arrays.hashCode方法。
  • b. 按照下面的公式,把步骤2.a中计算得到的散列码c合并到result中。
    result = 31 * result + c;
  • 3.返回result
  • 4.写完了hashCode方法后,问问自己“相等的实例是否都具有相等的散列码”。要编写单元测试来验证你的推断。如果相等的实例有着不同的散列码,则要找出原因,并修正错误。

为了更清晰的说明这几个步骤具体如何实现,我们举一个简单的例子。考虑如下Person类的hashCode实现。

/**
 * Person并不是一个非常合适的例子,此处仅用于说明如何按照步骤编写hashCode方法。
 * 实际中一般不会按照name、gender、age来判定是否为同一个人。
 */
public class Person {

  private boolean gender;
  private int age;
  private String name;

  public Person(boolean gender, int age, String name) {
    this.gender = gender;
    this.age = age;
    this.name = name;
  }
    
  @Override
  public boolean equals(Object obj) {
    if (obj == this) return true;
    if (!(obj instanceof Person)) return false;
    Person p = (Person) obj;
    return p.gender == gender && p.age == age && p.name == name;
  }
    
  @Override
  public int hashCode() {
    int result = 17;
    int c = gender ? 1 : 0;
    result = 31 * result + c;
    c = age;
    result = 31 * result + c;
    c = name.hashCode();
    result = 31 * result + c;
    return result;
  }
}

Person类有三个关键域gender、age和name,而且分别属于不同的类型boolean、int和String。按照前面介绍的步骤很容易实现hashCode,经过测试,相等的实例都具有相等的散列码。

关注作者文集《Effective Java》,第一时间获取最新发布文章。

参考资料

java中HashMap详解 alex09

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,491评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,856评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,745评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,196评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,073评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,112评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,531评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,215评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,485评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,578评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,356评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,215评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,583评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,898评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,174评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,497评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,697评论 2 335

推荐阅读更多精彩内容