[Item 40] @Override 애너테이션을 일관되게 사용하라

@Override는 메서드 선언에만 달 수 있으며, 이 애너테이션이 달렸다는 것은 상위 타입의 메서드를 재정의함을 뜻한다.

이 애너테이션을 일관되게 사용하면 여러 가지 악명 높은 버그들을 예방해준다. 

 

애너테이션을 사용하지 않아 버그가 발생한 예시

package effectivejava.chapter6.item40;
import java.util.*;

// 코드 40-1 영어 알파벳 2개로 구성된 문자열(바이그램)을 표현하는 클래스 - 버그를 찾아보자. (246쪽)
public class Bigram {
    private final char first;
    private final char second;

    public Bigram(char first, char second) {
        this.first  = first;
        this.second = second;
    }

    public boolean equals(Bigram b) {
        return b.first == first && b.second == second;
    }

    public int hashCode() {
        return 31 * first + second;
    }

    public static void main(String[] args) {
        Set<Bigram> s = new HashSet<>();
        for (int i = 0; i < 10; i++)
            for (char ch = 'a'; ch <= 'z'; ch++)
                s.add(new Bigram(ch, ch));
        System.out.println(s.size());
    }
}

Set은 중복을 허용하지 않으니 26이 출력될 거 같지만, 실제로는 260이 출력된다.

이 예제의 문제점은 equals를 '재정의(overriding)' 한 게 아니라 '다중 정의(overloading)'을 해버린 것이다.

Object에서 상속한 equals와는 별개인 equals를 새로 정의한 꼴이 되었다.

Object의 equals는 == 연산자와 똑같이 객체 식별성만을 확인한다. 

따라서 같은 소문자를 소유한 바이그램 10개 각각이 서로 다른 객체로 인식되고, 260을 출력한 것이다.

 

애너테이션을 사용하여 버그가 발생하지 않은 예시

package effectivejava.chapter6.item40;

import java.util.HashSet;
import java.util.Set;

// 버그를 고친 바이그램 클래스 (247쪽)
public class Bigram2 {
    private final char first;
    private final char second;

    public Bigram2(char first, char second) {
        this.first  = first;
        this.second = second;
    }

    @Override public boolean equals(Object o) {
        if (!(o instanceof Bigram2))
            return false;
        Bigram2 b = (Bigram2) o;
        return b.first == first && b.second == second;
    }

    public int hashCode() {
        return 31 * first + second;
    }

    public static void main(String[] args) {
        Set<Bigram2> s = new HashSet<>();
        for (int i = 0; i < 10; i++)
            for (char ch = 'a'; ch <= 'z'; ch++)
                s.add(new Bigram2(ch, ch));
        System.out.println(s.size());
    }
}

Object.equals를 재정의한다는 의도를 명시하면 에러가 발생하지 않는다. 

상위 클래스의 메서드를 재정의하려는 모든 메서드에 @Override 애너테이션을 달자. 그렇다면 실수했을 때 컴파일러가 바로 알려줄 것이다.

다만, 구체 클래스에서 상위 클래스의 추상 메서드를 재정의한 경우에는 이 애너테이션을 달지 않아도 된다.

 

---

참고자료

www.kyobobook.co.kr/product/detailViewKor.laf?ejkGb=KOR&mallGb=KOR&barcode=9788966262281&orderClick=LET&Kc=

이펙티브 자바 3/E - 교보문고