애너테이션을_일관되게_사용하라(유현우).md

애너테이션을 일관되게 사용하라

상위 타입의 메서드를 재정의했음을 뜻하는 @Override 애너테이션

• 일관되게 사용하면 악명 높은 버그들을 예방해준다.

영어 알파벳 2개로 구성된 문자열(바이그램)을 표현하는 클래스

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());
    }
}

• main 메서드가 실행되고 Set은 중복을 허용하지 않기 때문에 26이 출력되어야 하는데 260이 출력된다.

equals 메서드가 오버라이드 된것이 아니라 오버로딩 되었기 때문이다.

• Object의 equals() 를 재정의하려면 매개변수 타입을 Object로 해야 하는데 그렇지 않아서 상속한 equals와 별개인 equals 메서드를 정의한 꼴이 되었다.
• equals에 문제가 있음에도 컴파일에는 성공하기 때문에, @Override 를 달지 않게 되면 위의 잘못한 점을 컴파일러가 알려주지 못한다.

올바르게 파라미터를 정의하자

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

• 아까 동작했던 메인 메서드가 260이 아니라 26으로 올바른 값이 나오는것을 볼 수 있다.
• @Override 애너테이션을 선언해주면 컴파일 타임에 오류가 발생하기 때문에 바로 수정할 수 있었다.
• 상위 클래스의 메서드를 재정의하려는 모든 메서드에는 @Override 애너테이션을 달자.

예외 사항

구체 클래스에서 상위 클래스의 메서드를 재정의할 때는, 굳이 @Override를 달지 않아도 된다.

• 구체 클래스인데 구현하지 않은 추상 메서드가 남아 있다면 컴파일러가 자동으로 사실을 알려주기 때문이다.
• 모두에 @Override를 일괄로 붙여두는 게 좋아 보인다면 그래도 상관없다. (대부분 IDE는 재정의할 메서드 선택하면 자동으로 붙여줌)

default 메서드와 @Override

인터페이스가 디폴트 메서드를 지원하기 시작하면서, 인터페이스 메서드를 구현한 메서드에도 @Override를 다는 습관을 들이면 시그니처가 올바른지 재차 확신할 수 있다.

• deafult 메서드가 없다는 것을 안다면 생략해도 좋다.

하지만 추상 클래스나 인터페이스에는 상위 클래스나 상위 인터페이스의 메서드를 재정의 하는 모든 메서드에 @Override를 다는 것이 좋다.

예컨대 Set 인터페이스는 Collection 인터페이스를 확장했지만 새로 추가한 메서드는 없기 때문에 모든 메서드 선언에 @Override를 달아 실수로 추가한 메서드가 없음을 보장했다.

정리

재정의한 모든 메서드에 @Override 애너테이션을 의식적으로 달면, 여러분이 실수했을때 컴파일러가 바로 알려준다.

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