[Java] Effective Java, 모든 객체에 공통적인 메소드

Posted 12. April 2021. 12 min read.
Cover image

모든 객체의 공통적인 메소드

Object는 자바에서 모든 오브젝트의 최상위 클래스이며, 상속을 통해서 사용하도록 설계되었습니다. 따라서 Object 클래스에서 final이 아닌 메서드들(대표적인 예시로, equals, hashCode, toString, clone, finalize 등)이 모두 오버라이딩을 염두하고 설계되었습니다.

아래에서는 이를 재정의하는 것에 대해서 정리합니다.

Item 10. Equals를 오버라이딩 할 때, 일반적인 룰을 준수합니다.

equals 메서드를 재정의하는 방법은 여러가지가 있지만, 잘못된 사용은 끔찍한 결과를 만듭니다. 따라서 다음의 룰을 준수해야합니다.

  • 클래스의 각 인스턴스는 본질적으로 unique합니다.
  • 클래스에 대해 logical equality(지역적 동일성) 테스트를 제공할 필요가 없습니다.
  • 슈퍼 클래스는 이미 equals를 이미 오버라이딩하였으므로, 슈퍼클래스의 동작은 이미 클래스의 적합합니다.
  • 클래스는 private나 package-private이므로, 해당 'equals'는 호출되지 않을것이라고 확신합니다.

equivalence relation의 조건.

equivalence relation 이란, 요소 집합에서 요소가 서로 동일한 것으로 간주하는 하위 집합으로 분할하는 연산자이며 이를 equivalence class라고 합니다. 이를 위해서는 5가지의 요구 사항을 지켜야합니다.

  • Reflexivity(반사성)

    • 객체가 자신과 동일해야합니다.

  • Symmetry(대칭)

    • 두 객체가 동일한 지 여부에 대해 동의해야합니다.
    • equals 를 위반한 경우, 해당 객체가 다른 객체를 비교하게 되면 어떻게 동작할지 알 수가 없습니다.
// 대칭을 위반한 케이스
public final class CaseInsensitiveString {
  private final String s;

  public CaseInsensitiveString(String s) {
    this.s = Objects.requireNonNull(s);
  }

  // 대칭을 위반한 경우
  @Override public boolean equals(Object o) {
    if (o instanceof CaseInsensitiveString)
      return (s.equalsIgnoreCase((CaseInsensitiveString) o).s);
    if (o instanceof String)  // 단방향 상호 운용성
      return s.equalsIgnoreCase ((String) o);
    return false;
  }
}
// 대칭을 준수한 코드
@Override public boolean equals(Object o) {
  return o instanceof CaseInsensitiveString &&
    ((CaseInsensitiveString) o).s.equalsIgnoreCase (s);
}

  • Transitivity

    • 한 객체가 두번째 객체와 같고, 두번째 객체가 세번째 객체와 같으면 첫번째 객체와 세번째 객체가 같아야합니다.
// equals contract를 위반하지 않는 값 구성 요소
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 point;
  }

  @Override public boolean equals(Object o) {
    if(!(o instanceof ColorPoint))
      return false;
    ColorPoint cp = (ColorPoint) o;
    return cp.point.equals(point) && cp.color.equals(color);
  }
}

  • Consistency

    • 두 객체가 같은 경우에, 둘 중 하나가 변경되지 않는 한 항상 동일하게 유지되어야합니다.
    • 신뢰할 수 없는 리소스에 의존하는 경우, equals를 사용하면 안됩니다.
    • 대표적으로 사용하면 안되는 것이, java.net.url에서의 equals이며, 이는 IP를 사용하기 때문에 시간이 바뀌면서 바뀔 수 있습니다.

  • Non-nullity

    • 모든 객체는 null과 같으면 안됩니다.
// Implicit null check - preferred
@Override public boolean equals(Object o) {
  if (!(o instanceof MyType))
    return false;
  MyType mt = (MyType) o;
  ...s
}

좋은 equals 사용 방법

  • ==를 사용하여 인수가 이 객체에 대한 참조인지 확인합니다.
  • instanceof를 사용해서 argument의 유형한 타입인지 확인합니다.
  • 올바른 유형으로 캐스트합니다.
  • 클래스의 각 중요한 필드에 대해 인수의 해당 필드가, 이 객체의 해당 필드와 일치하는 지 확인합니다.

