[이펙티브 코틀린] 아이템 42: compareTo의 규약을 지켜라

본문은 Effective Kotlin을 읽고 간단하게 정리한 글입니다. 필요에 따라 생략/수정된 부분이 있을 수 있으며, 내용이 추후 변경될 수 있습니다.

 

1. compareTo의 동작원칙

• 비대칭적 동작: a >= b 이고, b >= a라면, a == b
• 연속적 동작: a >= b이고, b >= c라면, a >= c
• 코넥스적 동작: a >= b 또는 b >= a 중에 적어도 하나는 항상 true

 

 

2. compareTo의 대안

기본적으로 compareTo를 따로 정의해야 할 상황은 거의 없다. compareTo를 재정의하는 대신, 간단하게 다음의 함수를 이용해서 순서를 지정할 수 있다.

• sortedBy: 하나의 프로퍼티를 기반으로 순서를 지정할 때 사용
• sortedWith: 하나의 프로퍼티를 기반으로 순서를 지정할 때 사용
  • sortedWith 함수의 인자로는 Compartor<in T> 타입이 필요하다
  • compareBy 함수를 사용하면 간단하게 구현할 수 있다

// sortedBy - 단일 프로퍼티를 기반으로 정렬
val list = listOf("aaa", "cc", "bbbb")
val sorted = list.sortedBy { it.length }

println(list) // [aaa, cc, bbbb]
println(sorted) // [cc, aaa, bbbb]


// sortedWith - 복수 프로퍼티를 기반으로 정렬
val sortedDates = myDates.sortedWith(compareBy { it.month }.thenBy { it.day })
println(myDates)
/*
MyDate(month=8, day=19)
MyDate(month=5, day=16)
MyDate(month=1, day=29)
MyDate(month=5, day=10)
MyDate(month=8, day=3)
*/

println(sortedDates)
/*
MyDate(month=1, day=29)
MyDate(month=5, day=10)
MyDate(month=5, day=16)
MyDate(month=8, day=3)
MyDate(month=8, day=19)
*/

 

객체가 직접 Comparable<T> 인터페이스를 구현하는 형태로도 구현이 가능하다. 이때는 다음과 같은 규칙을 따른다.

• 특정 프로퍼티를 기반으로 정렬하게끔 만든다
• 비교에 대한 절대적인 기준이 없다면 비교하지 못하게 만든다
• 자연스러운 순서를 갖는 객체(e.g. 측정단위, 날짜, 시간)인지 확실하지 않다면 비교기(comparator)를 사용하는 것이 좋다
  • 자주 사용한다면 클래스의 companion 객체로 정의할 수 있다

class User(val name: String, val surname: String) {
    // ...
    
    companion object {
        val DISPLAY_ORDER = compareBy(User::surname, User::name)
    }
}

val sorted = names.sortedWith(User.DISPLAY_ORDER)

 

 

3. compareTo 구현하기

compareTo는 다음과 같은 함수들을 통해 구현할 수 있다.

• compareValues: 두 값을 단순하게 비교할 때 사용한다

class User(
    val name: String,
    val surname: String
): Comparable<User> {
    override fun compareTo(other: User): Int = 
                compareValues(surname, other.surname)
}

• compareValuesBy: 더 많은 값을 비교하거나, 선택기(selector)를 활용해서 비교할 때 사용한다

class User(
    val name: String,
    val surname: String
): Comparable<User> {
    override fun compareTo(other: User): Int = 
                compareValuesBy(this, other, { it.suername }, { it.name })
}