集合转换操作

Kotlin 标准库提供了一组用于集合转换的扩展函数。这些函数根据提供的转换规则从现有集合构建新集合。在本页中，我们将概述可用的集合转换函数。

Map

映射转换通过对另一个集合的元素应用函数的结果来创建集合。 基本的映射函数是 map()。它将给定的 lambda 函数应用于每个后续元素，并返回 lambda 结果的列表。结果的顺序与元素的原始顺序相同。若要应用一个额外使用元素索引作为参数的转换，请使用 mapIndexed()。

fun main() {
    val numbers = setOf(1, 2, 3)
    println(numbers.map { it * 3 })
    println(numbers.mapIndexed { idx, value -> value * idx })
}

如果转换在某些元素上产生 null，你可以通过调用 mapNotNull() 函数而不是 map()，或 mapIndexedNotNull() 而不是 mapIndexed() 来从结果集合中过滤掉 null 值。

fun main() {
    val numbers = setOf(1, 2, 3)
    println(numbers.mapNotNull { if ( it == 2) null else it * 3 })
    println(numbers.mapIndexedNotNull { idx, value -> if (idx == 0) null else value * idx })
}

在转换映射（map）时，你有两种选择：转换键（key）而值（value）保持不变，反之亦然。要对键应用给定的转换，请使用 mapKeys()；反过来，mapValues() 转换值。这两个函数都使用接受映射条目（map entry）作为参数的转换，因此你可以操作其键和值。

fun main() {
    val numbersMap = mapOf("key1" to 1, "key2" to 2, "key3" to 3, "key11" to 11)
    println(numbersMap.mapKeys { it.key.uppercase() })
    println(numbersMap.mapValues { it.value + it.key.length })
}

Zip

压缩转换是根据两个集合中相同位置的元素构建对。在 Kotlin 标准库中，这通过 zip() 扩展函数完成。

当在集合或数组上调用 zip() 并以另一个集合（或数组）作为参数时，它会返回一个 Pair 对象的 List。接收者集合的元素是这些对中的第一个元素。

如果集合大小不同，zip() 的结果将是较小的大小；较大集合的最后元素不会包含在结果中。

zip() 也可以通过中缀形式 a zip b 调用。

fun main() {
    val colors = listOf("red", "brown", "grey")
    val animals = listOf("fox", "bear", "wolf")
    println(colors zip animals)

    val twoAnimals = listOf("fox", "bear")
    println(colors.zip(twoAnimals))
}

你还可以调用 zip() 并提供一个接受两个参数的转换函数：接收者元素和参数元素。在这种情况下，结果 List 包含在接收者元素和参数元素相同位置的对上调用转换函数的返回值。

fun main() {
    val colors = listOf("red", "brown", "grey")
    val animals = listOf("fox", "bear", "wolf")
    
    println(colors.zip(animals) { color, animal -> "The ${animal.replaceFirstChar { it.uppercase() }} is $color"})
}

当你有一个 Pair 的 List 时，你可以进行反向转换——解压缩——它从这些对构建两个列表：

• 第一个列表包含原始列表中每个 Pair 的第一个元素。
• 第二个列表包含第二个元素。

若要解压缩一对列表，请调用 unzip()。

fun main() {
    val numberPairs = listOf("one" to 1, "two" to 2, "three" to 3, "four" to 4)
    println(numberPairs.unzip())
}

Associate

关联转换允许从集合元素及其关联的特定值构建映射。在不同的关联类型中，元素可以是关联映射中的键或值。

基本的关联函数 associateWith() 创建一个 Map，其中原始集合的元素是键，值则由给定的转换函数从它们生成。如果两个元素相等，则只有最后一个会保留在映射中。

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

若要构建以集合元素作为值的映射，可以使用函数 associateBy()。它接受一个函数，该函数根据元素的值返回一个键。如果两个元素的键相等，则只有最后一个会保留在映射中。

