아이템10. equals는 일반 규약을 지켜 재정의하라

📍상황

• Object 클래스의 equals() 메서드를 오버라이딩해야 하는 경우는 무엇일까?
• 오버라이딩을 할 때 지켜야 할 일반 규약은 무엇일까?

 

📍방법

▶️ equals를 오버라이딩하지 않아도 되는 경우

• 오버라이딩하지 않으면 기본으로 그 클래스의 인스턴스는 오직 자기 자신과만 같게 됨
• 다음에서 열거한 상황 중 하나에 해당한다면 재정의하지 않는 것이 최선임

1. 각 인스턴스가 본질적으로 고유함

• 값을 표현하는게 아니라 동작하는 개체를 표현하는 클래스가 여기 해당함
• ex) Thread --> Object의 equals 메서드는 이러한 클래스에 딱 맞게 구현되었음

2. 인스턴스의 '논리적 동치성(logical equality)'을 검사할 일이 없음

• 인스턴스의 내부 값이 동일한지 검사하지 않아도 됨

3. 상위 클래스에서 재정의한 equals가 하위 클래스에도 들어맞음

• Set 구현체는 AbstractSet이 구현한 equals를 상속받아 쓰고, List나 Map 구현체도 마찬가지임

4. 클래스가 private이거나 package-private이고 equals 메서드를 호출할 일이 없음

 

▶️ equals를 오버라이딩 해야되는 경우

인스턴스의 '논리적 동치성'을 확인해야 할 때

• 객체 식별성(object identity : 두 객체가 물리적으로 같은가)이 아니라 논리적 동치성을 확인해야 하는데, 상위 클래스의 equals가 논리적 동치성을 비교하도록 재정의되지 않았을 때를 의미함
• 주로 값 클래스들이 여기에 해당함
  • 값 클래스란?
    • Integer와 String처럼 값을 표현하는 클래스
  • 두 값 객체를 equals로 비교하는 경우 객체가 같은지가 아니라 값이 같은지를 알고 싶음
  • equals가 논리적 동치성을 확인하도록 재정의하여 이를 구현하고, Map의 키와 Set의 원소로 사용할 수 있게 됨 (중복되지 않아야 하는 것들)
  • 예외는?
    • 값 클래스여도, 값이 같은 인스턴스가 둘 이상 만들어지지 않음을 보장하는 인스턴스 통제 클래스라면 equals를 재정의하지 않아도 됨 (Enum 클래스도 여기에 해당)
    • 어차피 논리적으로 같은 인스턴스가 2개 이상 만들어지지 않으므로 논리적 동치성과 객체 식별성이 사실상 똑같은 의미가 됨

 

▶️ 오버라이딩 시 반드시 따라야 하는 일반 규약

• 규약을 따라야 하는 이유?
  • 한 클래스의 인스턴스는 다른 곳으로 빈번히 전달되어 사용됨
  • 이때 인스턴스를 사용하는 쪽에서는 전달받은 객체가 equals 규약을 지킨다고 가정하고 동작함
• 다음은 Object 명세에 적힌 규약임

1. 반사성

• 객체는 자기 자신과 같아야 함

2.  대칭성

• 두 객체는 서로에 대한 동치 여부에 똑같이 답해야 함

3. 추이성

• 그 자체로 인스턴스 생성이 가능한 구체 클래스를 확장해 새로운 값을 추가하면서 equals 규약을 만족시킬 방법은 존재하지 않음
  • 추상 클래스의 하위 클래스에서라면 equals 규약을 지키면서 값 추가가 가능함 (상위 클래스를 직접 인스턴스로 만드는 게 불가능 하니까)
• 우회 방법으로는 '상속 대신 컴포지션 사용' 하는 방법이 있음
  • ex) Point를 상속하는 대신 Point를 ColorPoint의 private 필드로 둠

 

코드 10-5 equals 규약을 지키면서 값 추가하기

public class ColorPoint {
    private final Point point;
    private final Color color;
    
