自定义对象作为HashMap键的正确用法

最近发现不少小伙伴都对文章很感兴趣，所以今天继续给大家介绍文章相关的知识，本文《自定义对象作HashMap键的正确方法》主要内容涉及到等等知识点，希望能帮到你！当然如果阅读本文时存在不同想法，可以在评论中表达，但是请勿使用过激的措辞~

要让自定义对象作为HashMap的键正常工作，必须同时重写equals()和hashCode()方法；1. equals()和hashCode()需保持一致：相等的对象必须有相同的哈希码；2. 建议使用IDE自动生成这两个方法以避免逻辑错误；3. 确保equals满足自反性、对称性、传递性和一致性；4. hashCode应使用所有参与equals比较的字段；5. 最好使用不可变对象作为键，防止状态改变导致哈希码变化；6. 高效的hashCode和equals实现可提升性能，必要时可缓存哈希码；7. 除HashMap外，HashSet、LinkedHashSet等哈希基集合也需重写这两个方法；8. 在ArrayList等集合中查找对象时，同样需要正确重写equals()方法，否则contains()等方法可能无法正常工作。

Java HashMap允许我们使用自定义对象作为键，但这其中隐藏着一些微妙的陷阱。简单来说，你需要确保你的自定义类正确实现了equals()和hashCode()方法。否则，你的HashMap可能会出现一些意想不到的行为，比如明明“相等”的对象却被认为是不同的键。

解决方案：

要让自定义对象作为HashMap的键正常工作，必须同时重写equals()和hashCode()方法。这两个方法需要满足以下约定：

1. 如果两个对象根据equals()方法是相等的，那么它们调用hashCode()方法必须产生相同的整数结果。
2. 如果两个对象根据equals()方法是不相等的，那么它们调用hashCode()方法最好产生不同的整数结果。 (虽然不是强制要求，但这样做可以提高HashMap的性能)

以下是一个示例：

import java.util.Objects;

class MyKey {
    private String name;
    private int id;

    public MyKey(String name, int id) {
        this.name = name;
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public int getId() {
        return id;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        MyKey myKey = (MyKey) o;
        return id == myKey.id && Objects.equals(name, myKey.name);
    }

    @Override
    public int hashCode() {
        return Objects.hash(name, id);
    }

    @Override
    public String toString() {
        return "MyKey{" +
                "name='" + name + '\'' +
                ", id=" + id +
                '}';
    }
}


import java.util.HashMap;

public class HashMapExample {
    public static void main(String[] args) {
        HashMap<MyKey, String> map = new HashMap<>();

        MyKey key1 = new MyKey("Alice", 1);
        MyKey key2 = new MyKey("Alice", 1);
        MyKey key3 = new MyKey("Bob", 2);

        map.put(key1, "Value for Alice 1");
        System.out.println("Key1 hashcode: " + key1.hashCode());
        System.out.println("Key2 hashcode: " + key2.hashCode());

        System.out.println("Key1 equals Key2: " + key1.equals(key2));
        System.out.println("Value for Key2: " + map.get(key2)); // 输出 "Value for Alice 1"

        System.out.println("Value for Key3: " + map.get(key3)); // 输出 null
    }
}

在这个例子中，MyKey类重写了equals()和hashCode()方法。equals()方法比较了name和id字段，如果两个MyKey对象的这两个字段都相等，则认为它们相等。hashCode()方法使用Objects.hash()方法生成一个基于name和id字段的哈希码。

如果不重写equals()和hashCode()，HashMap会使用Object类的默认实现，即比较对象的引用。这意味着即使两个对象的字段值相同，它们仍然会被认为是不同的键。

为什么需要同时重写equals()和hashCode()？

HashMap使用hashCode()方法来确定键的存储位置（桶），然后使用equals()方法来处理哈希冲突（即多个键映射到同一个桶）。 如果只重写了equals()而没有重写hashCode()，那么相等的对象可能产生不同的哈希码，导致HashMap无法正确地检索到与该键关联的值。 换句话说，get(key)方法可能会返回null，即使你之前已经使用put(key, value)方法将值放入了HashMap。

自定义对象作为HashMap键时，如何避免常见的错误？

最常见的错误是忘记同时重写equals()和hashCode()方法，或者在实现这两个方法时出现逻辑错误。 例如，equals()方法可能只比较了对象的部分字段，而hashCode()方法可能没有使用所有参与equals()比较的字段。

为了避免这些错误，可以遵循以下建议：

• 使用IDE或工具自动生成equals()和hashCode()方法。 大多数IDE都提供了自动生成这两个方法的选项，可以大大减少出错的可能性。
• 确保equals()方法满足自反性、对称性、传递性和一致性。 这些是equals()方法必须满足的通用约定。
• 在hashCode()方法中使用所有参与equals()比较的字段。 如果equals()方法比较了对象的所有字段，那么hashCode()方法也应该使用所有这些字段来生成哈希码。
• 使用不可变对象作为键。 如果键对象是可变的，那么在将对象放入HashMap之后修改其状态可能会导致HashMap出现问题。 这是因为键的哈希码可能会发生改变，导致HashMap无法正确地找到该键。

使用自定义对象作为HashMap的键对性能有什么影响？

使用自定义对象作为HashMap的键对性能的影响取决于equals()和hashCode()方法的实现效率。 如果这两个方法的实现效率很高，那么对性能的影响可以忽略不计。 但是，如果这两个方法的实现效率很低，那么可能会导致HashMap的性能下降。

以下是一些可以提高equals()和hashCode()方法性能的技巧：

• 使用缓存来存储哈希码。 如果对象的哈希码计算成本很高，那么可以将其缓存起来，避免重复计算。
• 避免在equals()方法中进行复杂的计算。 equals()方法应该尽可能地简单和快速。
• 使用高效的哈希算法。 选择一个高效的哈希算法可以减少哈希冲突的概率，从而提高HashMap的性能。Objects.hash() 已经足够好，通常不需要自定义哈希算法。

除了HashMap，还有哪些数据结构需要重写equals()和hashCode()？

除了HashMap之外，HashSet和LinkedHashSet等基于哈希表的数据结构也需要重写equals()和hashCode()方法。 此外，如果需要在集合中查找对象，那么也需要重写equals()方法。 例如，如果需要在ArrayList中查找一个对象，那么需要重写该对象的equals()方法。 否则，contains()方法将始终返回false，即使ArrayList中包含与该对象具有相同字段值的对象。

总而言之，理解equals()和hashCode()方法对于正确使用Java集合框架至关重要，尤其是在使用自定义对象作为键时。 遵循上述建议可以帮助你避免常见的错误，并确保你的HashMap能够正常工作。

今天关于《自定义对象作为HashMap键的正确用法》的内容介绍就到此结束，如果有什么疑问或者建议，可以在golang学习网公众号下多多回复交流；文中若有不正之处，也希望回复留言以告知！