이러한 방법으로 equals를 작성하고 나서는 세가지를 확인해야합니다.

  • symmetric, transitive, consistent

그 외의 주의사항은 다음과 같습니다.

  • equals를 재정의할 때는, hashCode를 재정의합니다.
  • 너무 영리하게 할 필요가 없습니다. 복잡하게 구성하면 안됩니다.
  • equals를 선언할 때는, 객체를 다른 타입으로 대체하면 안됩니다.

Item 11. Equals를 오버라이딩 할때, Hashcode를 항상 오버라이딩합니다.

  • equals를 재정의하는 모든 클래스에서는 반드시 hashCode를 재정의해야합니다.
  • 동일한 개체에 동일한 해시 코드가 있어야합니다.
// 전형적인 hashCode method
@Override public int hashCode() {
  int result = Short.hashCode(areaCode);
  result = 31 * result + Short.hashCode(prefix);
  result = 31 * result + Short.hashCode(lineNum);
  return result;
}
  • 성능을 향상시키기 위해 hash code 계산에서 중요한 필드를 제외하면 안됩니다. (품질이 급격하게 떨어짐)
  • hashCode에서 반환한 값에 대해 자세한 스펙을 제공하면 안됩니다. 이 경우, 클라이언트 값에 합리적으로 의존할 수 없습니다. 따라서, 유연성을 제공해야합니다.

Item 12. ToString을 항상 오버라이딩합니다.

아래의 부분을 중시해야합니다.

  • equals나 hashCode를 준수하는 것만큼의 비중은 아니지만, 좋은 toString을 제공하면, 클래스를 더 좋게 사용할 수 있고 이후에 디버깅을 하기도 편해집니다.
  • 가능한 경우, toString 메소드는 객체에서 포함하고 있는 중요한 정보를 반환해야합니다.
  • 형식 지정 여부와 관계없이, 의도를 명확하게 문서화해야합니다.
/* 휴대폰 번호를 세 부분으로 나누는 것은 너무 작기때문에,
 * 이러한 필드값을 채우기 위해, 다음과 같이 진행했습니다.
 * Ex. lineNum이 123인 경우, "0123"으로 나타냅니다.
 */
@Override public String toString() {
  return String.format("%03d-%03d-%04d", areaCode, prefix, lineNum);
}
  • 형식을 지정했든 말든, toString로 반환되는 값에 포함된 정보에 대해 프로그램 액세스를 제공해야합니다.

정리하자면, toString을 사용한다면 가급적 해당 객체가 가지고 있는 모든 정보들을 노출시키는 것이 좋습니다.


Item 13. 신중하게 Clone을 오버라이딩합니다.

Cloneable 인터페이스는 복제가능한 클래스를 명시하는 인터페이스이지만, 그 목적을 수행하지 못합니다. 즉, 여러 객체를 복사하는 경우 잘못되는 경우가 쉽게 발생합니다.

대표적인 예시로 immutable class의 경우에는 낭비적인 복사를 사용하기 때문에, clone 메소드를 제공하면 안됩니다.

public class Stack {
  private Object[] elements;
  private int size = 0;
  private static final int DEFAULT_INITIAL_CAPACITY = 16;

  public Stack() {
    this.elements = new Object[DEFAULT_INITIAL_CAPACITY];
  }

  public void push(Object e) {
    ensureCapacity();
    elements[size++] = e;
  }

  public Object pop() {
    if(size == 0) throw new EmptyStackException();
    Object result = elements[--size];
    elements[size] = null;  // 사용하지 않는 참조
    return result;
  }

  public void ensureCapacity() {
    if(elements.length == size)
      elements = Arrays.copyOf(elements, 2 * size + 1);
  }
}

해당 위의 스택 클래스를 clone을 하는 경우, 복제된 Stack 클래스의 경우 동일한 elements 주소를 참조하기 때문에, 복제본의 불변성이 파괴됩니다.

즉, clone 메서드는 생성자 역할을 수행하기 때문에, 원본 객체에 해를 끼치지 않고 복제본에 불변을 수행하는 지 확인해야합니다.

또한 추가적으로 생성자를 호출하지 않고, 객체를 생성할 수도 있기 때문에 이는 큰 위험을 가지고 있습니다.

따라서 다음과 같이 clone()을 사용해야합니다.

@Override public Stack clone() {
  try {
    Stack result = (Stack) super.clone();
    result.elements = elements.clone();
    return result;
  } catch (CloneNotSupportedException e) {
    throw new AssertionError();
  }
}