    public ColorPoint(int x, int y, Color color) {
    	point = new Point(x, y);
        this.color = Objects.requireNonNull(color);
    }
    
    public Point asPoint() {
    	return this.point;
    }
    
    @Override
    public boolean equals(Object o) {
    	if (!(o instanceof ColorPoint)) return false;
        ColorPoint cp = (ColorPoint) o;
        return cp.point.equals(this.point) && cp.color.equals(this.color);
    }
    
    ...
}

4. 일관성

• 두 객체가 같다면 앞으로도 영원히 같아야 함을 의미함 (불변 객체인 경우)

5. null-아님

• 모든 객체가 null과 같지 않아야 함

//명시적 null 검사 - 필요 없다!
@Override
public boolean equals(Object o) {
    if (o == null) return false;
    ...
}

//묵시적 null 검사 - 권장!
@Override
public boolean equals(Object o) {
    if (!(o instanceof MyType)) return false;
    MyType mt = (MyType) o;
    ...
}

 

▶️ equals 메서드 구현 방법 단계별 정리

1. == 연산자를 사용해 입력이 자기 자신의 참조인지 확인함

• 자기 자신이면 true를 반환함
• 이는 단순한 성능 최적화용으로, 비교 작업이 복잡한 상황일 때 유용함

2. instanceof 연산자로 입력이 올바른 타입인지 확인함

3. 입력을 올바른 타입으로 형변환함

• 2에서 instanceof 검사를 했으므로 예외가 발생하지 않음

4. 입력 객체와 자기 자신의 대응되는 '핵심' 필드들이 모두 일치하는지 하나씩 검사함

• 모든 필드가 일치하면 true, 하나라도 다르다면 false를 반환함

 

▶️ 필드 비교 방식

• float와 double을 제외한 기본 타입 필드는 == 연산자로 비교
• 참조 타입 필드는 equals 메서드로 비교
• float와 double은 각각 정적 메서드인 Float.compare(float, float)와 Double.compare(double, double)로 비교
  • Float.NaN, -0.0f, 특수한 부동소수 값 등을 다뤄야 하기 때문임
• null도 정상 값으로 취급하는 참조 타입 필드의 경우, 정적 메서드인 Objects.equals(Object, Object)로 비교
  • NullPointerException 방지를 위함
• 비교하기 복잡한 필드를 가진 클래스인 경우, 그 필드의 표준형(canonical form)을 저장해둔 후 표준형끼리 비교
  • 특히 불변 클래스에 제격임
  • 가변 객체라면 값이 바뀔 때마다 표준형을 최신 상태로 갱신해줘야 함

 

*어떤 필드를 먼저 비교하느냐가 equals의 성능을 좌우하기도 함!

• 최상의 성능을 바란다면, 다를 가능성이 더 크거나 비교하는 비용이 싼 필드를 먼저 비교하자

 

코드 10-6 전형적인 equals 메서드의 예

public final class PhoneNumber {
    private final short areaCode, prefix, lineNum;
    
    ...
    
    @Override
    public boolean equals(Object o) {
    	if (o == this) return true;
        if (!(o instanceof PhoneNumber)) return false;
        PhoneNumber pn = (PhoneNumber) o;
        return pn.liNum == this.lineNum && pn.prefix == this.prefix && pn.areaCode == this.areaCode;
    }
    
    ...
}

 

▶️ 주의사항

1. equals를 재정의할 땐 hashCode도 반드시 재정의하자

2. 너무 복잡하게 해결하려 들지 말자

• 필드들의 동치성만 검사해도 equals 규약을 어렵지 않게 지킬 수 있음

3. Object 외의 타입을 매개변수로 받는 equals 메서드는 선언하지 말자

//잘못된 예
public boolean equals(MyClass o) {
	...
}

 

📍핵심 정리

• 꼭 필요한 경우가 아니라면 equals를 재정의하지 말자
  • 많은 경우에 Object의 equals가 원하는 비교를 정확히 수행해줌
• 재정의할 때는 그 클래스의 핵심 필드를 모두, 다섯 가지 규약을 확실히 지켜가며 비교해야 함