集合操作概述

Kotlin 标准库提供了用于对集合执行操作的多种函数。这包括简单的操作,例如获取或添加元素,以及更复杂的操作,包括搜索、排序、过滤、 转换等。

扩展与成员函数

集合操作在标准库中以两种方式声明:集合接口的成员函数扩展函数

成员函数定义了对于集合类型是必不可少的操作。例如,Collection 包含函数 isEmpty() 来检查其是否为空; List 包含用于对元素进行索引访问的 get(), 等等。

创建自己的集合接口实现时,必须实现其成员函数。 为了使新实现的创建更加容易,请使用标准库中集合接口的框架实现AbstractCollectionAbstractListAbstractSetAbstractMap 及其相应可变抽象类。

其他集合操作被声明为扩展函数。这些是过滤、转换、排序以及其他集合处理函数。

公共操作

公共操作可用于只读集合与可变集合。 公共操作分为以下几类:

这些页面中描述的操作将返回其结果,而不会影响原始集合。例如,一个过滤操作产生一个新集合,其中包含与过滤谓词匹配的所有元素。 此类操作的结果应存储在变量中,或以其他方式使用,例如,传到其他函数中。


fun main() {
//sampleStart
    val numbers = listOf("one", "two", "three", "four")  
    numbers.filter { it.length > 3 }  // `numbers` 没有任何改变,结果丢失
    println("numbers are still $numbers")
    val longerThan3 = numbers.filter { it.length > 3 } // 结果存储在 `longerThan3` 中
    println("numbers longer than 3 chars are $longerThan3")
//sampleEnd
}

对于某些集合操作,有一个选项可以指定 目标 对象。 目标是一个可变集合,该函数将其结果项附加到该可变对象中,而不是在新对象中返回它们。 对于执行带有目标的操作,有单独的函数,其名称中带有 To 后缀,例如,用 filterTo() 代替 filter() 以及用 associateTo() 代替 associate()。 这些函数将目标集合作为附加参数。


fun main() {
//sampleStart
    val numbers = listOf("one", "two", "three", "four")
    val filterResults = mutableListOf<String>()  // 目标对象
    numbers.filterTo(filterResults) { it.length > 3 }
    numbers.filterIndexedTo(filterResults) { index, _ -> index == 0 }
    println(filterResults) // 包含两个操作的结果
//sampleEnd
}

为了方便起见,这些函数将目标集合返回了,因此可以在函数调用的相应参数中直接创建它:


fun main() {
    val numbers = listOf("one", "two", "three", "four")
//sampleStart
    // 将数字直接过滤到新的哈希集中,
    // 从而消除结果中的重复项
    val result = numbers.mapTo(HashSet()) { it.length }
    println("distinct item lengths are $result")
//sampleEnd
}

具有目标的函数可用于过滤、关联、分组、展平以及其他操作。 关于目标操作的完整列表,请参见 Kotlin collections reference

写操作

对于可变集合,还存在可更改集合状态的 写操作 。这些操作包括添加、删除和更新元素。写操作在集合写操作以及 List 写操作Map 写操作相应部分中列出。

对于某些操作,有成对的函数可以执行相同的操作:一个函数就地应用该操作, 另一个函数将结果作为单独的集合返回。 例如, sort() 就地对可变集合进行排序,因此其状态发生了变化; sorted() 创建一个新集合,该集合包含按排序顺序相同的元素。


fun main() {
//sampleStart
    val numbers = mutableListOf("one", "two", "three", "four")
    val sortedNumbers = numbers.sorted()
    println(numbers == sortedNumbers)  // false
    numbers.sort()
    println(numbers == sortedNumbers)  // true
//sampleEnd
}