Comparable을 구현할지 고려하라 - [3장. 모든 객체의 공통 메서드(아이템14)]

  이번 글을 통해 Comparable을 어떻게 구현하면 좋을지 알아보고자 한다. 우선은 'compareTo 규약'에 대해서 알아보고 'compareTo를 구현하는 2가지 방법'에 대해서 알아볼 것이다. (만약 Comparable에 대한 기본지식이 필요하다면 이전 글을 참고하기 바란다.)

  들어가기에 앞서 Comparable 인터페이스의 유일무이한 메서드인 compareTo의 특징에 대해서 한번 살펴보자. 이는 아래의 2가지만 빼면 Object.equals와 같다.

1. 단순 동치성 비교에 더해서 순서까지 비교할 수 있다.
2. Generic을 지원한다.

 

1. compareTo 규약 🪔

  sgn(표현식) 표기는 수학에서 말하는 부호 함수를 뜻하며, 표현식의 값이 음수, 0, 양수 일 때 -1, 0, 1을 반환하도록 정의했다.

1. 반사성
   x.compareTo(y) == 0 이면 sgn(x.compareTo(z)) == sgn(y.compareTo(z))
2. 대칭성
   sgn(x.compareTo(y)) == -sgn(y.compareTo(x))
3. 추이성
   (x.compareTo(y) > 0 && y.compareTo(z) > 0)이면 x.compareTo(z) > 0이다.
4. equals는 필수는 아니지만 꼭 지키는 게 좋다.
   (x.compareTo(y) == 0) == (x.equals(y))
   Comparable을 구현하고 이 권고를 지키지 않는 모든 클래스는 그 사실을 명시해야 한다.

  compareTo와 equals가 일관되지 않는 예시로는 BigDecimal 클래스가 있다.

public static void main(String[] args) {
    BigDecimal oneZero = new BigDecimal("1.0");
    BigDecimal oneZeroZero = new BigDecimal("1.00");
    System.out.println(oneZero.compareTo(oneZeroZero)); // 0 
    System.out.println(oneZero.equals(oneZeroZero)); // false
}

 

2. 정적 compare 메서드 💡

  compareTo를 구현하는 첫 번째 방식은 '정적 compare 메서드'를 이용하는 것이다. 

public int compareTo(PhoneNumber pn) {
    int result = Short.compare(areaCode, pn.areaCode); // 가장 중요한 필드
    if (result == 0) {
        result = Short.compare(prefix, pn.prefix); // 두 번째로 중요한 필드
        if (result == 0)
            result = Short.compare(lineNum, pn.lineNum); // 세 번째로 중요한 필드
    }
    return result;
}

참고할 점은 아래와 같다.

• 박싱된 기본 타입 클래스들에 새로 추가된 정적 메서드인 compare를 이용해서 비교하면 된다.
• compareTo 메서드에서 관계 연사자인 '<'와 '>'를 사용하는 이전 방식은 거추장스럽고 오류를 유발하니, 이제는 추천하지 않는다.
• 클래스에 핵심 필드가 여러 개라면 핵심적인 필드부터 비교해 나가면 된다.

  기존 클래스를 확장하고 필드를 추가하는 경우 compareTo 규약을 지킬 수 없다. (하위타입에서 다시 Comparable을 구현할 수 없다.)

  이런 경우 Composition을 활용하면 된다. (equals 규약을 지키면서 활용할 때 상속이 아닌 Composition을 권고하는 것과 같은 맥락이다.)

public class Point implements Comparable<Point> {
	
	final int x, y;

	public Point(int x, int y) {
		this.x = x;
		this.y = y;
	}
	
	@Override
	public int compareTo(Point point) {
		int result = Integer.compare(this.x, point.x);
		if(result == 0) {
			result = Integer.compare(this.y, point.y);
		}
		return result;
	}
}

----------

public class NamedPoint implements Comparable<NamedPoint> {

	private final Point point;
	private final String name;
	
	public NamedPoint(Point point, String name) {
		this.point = point;
		this.name = name;
	}
	
	// 내부 인스턴스를 반환하는 '뷰'메서드
	public Point getPoint() {
		return this.point;
	}

	@Override
	public int compareTo(NamedPoint namedPoint) {
		int result = this.point.compareTo(namedPoint.point);
		if(result == 0) {
			result = this.name.compareTo(namedPoint.name);
		}
		return result;
	}
}

 

3. 비교자 생성 메서드 🔦

  compareTo를 구현하는 두 번째 방식은 '비교자 생성 메서드'를 이용하는 것이다. 자바 8부터는 '함수형 인터페이스, 람다, 메서드 레퍼런스'와 'Comparator가 제공하는 기본 메서드와 static 메서드'를 사용해서 Comparator를 구현할 수 있다.

  Comparator가 제공하는 메서드 사용방법은 아래와 같다

1. Comparator의 static 메서드를 사용해서 Comparator 인스턴스 만들기
2. default 메서드를 사용해서 메서드 호출 이어나가기 (체이닝)
   이때, static 메서드와 default 메서드의 매개변수로는 람다 표현식 또는 메서드 레퍼런스를 사용할 수 있다.

// 람다 표현식 활용
private static final Comparator<PhoneNumber> COMPARATOR = 
    comparingInt((PhoneNumber pn) -> pn.areaCode)
        .thenComparingInt(pn -> pn.prefix)
        .thenComparingInt(pn -> pn.lineNum);

public int comareTo(PhoneNumber pn) {
    return COMPARATOR.compare(this, pn);
}

// 메서드 레퍼런스 활용
private static final Comparator<PhoneNumber> COMPARATOR = 
    comparingInt((PhoneNumber pn) -> pn.areaCode)
        .thenComparingInt(PhoneNumber::getPrefix)
        .thenComparingInt(PhoneNumber::getLineNum);

public int comareTo(PhoneNumber pn) {
    return COMPARATOR.compare(this, pn);
}

  Comparator에는 수많은 보조 생성 메서드가 있다. 그리고 객체 참조용 비교자 생성 메서드도 있으니 참고하기 바란다.

 

4. 정리 🏮

• 순서를 고려해야 하는 값 클래스를 작성한다면 꼭 Comparable 인터페이스를 구현하여, 그 인스턴스들을 쉽게 정렬하고, 검색하고, 비교 기능을 제공하는 컬렉션과 어우러지도록 해야 한다.
• compareTo 메서드에서 필드의 값을 비교할 때 '<'와 '>' 연산자는 쓰지 말아야 한다.
• 그 대신 박싱된 기본 타입 클래스가 제공하는 '정적 compare 메서드'나 Comparator 인터페이스가 제공하는 '비교자 생성 메서드'를 사용해야 한다.

 

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