associateBy() 也可以与值转换函数一起调用。

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

    println(numbers.associateBy { it.first().uppercaseChar() })
    println(numbers.associateBy(keySelector = { it.first().uppercaseChar() }, valueTransform = { it.length }))
}

另一种构建映射的方式是使用函数 associate()，其中键和值都以某种方式从集合元素中生成。它接受一个返回 Pair 的 lambda 函数：对应映射条目的键和值。

请注意，associate() 会产生短生命周期的 Pair 对象，这可能会影响性能。因此，当性能不关键或比其他选项更可取时，才应该使用 associate()。

后者的一个例子是当键和相应的值一起从一个元素中生成时。

fun main() {
data class FullName (val firstName: String, val lastName: String)

fun parseFullName(fullName: String): FullName {
    val nameParts = fullName.split(" ")
    if (nameParts.size == 2) {
        return FullName(nameParts[0], nameParts[1])
    } else throw Exception("Wrong name format")
}

    val names = listOf("Alice Adams", "Brian Brown", "Clara Campbell")
    println(names.associate { name -> parseFullName(name).let { it.lastName to it.firstName } })  
}

在这里，我们首先在一个元素上调用一个转换函数，然后从该函数结果的属性构建一个对。

Flatten

如果你操作嵌套集合，你可能会发现标准库中提供对嵌套集合元素进行扁平化访问的函数很有用。

第一个函数是 flatten()。你可以在集合的集合上调用它，例如 Set 的 List。该函数会返回所有嵌套集合元素的单个 List。

fun main() {
    val numberSets = listOf(setOf(1, 2, 3), setOf(4, 5, 6), setOf(1, 2))
    println(numberSets.flatten())
}

另一个函数——flatMap() 提供了一种灵活的方式来处理嵌套集合。它接受一个将集合元素映射到另一个集合的函数。因此，flatMap() 返回其对所有元素调用的返回值的单个列表。所以，flatMap() 的行为类似于先调用 map()（以集合作为映射结果）再调用 flatten()。

data class StringContainer(val values: List<String>)

fun main() {
    val containers = listOf(
        StringContainer(listOf("one", "two", "three")),
        StringContainer(listOf("four", "five", "six")),
        StringContainer(listOf("seven", "eight"))
    )
    println(containers.flatMap { it.values })
}

字符串表示

如果你需要以可读格式检索集合内容，可以使用将集合转换为字符串的函数：joinToString() 和 joinTo()。

joinToString() 根据提供的参数，从集合元素构建一个单独的 String。joinTo() 作用相同，但将结果附加到给定的 Appendable 对象。

当使用默认参数调用时，这些函数返回的结果类似于在集合上调用 toString()：一个由元素字符串表示形式组成，用逗号和空格分隔的 String。

fun main() {
    val numbers = listOf("one", "two", "three", "four")
    
    println(numbers)         
    println(numbers.joinToString())
    
    val listString = StringBuffer("The list of numbers: ")
    numbers.joinTo(listString)
    println(listString)
}

若要构建自定义字符串表示形式，可以在函数参数 separator（分隔符）、prefix（前缀）和 postfix（后缀）中指定其参数。结果字符串将以 prefix 开头，以 postfix 结尾。separator 将出现在除最后一个元素之外的每个元素之后。

fun main() {
    val numbers = listOf("one", "two", "three", "four")    
    println(numbers.joinToString(separator = " | ", prefix = "start: ", postfix = ": end"))
}

对于较大集合，你可能希望指定 limit（限制）——将包含在结果中的元素数量。如果集合大小超过 limit，所有其他元素都将替换为 truncated（截断）参数的单个值。

fun main() {
    val numbers = (1..100).toList()
    println(numbers.joinToString(limit = 10, truncated = "<...>"))
}

最后，若要自定义元素本身的表示形式，请提供 transform（转换）函数。

fun main() {
    val numbers = listOf("one", "two", "three", "four")
    println(numbers.joinToString { "Element: ${it.uppercase()}"})
}