1. compareTo

• 객체 간의 순서를 비교하기 위해 사용되는 메서드

• Kotlin에서는 Comparable 인터페이스의 일부로 제공

• 두 객체를 비교해서 정수값을 반환

  • 음수: 현재 객체가 파라미터로 받은 객체보다 작음
  • 0: 두 객체가 동등함
  • 양수: 현재 객체가 파라미터로 받은 객체보다 큼

• 비교 연산자(>, <, ≥, ≤)를 사용하면 내부적으로 compareTo 메서드가 호출됨

  obj1 > obj2 // obj1.compareTo(obj2) > 0
  obj1 < obj2 // obj1.compareTo(obj2) < 0
  obj1 >= obj2 // obj1.compareTo(obj2) >= 0
  obj1 <= obj2 // obj1.compareTo(obj2) <= 0
  

2. compareTo의 동작 규칙

1. 비대칭적 동작

   • a가 b보다 크면 b는 a보다 작아야 함

   if (a > b) {
       b < a
   }
   

2. 연속적 동작

   • a가 b보다 크고, b가 c보다 크면 a는 c보다 커야 함

   if (a > b && b > c) {
       a > c
   }
   

3. 코넥스적 동작

   • 어떤 두 객체든 항상 대소관계를 비교할 수 있어야 함

   a >= b || b >= a // 항상 true
   

3. compareTo를 따로 정의해야할까?

• 일반적으로 특정 프로퍼티 하나를 기반으로 순서를 지정하는 것으로 충분하기 때문에 따로 정의해야 하는 상황은 거의 없음

// sortedBy를 사용하면 원하는 키로 정렬 가능
val sorted = names.sortedBy { it.surname }

// sortedWith으로 여러 프로퍼티 기반 정렬도 가능
val sorted = names.sortedWith(compareBy({ it.surname }, { it.name }))

4. comapareTo 구현하기

• compareValues 톱레벨 함수를 쓰면 compareTo를 구현할 때 유용하다.

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