0. 들어가며

HashMap 자료형을 사용하며 풀어야 했던 문제 중, compute를 쓸 일이 있었는데, 갑자기 해당 내용이 생각이 나지 않아서 다시 정리한다. HashMap의 compute는 putIfPresent, putIfAbsent 등을 전부 포괄하며 내가 하고 싶은 작업의 대부분을 할 수 있어서 편하다. 이번엔 compute에 대해 자세히 알아보겠다.

1. 형태

V compute(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction);

// ex
map.compute(key, (key,oldValue) -> {... return newValue});

반환형: 반환형의 V는 현재 함수를 부른 Map의 value의 자료형을 뜻한다. 만약 HashMap<Integer, Integer> 였다면 V는 Integer가 되는 형식이다.
인수: 인수들을 들여다 보면, Key, Remapping Function 형태로 이루어진 것을 볼 수 있다.
- Key: value와 마찬가지로, 해당 함수를 부른 HashMap의 Key이다.
- remappingfunction: key의 value를 가져와 정의한 연산과정을 거친 후 다시 해당 key의 value로 재 매핑된다는 의미에서 remappingfunction이라 명명 되었다.
  remappingfunction의 인수는 다시 key 와 oldvalue로 나뉜다.
  - oldValue: 해당 key가 가지고 있는 기존의 value 값을 의미한다.
  - newValue: remapping 함수에서 반환하는 값으로 compute 자체의 반환값이자 key의 new value가 된다.

ex는 위에서 설명한 내용들이 실제로 어떻게 쓰이는지에 대한 예시 이다.

2. 특징

1️⃣compute의 인수로 넣은 key가 map에 존재하지 않는 값이라면 신규 삽입해준다.

map.compute(key, (key,oldValue) -> {... return newValue});

여기서 k가 기존에 map에 없는 값이어도 괜찮다. 만약 없는 값이라면 map에 <key, newValue> 쌍이 신규 삽입 된다.
(key가 이미 존재하는 값이면 newValue로 덮어쓰기 된다.)

2️⃣ 인수로 들어온 Key를 Map에서 삭제 가능하다.

remappingfunction에서 return null을 한다면, 인수로 들어온 key를 삭제하겠다는 의미이다.

3. 함수 안을 들여다보자.

밑의 함수는 Java 17을 기준으로 한다.

public V compute(K key,
    BiFunction<? super K, ? super V, ? extends V> remappingFunction) {

    Node<K,V> e;             // 현재 Key에 해당하는 엔트리노드 
    V oldValue;                // 이전 값
    int hash = hash(key);    // key의 해시값
    int binCount = 0;        // 동일 해시값을 가진 쌍을 저장하는 버킷이 몇 개의 노드가 있는지 세는 용도


    // table: 실제 데이터가 저장되는 Node<K,V>[] 배열
    // tab: 이 table 배열을 로컬 변수로 옮겨놓음 (최적화 목적)

    // 만약 아직 배열이 초기화되지 않았거나 길이가 0이면 resize()를 호출해서 초기화하고, 길이 가져옴
    if ((tab = table) == null || (n = tab.length) == 0)
        n = (tab = resize()).length;

    // 동일 Hash 값을 가진 Bucket 내에서 우리가 찾는 key-value 쌍을 찾는 과정 
    // i = (n - 1) & hash → 버킷의 인덱스 계산 (비트 연산으로 모듈로 연산)
    // 해당 버킷 인덱스에 엔트리가 존재한다면 (key 충돌 등)
    if ((e = tab[i = (n - 1) & hash]) != null) {

        Node<K,V> node = null; 
        K k; 
        V v;

        // 연결리스트 or 트리로 연결된 엔트리들 중에서 원하는 key를 찾는 과정
        do {
            // 같은 hash이고, key 자체도 같으면 해당 노드 찾음
            if (e.hash == hash &&
                ((k = e.key) == key || (key != null && key.equals(k)))) {
                oldValue = e.value;    // oldValue 옮겨 담기
                node = e;            // Entry 옮겨 담기
                break;
            }
        } while ((e = e.next) != null);    // 없으면 계속 버킷내에서 연결된 다음 노드로 이동

        // remappingFunction 실행해서 새 값을 계산함
        V newValue = remappingFunction.apply(key, oldValue);

        // null 이 아니면 덮어쓰기, null 이면 해당 entrySet을 Map에서 지운다.
        if (newValue != null) {
            node.value = newValue;
        } else {
            removeNode(hash, key, null, false, true);
        }
        return newValue;
    } else {
        // key가 없을 때 즉 key가 HashMap에 저장되지 않은 경우, oldvalue = null로 넣고 진행
        V newValue = remappingFunction.apply(key, null);
        if (newValue != null)
            putVal(hash, key, newValue, false, true);
        return newValue;
    }
}

다음과 같은 과정으로 나뉘어진 것을 알 수 있다.

(1) map 내에서 인수로 들어온 Key값에 해당하는 EntrySet 찾기 (없으면 그냥 null로 두고 넘어감)
(2) remappingFunction 함수 활용해서 계산
- 결과가 null 이면 해당 entrySet을 map 내에서 지운다.
- 결과가 null 아니면, 해당 key의 value를 newValue로 덮어쓴다.
- 기존에 없는 key 값이면 <key, value> 쌍으로 저장한다.

4. 결론

compute를 쓰면, putIfAbsent, putIfPresent를 따로 쓰지 않고 한 번에 해결할 수 있을 뿐더러, 필요없는 key,value 쌍을 지워버릴 수도 있어서 편하다. 반면 remappingFunction 덕에 항상 value가 반환값으로 변경되므로, getOrDefault 역할은 하지 못한다.