[이펙티브 자바] 아이템 10. equals는 일반 규약을 지켜 재정의하라

[jaejlf]

Intro

public class Object {
    public boolean equals(Object obj) {
        return (this == obj); // 참조 값이 같다면 true, 그렇지 않으면 false
    }
    ...
}

• Object 클래스에는 객체의 참조(reference)가 동일한지를 확인하기 위한 equals 메서드가 존재한다.
• Java의 클래스는 기본적으로 Object 클래스를 상속받기 때문에, 자바의 모든 객체는 equals 메서드를 사용할 수 있다.

=> 값 비교가 필요한데, 상위 클래스의 상위 클래스의 equals 메서드가 참조 값을 비교하도록 정의되어 있을 경우 equals 메서드를 재정의하여 사용하면 된다!

🙅‍♀️ 아래의 경우에는 equals 메서드를 굳이 재정의할 필요가 없다.

1. 값(= 논리적 동치)이 같은지에 대해 비교할 필요가 없을 때 (ex. Thread와 같이 값이 아니라 동작하는 개체를 표현하는 경우)
2. Enum과 같이, 값이 같은 인스턴스가 둘 이상 만들어지지 않음을 보장하는 클래스인 경우 (이 경우에는 값 비교와 참조 값 비교가 결국 동일한 의미이므로.)

equals 메서드를 재정의하는 방법

1. == 연산자를 사용해, 자기 자신의 참조인지 확인한다.

• 성능 최적화 목적. 참조 값이 같다면 그 후 객체 비교 작업을 진행할 필요가 없으므로!

2. instanceof로 입력이 올바른지 확인한다.

• 입력 객체가 반드시 비교 대상 클래스의 인스턴스라고 보장할 수 없다. 잘못된 타입의 객체를 전달받아도 안전하게 비교가 가능하도록 하는 목적
• instanceof를 사용하면 객체가 null일 경우 false를 리턴하므로 묵시적으로 null 체크도 가능하다.

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

• instanceof 검사를 했으므로, 이 단계는 100% 성공한다.

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

• 하나라도 일치하지 않으면 false를 리턴하도록.
• tip. 어떤 필드를 먼저 비교하느냐가 equals 메서드의 성능을 좌우하기도 하므로, 더 비용이 싼 필드를 먼저 비교하자!

전형적인 equals 메서드

@Override 
public boolean equals(Object o) {
    if (o == this) //  1. == 연산자를 사용해, 자기 자신의 참조인지 확인한다.
        return true;
    if (!(o instanceof PhoneNumber)) // 2. instanceof로 입력이 올바른지 확인한다. (3. 입력을 올바른 타입으로 형변환한다.)
        return false;
    PhoneNumber pn = (PhoneNumber)o;
    return pn.lineNum == lineNum && pn.prefix == prefix
            && pn.areaCode == areaCode; // 4. 입력 객체와 자기 자신의 대응되는 '핵심' 필드들이 모두 일치하는지 하나씩 검사한다.
}

cf. 예제 코드 : PhoneNumber.java

equals 메서드를 재정의할 때 주의할 점

1. equals 메서드를 재정의할 때는 hashCode도 반드시 재정의하자.

• [이펙티브 자바] 아이템 11. equals를 재정의하려거든 hashCode도 재정의하라 #70

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

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

• 이는 매개변수가 Object가 아니므로, 재정의가 아니라 다중 정의한 것이다.

String 클래스에서의 equals()와 ==

String 클래스에서의 equals 메서드의 경우 오버라이딩되어, equals 메서드는 값 비교, == 연산자는 참조 값을 비교한다.

public class String {
    public boolean equals(Object anObject) {
        if (this == anObject) {
            return true; // 참조 값이 같다면 바로 true를 리턴
        }
        return (anObject instanceof String aString) // anObject가 String 타입인지 확인 (아니라면 String으로 변환)
                && (!COMPACT_STRINGS || this.coder == aString.coder) // 같은 인코딩 방식을 사용하는지 확인
                && StringLatin1.equals(value, aString.value); // value를 통해 문자열 간 실제 데이터가 일치하는지 확인
    }
    ...
}

[jaejlf]

p.58 instanceof vs getClass

구분	instanceof	getClass
목적	객체가 특정 클래스 or 그 하위 클래스에 속하는지 확인	객체의 정확한 클래스를 확인
상속 관계 포함 여부	O	X
null 비교	객체가 null이면 false 리턴	객체가 null이면 NullPointerException 발생
리턴값	boolean	Class<?> 객체

예제 코드

Animal dog = new Dog();
System.out.println(dog instanceof Animal); // true (상속 관계 반영)
System.out.println(dog.getClass() == Animal.class); // false (상속 관게 반영 X)

[jaejlf]

p.59 리스코프 치환 원칙

• 상위 클래스의 객체를 하위 클래스의 객체로 치환해도 프로그램의 동작이 변하지 않아야 한다.
• 상속 관계에서 부모 클래스와 자식 클래스가 교체 가능하도록 설계해야 한다.

[jaejlf]

p.59 상속 대신 컴포지션을 사용하라

[jaejlf]

p.60 추상 클래스의 하위 클래스에서라면 equals 규약을 지키면서도 값을 추가할 수 있다.

[jaejlf]

P.63 float과 double은 특별 취급 (compare 메서드로 비교한다.)

[jaejlf]

Lombok에서 제공하는 @EqualsAndHashCode

• equals와 hashCode 메서드를 자동으로 생성해준다.
  • equals 메서드는 두 객체의 값을 비교하도록 equals 메서드를 재정의해준다.
  • @EqualsAndHashCode(exclude = "id") 와 같이, 특정 필드를 제외(exclude) or 특정 필드만 포함(include)하는 설정을 추가할 수 있다.
• cf. @AutoValue와 다르게,객체의 불변성을 보장하지는 않는다.

@EqualsAndHashCode
@AllArgsConstructor
public class BookDto {
    private Long id;
    private String title;
    private String description;
}