存储现有值时 Java 的 HashMap 键替换

Question

根据 Java HashMap 文档，put 方法替换了之前包含的值（如果有）：https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html#put-K-V-

将指定的值与此映射中的指定键相关联。如果 映射先前包含键的映射，旧值是 换了。

但是，文档并没有说明在存储新值时（现有）键会发生什么。现有密钥是否被替换？还是结果未定义？

考虑以下示例：

public class HashMapTest
{

   private static class Key {
      private String value;
      private Boolean b;

      private Key(String value, Boolean b) {
         this.value = value;
         this.b = b;
      }

      @Override
      public int hashCode()
      {
         return value.hashCode();
      }

      @Override
      public boolean equals(Object obj)
      {
         if (obj instanceof Key)
         {
            return value.equals(((Key)obj).value);
         }
         return false;
      }

      @Override
      public String toString()
      {
         return "(" + value.toString() + "-" + b + ")";
      }
   }

   public static void main(String[] arg) {

      Key key1 = new Key("foo", true);
      Key key2 = new Key("foo", false);

      HashMap<Key, Object> map = new HashMap<Key, Object>();
      map.put(key1, 1L);

      System.out.println("Print content of original map:");
      for (Entry<Key, Object> entry : map.entrySet()) {
         System.out.println("> " + entry.getKey() + " -> " + entry.getValue());
      }

      map.put(key2, 2L);

      System.out.println();
      System.out.println("Print content of updated map:");
      for (Entry<Key, Object> entry : map.entrySet()) {
         System.out.println("> " + entry.getKey() + " -> " + entry.getValue());
      }
   }
}

当我使用 Oracle jdk1.8.0_121 执行以下代码时，会产生以下输出：

Print content of original map:
> (foo-true) -> 1

Print content of updated map:
> (foo-true) -> 2

有证据表明（至少在我的 PC 上）现有密钥不会被替换。

这是预期/定义的行为（它在哪里定义？）还是只是所有可能结果中的一种？我可以指望这种行为在所有 Java 平台/版本中保持一致吗？

编辑：此问题与What happens when a duplicate key is put into a HashMap? 不重复。我问的是键（即当您使用多个键实例引用同一个逻辑键时），而不是值。

Answer 1

从source看，它没有被替换，我不确定它是否有合同保证。

if (e != null) { // existing mapping for key
    V oldValue = e.value;
    if (!onlyIfAbsent || oldValue == null)
        e.value = value;
    afterNodeAccess(e);
    return oldValue;
}

它找到现有的映射并替换值，新键不做任何事情，它们应该是相同且不可变的，因此即使不同的实现可以替换键也无关紧要。

您不能指望这种行为，但您应该以一种无关紧要的方式编写代码。

Answer 2

添加新对时，映射使用hasCode,equals 来检查键是否已存在于映射中。如果密钥已经存在，则旧值将替换为新值。密钥本身保持不变。

Map<Integer,String> map = new HashMap<>();
map.put(1,"two"); 
System.out.println(map); // {1=two}
map.put(1,"one"); 
System.out.println(map); // {1=one}
map.put(2,"two");
System.out.println(map); // {1=one, 2=two}

您的equals 和hashCode 合同存在问题。根据您的实现，ke1 和 key2 是相同的：

@Override
public boolean equals(Object obj)
{
    if (obj instanceof Key)
    {
       return value.equals(((Key)obj).value);
    }
    return false;
}

你还需要比较Boolean b

Key other = (Key) obj;
return value.equals(other.value) && b.equals(other.b);

同样的规则适用于hasCode

@Override
public int hashCode()
{
    return value.hashCode();
}

return value.hashCode() + b.hashCode();

这些变化key1 和key2 是不同的

System.out.println(key1.equals(key2));

您的地图的输出将是

> (foo-true) -> 1
> (foo-false) -> 2

Answer 3

它没有被替换——它也不应该被替换。如果您知道HashMap 的工作原理以及hashCode 和equals 是什么（或者更准确地说它们是如何使用的）- 不接触Key 的决定是显而易见的。

当您第二次将 other 键/条目放入映射时，该键首先在映射中查找 - 根据hashCode/equals，因此根据map IFF 键具有相同的 hashCode 并且根据equals 相等，它们是相同的。如果是这样，为什么要更换它？特别是因为如果它被替换，那可能会触发额外的操作或至少额外的代码如果键相等则不会触发任何其他东西。

Answer 4

显然，当前的HashSet implementation 依赖于这种 HashMap 行为以符合 HashSet 文档。 我的意思是，当您在 HashSet 中添加一个新元素时，文档说如果您尝试在已经包含该元素的 HasSet 中添加一个元素，则 HashSet 不会更改，因此该元素不会被替换， 在 openjdk8 实现中，HashSet 使用 HashMap 键来保存值，在 HashSet.add 方法中它调用 HashMap.put 方法来添加值，因此依赖于 put 方法不会替换对象这一事实

虽然这仍然不是文档中的直接规范，而且它会随着 JRE 实现的变化而变化，但它可能会提供更强大的 保证这在未来可能不会改变