[교재 EffectiveJava] 아이템 40. @Override 애너테이션을 일관되게 사용하라

@Override 애노테이션

자바가 기본으로 제공하는 애노테이션 중 보통의 프로그래머에게 가장 중요한 것은 @Override 일 것이다. @Override 는 메서드 선언에만 달 수 있고, 이는 상위 타입의 메서드를 재정의했음을 뜻한다. 이 애노테이션을 일관되게 사용해야한다.

 

 

예시

영어 알파벳 2개로 구성된 문자열을 표현하는 Bigram 프로그램을 살펴보자.

 

Bigram.java

package com.java.effective.item40;

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

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 메서드에서 똑같은 소문자 2개로 구성된 바이그램 26개를 10번 반복해 집합에 추가한 다음, 그 집합의 크기를 출력한다. Set은 중복을 허용하지 않으니 26이 출력될거라고 예상하겠지만, 실제로는 260이 출력된다. 

 

재정의한 equals 메서드

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

equals 메서드를 재정의하려 한 것으로 보인다. 그리고 hashCode도 함께 재정의했다. 그러나 equals 메서드를 재정의(overrideing) 한게 아니라, '다중정의(overloading)을 해버렸다. Object의 equals를 재정의하려면 매개변수 타입을 Object로 해야만 하는데 그렇지 않아서 equals를 새로 재정의한 꼴이 되었다. 

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

@Override 애노테이션을 달면 컴파일 오류가 발생한다.  잘못된 부분을 명확히 알려주므로 올바르게 수정이 가능하다.

 

수정한 코드

package com.java.effective.item40;

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

public class Bigram {
    private final char first;
    private final char second;

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

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

    @Override
    public boolean equals(Object o) {
        if(!(o instanceof Bigram)) {
            return false;
        }
        Bigram b = (Bigram) o;
        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());
        }
    }
}

상위 클래스의 메서드를 재정의하려는 모든 메서드에 @Override 애노테이션을 달자. 예외는 한가지로, 구체 클래스에서 상위 클래스의 추상메서드를 재정의할 때는 굳이 @Override를 달지 않아도 된다. 구체 클래스인데 아직 구현하지않은 추상 메서드가 남아있다면 컴파일러가 그 사실을 바로 알려주기 때문이다. 모두에 @Override 를 달아도 좋다.