Map.containsKey: примеры (JAVA)

Отличия от Java: в некоторых языках (PHP isset, Lua) проверка ложная при значении null; в Go проверка возвращает булев флаг отдельно; в JavaScript объекты и Map различаются по поведению при проверке ключей.

• Ошибочное использование get для проверки присутствия: проверка map.get(key) == null не отличает отсутствие ключа от значения null. Пример выше показывает отличия.
• Использование null в реализациях, которые не допускают null-ключи: например, ConcurrentHashMap и TreeMap при естественном порядке выбросят NullPointerException.

  Map map = new java.util.concurrent.ConcurrentHashMap<>();
  map.containsKey(null);

  Exception in thread "main" java.lang.NullPointerException
      at java.base/java.util.concurrent.ConcurrentHashMap.hash(ConcurrentHashMap.java:...)
      ...

• Неправильная реализация equals/hashCode у ключей: если hashCode или equals меняются после вставки в HashMap, containsKey может вернуть false.

  class Key { String id; Key(String id){this.id=id;} 
  public int hashCode(){return id.length();} 
  public boolean equals(Object o){return o instanceof Key && ((Key)o).id.equals(id);} }
  
  Map m = new HashMap<>();
  Key k = new Key("ab");
  m.put(k, "v");
  // изменена внутренне id (симулируется)/или состояние, влияющее на hashCode
  k.id = "abcd";
  System.out.println(m.containsKey(k));

  false

• ClassCastException при использовании TreeMap с несравнимыми ключами.

  Map map = new TreeMap();
  map.put("a",1);
  map.containsKey(10);

  Exception in thread "main" java.lang.ClassCastException: java.lang.Integer cannot be cast to java.lang.String
      at java.base/java.util.TreeMap.compare(TreeMap.java:...)
      ...

Метод containsKey присутствует в интерфейсе java.util.Map с ранних версий платформы (Collections framework). За последние версии Java сам метод не претерпел изменений в сигнатуре и семантике.

Косвенные изменения затрагивают сопутствующие возможности API: с появлением Java 8 и выше добавлены методы getOrDefault, computeIfAbsent, forEach и другие функциональные методы, которые в ряде случаев заменяют комбинацию containsKey и последующих действий. В многопоточном коде предпочтение отдаётся атомарным операциям ConcurrentMap.

Несколько углублённых примеров с объяснениями.

1) Использование IdentityHashMap - сравнение ключей по ссылке:

import java.util.*;
Map m = new IdentityHashMap<>();
String a1 = new String("x");
String a2 = new String("x");
m.put(a1, "v");
System.out.println(m.containsKey(a1));
System.out.println(m.containsKey(a2));

true
false

Объяснение: IdentityHashMap использует сравнение по ==, поэтому равные по содержимому строки, но разные объекты считаются разными ключами.

2) WeakHashMap и влияние сборки мусора на наличие ключа:

import java.util.*;
Map m = new WeakHashMap<>();
Object key = new Object();
m.put(key, "v");
System.out.println(m.containsKey(key));
key = null;
System.gc(); // возможна очистка ключа
// небольшая задержка чтобы GC мог очистить
try{Thread.sleep(100);}catch(Exception e){}
System.out.println(m.isEmpty());

true
true   // возможно true, если ключ был очищен сборщиком мусора

Объяснение: WeakHashMap хранит ключи с слабой ссылкой, поэтому после удаления внешней ссылки и выполнения GC запись может исчезнуть и containsKey вернёт false.

3) Атомарность в многопоточной вставке - гонка при containsKey + put:

Map map = new java.util.concurrent.ConcurrentHashMap<>();
// поток A
if (!map.containsKey("k")) {
    // до put другой поток может вставить ту же запись
    map.put("k","v1");
}
// безопаснее:
map.putIfAbsent("k","v2");

// при использовании containsKey возможны дубликаты вставок от разных потоков
// putIfAbsent гарантирует, что первый вставивший останется

Объяснение: containsKey не обеспечивает атомарности с последующими операциями. В многопоточных сценариях лучше использовать putIfAbsent или computeIfAbsent.

4) Поиск с пользовательским сравнением через ключ-обёртку:

// хранение по naturalHash, но поиск по другому критерию
class Wrapper { String id; Wrapper(String id){this.id=id;} 
public boolean equals(Object o){return o instanceof Wrapper && ((Wrapper)o).id.equalsIgnoreCase(id);} 
public int hashCode(){return id.toLowerCase().hashCode();} }
Map map = new HashMap<>();
map.put(new Wrapper("Ab"), "v");
System.out.println(map.containsKey(new Wrapper("ab")));

true

Объяснение: если требуется нечувствительный к регистру поиск, реализация equals/hashCode может это учесть.

5) Использование containsKey в stream-выражениях:

Map map = Map.of("a",1,"b",2);
List keysToCheck = List.of("a","c");
List present = keysToCheck.stream()
    .filter(map::containsKey)
    .toList();
System.out.println(present);

[a]

Объяснение: метод можно передавать как ссылку на метод для компактной фильтрации коллекций ключей.

6) Нестандартный случай: Map с пользовательской стратегией равенства - пример для ConcurrentHashMap не возможен, но для других реализаций есть адаптеры, поэтому при выборе реализации важно учитывать требования к сравнению ключей.