Cloneable 아키텍처는 변경가능한 객체을 참조하는 final 필드의 일반적인 사용과 호환되지 않습니다.

따라서 아래와 같은 복사를 사용할 수 있습니다.

// 반복적인 복사, 깨끗하지만 맹목적으로 복사본을 덮어씁니다.
Entry deepCopy() {
  Entry result = new Entry(key, value, next);
  for(Entry p = result; p.next != null; p = p.next)
    p.next = new Entry(p.next.key, p.next.value, p.next.next);
  return result;
}

그러나 이러한 방법보다, 가장 좋은 방법 중 하나는 복사 생성자 또는 복사 팩토리를 제공하는 것입니다.

// 복사 생성자, Copy constructor
public Yum(Yum yum) { ... }

// 복사 팩토리, Copy factory
public static Yum newInstance(Yum yum) { ... };

이러한 방법은 클래스가 구현한 인터페이스 타입 인스턴스를 인수로 받을 수 있기 때문에, 클라이언트는 원본의 구현 타입에 얽매이지 않고 복제본의 타입을 정할 수 있습니다.

결론적으로, Cloneable을 확장하는 것은 좋지 않으며 생성자와 팩토리를 사용하는 것이 좋습니다. 다만 배열의 경우는 clone 메서드를 사용하는 것이 좋습니다.

추가적으로 알면 좋은 글

clone() 메서드의 경우, deep copy이고 arraycopy()의 경우, shallow clone입니다.

[추가적으로 ]


Item 14. Comparable을 개발할때 고려합니다.

compareTo 메서드는 Comparable 인터페이스의 유일한 메서드입니다. (Object 메서드가 아닙니다.) 이는 Comparable 객체의 컬렉션 유지 관리에도 편하는 장점이 있습니다.

sgn에 대한 여러가지 수학적 조건이 있으나 여기서는 너무 수학적으로 설명되기에 이를 생략합니다.

// 개체 참조 필드와 비교 가능한 단일 필드
public final class CaseInsensitiveString implements Comparable<CaseInsensitiveString> {
  public int compareTo(CaseInsensitiveString cis) {
    return String.CASE_INSENSITIVE_ORDER.compare(s, cis.s);
  }
}

Object의 equals나 ==와 주로 비교대상이 되며 이를 특징별로 정리하면 다음과 같습니다.

  • compareTo

    • 기준에 따라 비교합니다. 동일성 비교에 더해 순서까지 비교할 수 있으며 제네릭합니다.

  • equals

    • 두 객체의 값의 동일성 여부를 반환합니다.

  • ==

    • 두 객체의 동일성 여부를 반환합니다.

이중에서 compareTo에 대해서 좀 더 알아보자면 지켜야하는 3가지의 규약이 있습니다.

  • 두 객체의 참조의 순서를 바꿔 비교해도 항상 예상한 결과가 같아야합니다.
  • a < b, b < c라면 a < c가 성립해야합니다.
  • 같은 객체들끼리는 어떤 객체와 비교하더라도 항상 같아야합니다.

Comparable VS Comparator

Comparable 인터페이스의 경우 compareTo() 메서드를 오버라이딩 하여서 인자로 넘어온 같은 타입의 다른 객체와 대소 비교합니다.

public class Player implements Comparable<Player> {
// Fields, Getters, Setters 생략
  @Override
  public int compareTo(Player o) {
    return o.getScore() - getScore();
  }
}

Collections.sort(players);
System.out.println(players);

Comparator 인터페이스의 경우, 정렬 대상 클래스를 수정할 수 없을 때 주로 사용합니다. 주로 Arrays.sort(), Collections.sort() 등을 사용하며, 이를 통해서 정렬을 합니다.

Comparator<Player> comparator = new Comparator<Player>() {
  @Override
  public int compare(Player a, Player b) {
    return b.getScore() - a.getScore();
  }
};

Collections.sort(players, comparator);
System.out.println(players);

다만 보통은 람다함수로 표현합니다.

Collections.sort(players, (a, b) -> b.getScore() - a.getScore());
System.out.println(players);

이에 대한 상세 내용은 아래르 참고하면 좋습니다.

# Java # Stater # Effective Java # Object
Author image

To be a Pro in Web developer

📘 Linkedin📚 TIL💻 GitHub✨ Portfolio