排序

元素的顺序是某些集合类型的一个重要方面。例如，如果两个列表的元素排序不同，即使它们包含相同的元素，这两个列表也不相等。

在 Kotlin 中，对象的顺序可以通过多种方式定义。

首先是自然顺序。它为 Comparable 接口的实现定义。当没有指定其他顺序时，自然顺序用于对对象进行排序。

大多数内置类型都是可比较的：

• 数值类型使用传统的数值顺序：1 大于 0；-3.4f 大于 -5f，依此类推。
• Char 和 String 使用字典序：b 大于 a；world 大于 hello。

要为用户定义的类型定义自然顺序，需要使该类型实现 Comparable 接口。这要求实现 compareTo() 函数。compareTo() 必须将另一个相同类型的对象作为参数，并返回一个整数值，指示哪个对象更大：

• 正值表示接收方对象更大。
• 负值表示它小于参数。
• 零表示对象相等。

下面是一个用于排序由主版本和次版本组成之版本的类。

class Version(val major: Int, val minor: Int): Comparable<Version> {
    override fun compareTo(other: Version): Int = when {
        this.major != other.major -> this.major compareTo other.major // compareTo() in the infix form 
        this.minor != other.minor -> this.minor compareTo other.minor
        else -> 0
    }
}

fun main() {    
    println(Version(1, 2) > Version(1, 3))
    println(Version(2, 0) > Version(1, 5))
}

自定义顺序允许你以自己喜欢的方式对任何类型的实例进行排序。特别是，你可以为不可比较的对象定义顺序，或者为可比较类型定义自然顺序之外的顺序。要为某个类型定义自定义顺序，请为其创建一个 Comparator。Comparator 包含 compare() 函数：它接受一个类的两个实例，并返回它们之间比较的整数结果。该结果的解释方式与上述 compareTo() 函数的结果相同。

fun main() {
    val lengthComparator = Comparator { str1: String, str2: String -> str1.length - str2.length }
    println(listOf("aaa", "bb", "c").sortedWith(lengthComparator))
}

有了 lengthComparator，你就可以根据字符串的长度而不是默认的字典序来排列字符串。

定义 Comparator 的一种更短方式是使用标准库中的 compareBy() 函数。compareBy() 接受一个 lambda 函数，该函数从实例中生成一个 Comparable 值，并将自定义顺序定义为生成值的自然顺序。

使用 compareBy()，上述示例中的长度比较器看起来像这样：

fun main() {
    println(listOf("aaa", "bb", "c").sortedWith(compareBy { it.length }))
}

你还可以基于多个条件定义顺序。例如，当长度相等时，按长度和字母顺序对字符串进行排序，你可以这样写：

fun main() {
    val sortedStrings = listOf("aaa", "bb", "c", "b", "a", "aa", "ccc")
        .sortedWith { a, b -> 
           when (val compareLengths = a.length.compareTo(b.length)) {
             0 -> a.compareTo(b)
             else -> compareLengths
           }
         }

    println(sortedStrings)
    // [a, b, c, aa, bb, aaa, ccc]
}

由于根据多个条件进行排序是一种常见场景，Kotlin 标准库提供了 thenBy() 函数，你可以使用它来添加次要排序规则。

例如，你可以将 compareBy() 与 thenBy() 结合使用，首先按字符串长度排序，然后按字母顺序排序，就像上一个示例一样：

fun main() {
    val sortedStrings = listOf("aaa", "bb", "c", "b", "a", "aa", "ccc")
        .sortedWith(compareBy<String> { it.length }.thenBy { it })

    println(sortedStrings)
    // [a, b, c, aa, bb, aaa, ccc]
}

Kotlin 集合包提供了用于以自然顺序、自定义顺序乃至随机顺序对集合进行排序的函数。在本页中，我们将介绍适用于只读集合的排序函数。这些函数将结果作为新集合返回，其中包含原始集合中按请求顺序排列的元素。要了解用于就地排序可变集合的函数，请参阅列表特定操作。

自然顺序

基本函数 sorted() 和 sortedDescending() 返回根据其自然顺序按升序和降序排列的集合元素。这些函数适用于包含 Comparable 元素的集合。

fun main() {
    val numbers = listOf("one", "two", "three", "four")

    println("升序排列: ${numbers.sorted()}")
    println("降序排列: ${numbers.sortedDescending()}")
}

自定义顺序

对于自定义排序或排序不可比较的对象，可以使用 sortedBy() 和 sortedByDescending() 函数。它们接受一个选择器函数，该函数将集合元素映射到 Comparable 值，并根据这些值的自然顺序对集合进行排序。

fun main() {
    val numbers = listOf("one", "two", "three", "four")

    val sortedNumbers = numbers.sortedBy { it.length }
    println("按长度升序排列: $sortedNumbers")
    val sortedByLast = numbers.sortedByDescending { it.last() }
    println("按最后一个字母降序排列: $sortedByLast")
}

要为集合排序定义自定义顺序，你可以提供自己的 Comparator。为此，请调用 sortedWith() 函数并传入你的 Comparator。使用此函数，按长度排序字符串看起来像这样：

fun main() {
    val numbers = listOf("one", "two", "three", "four")
    println("按长度升序排列: ${numbers.sortedWith(compareBy { it.length })}")
}

反转顺序

你可以使用 reversed() 函数以反转顺序检索集合。

fun main() {
    val numbers = listOf("one", "two", "three", "four")
    println(numbers.reversed())
}

reversed() 返回一个包含元素副本的新集合。因此，如果你稍后更改原始集合，这不会影响先前通过 reversed() 获得的结果。

另一个反转函数 — asReversed() — 返回相同集合实例的反转视图 (view)，因此如果原始列表不会改变，它可能比 reversed() 更轻量级且更可取。

fun main() {
    val numbers = listOf("one", "two", "three", "four")
    val reversedNumbers = numbers.asReversed()
    println(reversedNumbers)
}

如果原始列表是可变的，它所有的更改都会反映在其反转视图中，反之亦然。

fun main() {
    val numbers = mutableListOf("one", "two", "three", "four")
    val reversedNumbers = numbers.asReversed()
    println(reversedNumbers)
    numbers.add("five")
    println(reversedNumbers)
}

然而，如果列表的可变性未知，或者来源根本不是列表，reversed() 更可取，因为它的结果是一个将来不会改变的副本。

随机顺序

最后，有一个函数可以返回一个新 List，其中包含按随机顺序排列的集合元素 — shuffled()。你可以不带参数调用它，也可以带 Random 对象调用它。

fun main() {
     val numbers = listOf("one", "two", "three", "four")
     println(numbers.shuffled())
}