equals는 일반 규약을 지켜 재정의하라(3) - [3장. 모든 객체의 공통 메서드(아이템10)]

  이번 글에서는 지금까지의 내용을 종합해서 양질의 equals 메서드 구현 방법과 주의 사항에 대해서 알아보고자 한다.

 

1. equals 구현 방법

1. == 연산자를 사용해 입력이 자기 자신의 참조인지 확인한다.
2. instanceof 연산자로 입력이 올바른 타입인지 확인한다.
3. 입력을 올바른 타입으로 형변환한다.
4. 입력 객체와 자기 자신의 대응되는 '핵심' 필드들이 모두 일치하는지 하나씩 검사한다.
   float와 double을 제외한 기본 타입 필드는 == 연산자로 비교하고, 참조 타입 필드는 각각의 equals 메서드로, float과 double 필드는 각각 정적 메서드인 Float.compare(float, float)와 Double.compare(double, double)로 비교한다. (float와 double을 특별 취급하는 이유는 Float.NaN, -0.0f, 특수한 부동소수 값 등을 다뤄야 하기 때문이다.)

public class Point {
    private final int x;
    private final int y;
    
    public Point(int x, int y) {
        this.x = x;
        this.y = y;
    }
    
    @Override public boolean equals(Object o) {
        // 1. == 연산자를 사용해 입력이 자기 자신의 참조인지 확인한다. 
        if(this == o) {
            return true;
        }
        
        // 2. instanceof 연산자로 입력이 올바른 타입인지 확인한다.
        if(!(o.instanceof Point))
            return false;
        
        // 3. 입력을 올바른 타입으로 형변환한다.
        Point p = (Point)o;
        
        // 4. 입력 객체와 자기 자신의 대응된느 '핵심' 필드들이 모두 일치하는지 하나씩 검사한다.
        return p.x == x && p.y == y;
    }
    
    // 아이템 11 참조
    @Override public int hashCode() {
        return 31 * x + y;
    }
}

  

  문제는... 이런 규약을 따르면서 구현하기가 매우 어렵다는 것이다. 그래서 툴을 쓴다. 4가지 툴을 소개하겠다.

1. @AutoValue

@AutoValue
abstract class Point {
    static Point create(int x, int y) {
        return new AutoValue_Point(x, y);
    }
    
    abstract int x();
    abstract int y();
}

 

2. Lombok의 @EqualsAndHashCode와 @ToString

@EqualsAndHashCode
@ToString
public class Point {
    private final int x;
    private final int y;
    
    public Point(int x, int y) {
        this.x = x;
        this.y = y;
    }
}

 

3. 자바의 Record

public record Point(int x, int y){ }

 

4. IntelliJ에서 Generator의 'equals() and hashCode()'

  해당 방법에는 2가지 단점이 있다.

1. 코드가 지저분해진다.(위에서 어노테이션과 record로 간단하게 구현한 것과 비교해보면 알 수 있다.)
2. 필드가 수정될 때마다 'equals() and hashCode()'로 생성된 코드를 지우고 다시 만들어야 한다. (어노테이션으로 구현한 경우 컴파일할 때 자동으로 처리되는다는 것과 비교하면 충분히 이해할 수 있다.)

 

2. 주의 사항

1. equals를 재정의 할 때 hashCode도 반드시 재정의하자. (아이템 11에서 다룰 예정)
2. 너무 복잡하게 해결하지 말자 (이전 글에서 URL 예시를 떠올려 보자.)
3. Object가 아닌 타입의 매개변수를 받는 equals 메서드는 선언하지 말자. (타입의 매개변수를 받는 equals 메서드를 사용하면, 해당 클래스를 List나 Set에 넣을 경우 Object의 equals로 비교하게 되는 문제가 발생한다.)

// 맞는 표현
@Override public boolean equals(Object o) {
    if(this == o) {
        return true;
    }
      
    if(!(o.instanceof Point))
        return false;
    Point p = (Point)o;
    return p.x == x && p.y == y;
}

// 틀린 표현
// 이것은 '오버라이딩'한 것이 아니라 '오버로딩'한 것이다.
public boolean equals(Point o) {
    if(this == o) {
        return true;
    }
      
    if(!(o.instanceof Point))
        return false;
    Point p = (Point)o;
    return p.x == x && p.y == y;
}

 

해당 글은 백기선 님의 '이펙티브 자바 완벽 공략'을 수강하고 작성한 것입니다.