gitbook/朱涛 · Kotlin编程第一课/docs/495246.md

481 lines
18 KiB
Markdown
Raw Normal View History

2022-09-03 22:05:03 +08:00
# 25 | 集合操作符:你也会“看完就忘”吗?
你好,我是朱涛。
从这节课开始我们就正式进入源码篇的学习了。当我们学习一门知识的时候总是离不开What、Why和How。在前面的基础篇、协程篇当中我们已经弄清楚了 **Kotlin是什么**,以及**为什么要用Kotlin**。那么在这个模块里我们主要是来解决How的问题以此从根源上搞清楚Kotlin的底层实现原理。今天这节课我们先来搞定集合操作符的用法与原理。
对于大部分Java、C开发者来说可能都会对Kotlin的集合操作符感到头疼因为它们实在太多、太乱了。即使通过Kotlin官方文档把那些操作符一个个过了一遍但过一段时间在代码中遇到它们又会觉得陌生。**一看就会,看完就忘**
其实Kotlin的集合API本质上是一种**数据处理的模式**。
什么是数据处理模式可以想象一下对于1~10的数字来说我们找出其中的偶数那么这就是一种过滤的行为。我们计算出1~10的总和那么这就是一种求和的行为。所以从数据操作的角度来看Kotlin的操作符就可以分为几个大类过滤、转换、分组、分割、求和。
那么接下来我会根据一个统计学生成绩的案例来带你分析Kotlin的集合API的使用场景对于复杂的API我还会深入源码分析它们是如何实现的。这样你也就知道集合操作符的底层实现原理也能懂得如何在工作中灵活运用它们来解决实际问题。
好,让我们开始吧!
## 场景模拟:统计学生成绩
为了研究Kotlin集合API的使用场景我们先来模拟一个实际的生活场景统计学生成绩。
```plain
data class Student(
val name: String = "",
val score: Int = 0
)
val class1 = listOf(
Student("小明", 83),
Student("小红", 92),
Student("小李", 50),
Student("小白", 67),
Student("小琳", 72),
Student("小刚", 97),
Student("小强", 57),
Student("小林", 86)
)
val class2 = listOf(
Student("大明", 80),
Student("大红", 97),
Student("大李", 53),
Student("大白", 64),
Student("大琳", 76),
Student("大刚", 92),
Student("大强", 58),
Student("大林", 88)
)
```
这里我们定义了一个数据类Student然后有一个集合当中对应的就是学生的名字和成绩。
接下来我们就以这个场景来研究Kotlin的集合API。
## 过滤
比如说我们希望过滤1班里不及格的学生我们就可以用 **filter{}** 这个操作符这里的filter其实就是过滤的意思。
```plain
private fun filterNotPass() {
val result = class1.filter { it.score < 60 }
println(result)
}
/*
[Student(name=小李, score=50), Student(name=小强, score=57)]
*/
```
以上代码段的逻辑很简单读起来就像英语文本一样这里我们重点来看看filter{} 的源代码:
```plain
public inline fun <T> Iterable<T>.filter(predicate: (T) -> Boolean): List<T> {
// 创建了新的ArrayList<T>()集合
return filterTo(ArrayList<T>(), predicate)
}
public inline fun <T, C : MutableCollection<in T>> Iterable<T>.filterTo(destination: C, predicate: (T) -> Boolean): C {
for (element in this) if (predicate(element)) destination.add(element)
return destination
}
```
可以看到filter{} 其实是一个高阶函数它只有唯一的参数“predicate: (T) -> Boolean”这就是它的**过滤条件及过滤标准**,只有符合这个过滤条件的数据才会被保留下来。
而且对于List.filter{} 来说,它的内部还会创建一个新的 `ArrayList<T>()`,然后将符合过滤条件的元素添加进去,再返回这个新的集合。
而除了filter{} 以外Kotlin还提供了filterIndexed{}它的作用其实和filter{} 一样只是会额外带上集合元素的index即它的参数类型是“predicate: (index: Int, T) -> Boolean”。
还有一个是filterIsInstance(),这是我们在[第12讲](https://time.geekbang.org/column/article/481787)当中使用过的API它的作用是过滤集合当中特定类型的元素。如下所示
```plain
// 12讲当中的代码
inline fun <reified T> create(): T {
return Proxy.newProxyInstance(
T::class.java.classLoader,
arrayOf(T::class.java)
) { proxy, method, args ->
return@newProxyInstance method.annotations
// 注意这里
.filterIsInstance<GET>()
.takeIf { it.size == 1 }
?.let { invoke("$baseUrl${it[0].value}", method, args) }
} as T
}
// inline + reified = 类型实化
// ↓ ↓
public inline fun <reified R> Iterable<*>.filterIsInstance(): List<@kotlin.internal.NoInfer R> {
return filterIsInstanceTo(ArrayList<R>())
}
// inline + reified = 类型实化
// ↓ ↓
public inline fun <reified R, C : MutableCollection<in R>> Iterable<*>.filterIsInstanceTo(destination: C): C {
for (element in this) if (element is R) destination.add(element)
return destination
}
```
可以看到filterIsInstance的源代码逻辑也非常简单其中最关键的就是它借助了inline、reified这两个关键字实现了**类型实化**。这个知识点我们在12讲当中也介绍过它的作用就是让Kotlin的“伪泛型”变成“真泛型”。
Kotlin集合API当中的过滤操作我们也就分析完了。接下来我们看看**转换**API。
## 转换
现在,我们还是基于学生成绩统计的场景。不过,这次的需求是要把学生的名字隐藏掉一部分,原本的“小明”“小红”,要统一变成“小某某”。
那么对于这样的需求,我们用 **map{}** 就可以实现了。
```plain
private fun mapName() {
val result = class1.map { it.copy(name = "小某某") }
println(result)
}
/*
[Student(name=小某某, score=83),
Student(name=小某某, score=92),
Student(name=小某某, score=50),
Student(name=小某某, score=67),
Student(name=小某某, score=72),
Student(name=小某某, score=97),
Student(name=小某某, score=57),
Student(name=小某某, score=86)]
*/
```
这里需要注意虽然map这个单词的意思是“地图”但在当前的语境下map其实是**转换、映射**的意思这时候我们脑子要想到的是HashMap当中的map含义。
另外map的源码也很简单
```plain
public inline fun <T, R> Iterable<T>.map(transform: (T) -> R): List<R> {
return mapTo(ArrayList<R>(collectionSizeOrDefault(10)), transform)
}
public inline fun <T, R, C : MutableCollection<in R>> Iterable<T>.mapTo(destination: C, transform: (T) -> R): C {
for (item in this)
destination.add(transform(item))
return destination
}
```
本质上map就是对每一个集合元素都进行一次transform()方法的调用它的类型是“transform: (T) -> R”。
除了map以外还有一个比较有用的转换API**flatten**。它的作用是将嵌套的集合“**展开、铺平**成为一个非嵌套的集合”。我们来看一个简单的例子:
```plain
private fun testFlatten() {
val list = listOf(listOf(1, 2, 3), listOf(4, 5, 6))
val result = list.flatten()
println(result)
}
/*
[1, 2, 3, 4, 5, 6]
*/
```
假设我们现在想要过滤出1班、2班当中所有未及格的同学我们就可以结合flatten、filter来实现。
```plain
private fun filterAllNotPass() {
val result = listOf(class1, class2)
.flatten()
.filter { it.score < 60 }
println(result)
}
// flatten 源代码
public fun <T> Iterable<Iterable<T>>.flatten(): List<T> {
val result = ArrayList<T>()
for (element in this) {
result.addAll(element) // 注意addAll()
}
return result
}
/*
[Student(name=小李, score=50),
Student(name=小强, score=57),
Student(name=大李, score=53),
Student(name=大强, score=58)]
*/
```
在上面的代码中我们首先将嵌套的集合用flatten展平得到1班、2班所有同学的成绩然后直接使用filter就完成了。
另外如果你去看flatten的源代码你也会发现它的代码非常简单。本质上flatten就是一个for循环然后对每一个内部集合进行addAll()。
下面我们接着来看看分组API。
## 分组
现在我们还是基于学生成绩统计的场景。这次我们希望把学生们按照成绩的分数段进行分组50~59的学生为一组、60~69的学生为一组、70~79的学生为一组以此类推。
对于这样的需求我们可以使用Kotlin提供的 **groupBy{}**。比如说:
```plain
private fun groupStudent() {
val result = class1.groupBy { "${it.score / 10}0分组" }
println(result)
}
/*
{
80分组=[Student(name=小明, score=83), Student(name=小林, score=86)],
90分组=[Student(name=小红, score=92), Student(name=小刚, score=97)],
50分组=[Student(name=小李, score=50), Student(name=小强, score=57)],
60分组=[Student(name=小白, score=67)],
70分组=[Student(name=小琳, score=72)]}
*/
```
groupBy{} 的意思就是**以什么标准进行分组**。在这段代码里我们是以分数除以10得到的数字进行分组的最终它的返回值类型其实是 `Map<String, List<Student>>`
在[加餐1](https://time.geekbang.org/column/article/478106)当中其实我们也用过groupBy来完善那个单词频率统计程序
```plain
fun processText(text: String): List<WordFreq> {
return text
.clean()
.split(" ")
.filter { it != "" }
.groupBy { it } // 注意这里
.map { WordFreq(it.key, it.value.size) }
.sortedByDescending { it.frequency }
}
```
上面代码中的groupBy作用就是将所有的单词按照单词本身进行分类在这个阶段它的返回值是 `Map<String, List<String>>`
我们也再来看看groupBy的源代码。
```plain
public inline fun <T, K> Iterable<T>.groupBy(keySelector: (T) -> K): Map<K, List<T>> {
return groupByTo(LinkedHashMap<K, MutableList<T>>(), keySelector)
}
public inline fun <T, K, M : MutableMap<in K, MutableList<T>>> Iterable<T>.groupByTo(destination: M, keySelector: (T) -> K): M {
for (element in this) {
val key = keySelector(element)
// 注意这里
val list = destination.getOrPut(key) { ArrayList<T>() }
list.add(element)
}
return destination
}
public inline fun <K, V> MutableMap<K, V>.getOrPut(key: K, defaultValue: () -> V): V {
val value = get(key)
return if (value == null) {
val answer = defaultValue()
put(key, answer)
answer
} else {
value
}
}
```
从groupBy的源代码中我们可以看到它的本质就是用for循环遍历元素然后使用keySelector()计算出Map的Key再把其中所有的元素添加到对应Key当中去。注意在代码这里使用了一个 `getOrPut(key) { ArrayList<T>() }`它的作用就是尝试获取对应的key的值如果不存在的话就将 `ArrayList<T>()` 存进去。
接下来我们看看Kotlin的**分割API**。
## 分割
还是基于学生成绩统计的场景。这次,我们希望找出前三名和倒数后三名的学生。做法其实也很简单,我们使用 **take()** 就可以实现了。
```plain
private fun takeStudent() {
val first3 = class1
.sortedByDescending { it.score }
.take(3)
val last3 = class1
.sortedByDescending { it.score }
.takeLast(3)
println(first3)
println(last3)
}
/*
[Student(name=小刚, score=97), Student(name=小红, score=92), Student(name=小林, score=86)]
[Student(name=小白, score=67), Student(name=小强, score=57), Student(name=小李, score=50)]
*/
```
在上面的代码中我们先按照分数进行了降序排序然后使用了take、takeLast从列表当中取出前三个和后三个数据它们分别代表了成绩排在前三名、后三名的同学。
而除了take以外还有drop、dropLast它们的作用是**剔除**。
```plain
private fun dropStudent() {
val middle = class1
.sortedByDescending { it.score }
.drop(3)
.dropLast(3)
// 剔除前三名、后三名,剩余的学生
println(middle)
}
/*
[Student(name=小明, score=83), Student(name=小琳, score=72)]
*/
```
在上面的代码中,我们先把学生按照分数降序排序,然后剔除了前三名和后三名,得到了中间部分的学生。
另外Kotlin还提供了 **slice**使用这个API我们同样可以取出学生中的前三名、后三名。
```plain
private fun sliceStudent() {
val first3 = class1
.sortedByDescending { it.score }
.slice(0..2)
val size = class1.size
val last3 = class1
.sortedByDescending { it.score }
.slice(size - 3 until size)
println(first3)
println(last3)
}
/*
[Student(name=小刚, score=97), Student(name=小红, score=92), Student(name=小林, score=86)]
[Student(name=小白, score=67), Student(name=小强, score=57), Student(name=小李, score=50)]
*/
```
可以看到slice的作用是根据index来分割集合的当它与Range特定范围相结合的时候代码的可读性也是不错的。
## 求和
我们接着来看Kotlin的求和API。这一次还是基于学生成绩统计的场景我们希望计算全班学生的总分。
我们可以使用Kotlin提供的**sumOf、reduce、fold**。
```plain
private fun sumScore() {
val sum1 = class1.sumOf { it.score }
val sum2 = class1
.map { it.score }
.reduce { acc, score -> acc + score }
val sum3 = class1
.map { it.score }
.fold(0) { acc, score -> acc + score }
println(sum1)
println(sum2)
println(sum3)
}
/*
604
604
604
*/
```
总的来说sumOf能做到的事情reduce可以想办法做而reduce可以做到的事情fold也可以做到。它们的使用场景是具备包含关系的。
* **sumOf{}** 仅可以用于数字类型的数据进行求和的场景。
* **reduce**本质上是对数据进行遍历然后进行某种“广义求和”的操作这里不局限于数字类型。我们使用reduce也可以进行字符串拼接。相当于说这里的求和规则是我们从外部传进来的。
* **fold**对比reduce来说只是多了一个初始值其他都跟reduce一样。
比如下面这段代码我们就使用了reduce、fold进行了字符串拼接
```plain
private fun joinScore() {
val sum2 = class1
.map { it.score.toString() }
.reduce { acc, score -> acc + score }
val sum3 = class1
.map { it.score.toString() }
.fold("Prefix=") { acc, score -> acc + score }
println(sum2)
println(sum3)
}
/*
8392506772975786
Prefix=8392506772975786
*/
```
所以reduce就是fold的一种特殊情况。也就是说fold不需要初始值的时候就是reduce。我们可以来看看它们的源码定义
```plain
public inline fun <S, T : S> Iterable<T>.reduce(operation: (acc: S, T) -> S): S {
val iterator = this.iterator()
if (!iterator.hasNext()) throw UnsupportedOperationException("Empty collection can't be reduced.")
var accumulator: S = iterator.next()
while (iterator.hasNext()) {
accumulator = operation(accumulator, iterator.next())
}
return accumulator
}
public inline fun <T, R> Iterable<T>.fold(initial: R, operation: (acc: R, T) -> R): R {
var accumulator = initial
for (element in this) accumulator = operation(accumulator, element)
return accumulator
}
```
根据以上定义可以发现fold和reduce的名字虽然看起来很高大上但它们的实现原理其实非常简单就是一个简单的for循环。而reduce之所以看起来比fold要复杂一点的原因在于**reduce需要兼容集合为空的情况fold不需要因为fold具备初始值**。
## 小结
好,这节课的内容就到这里了,我们来做一个简单的总结。
Kotlin的集合API主要分为这几个大类过滤、转换、分组、分割、求和。
* 过滤filter、filterIsInstance前者是以**条件过滤**,后者是以**类型过滤**后者运用了Kotlin的**类型实化**。
* 转换map、flatten前者是**转换集合元素**,后者是**转换集合的嵌套层级**flatten会把嵌套的集合**展平**。
* 分组groupBy即**以什么标准进行分组**,它的返回值类型往往会是 `Map<K, List<T>>`
* 分割take、drop、slice。take代表从集合中**提取**drop代表从集合中**剔除**slice代表以**特定范围**Range进行切割。
* 求和sumOf、reduce、fold。sumOf只适用于数字类型的求和reduce、fold则能够以特定规则对集合元素进行“广义的求和”其中的“求和规则”我们可以灵活自定义比如字符串拼接。
![](https://static001.geekbang.org/resource/image/ee/5e/ee951f5853d081ccc75d13cc49c29f5e.jpg?wh=2000x546)
其实经过前面几十节课的学习现在我们分析Kotlin集合的源代码整个过程都是非常轻松的。因为它们无非就是**高阶函数与for循环的简单结合**。而你需要特别注意的是以上所有的操作符都不会修改原本的集合它们返回的集合是一个全新的集合。这也体现出了Kotlin推崇的不变性和无副作用这两个特性。
另外正如我前面所讲的Kotlin的集合API不仅仅是Kotlin集合特有的API而是一种广泛存在的**数据处理的模式**。所以你会发现Kotlin的集合操作符跟Kotlin的Sequence、Flow里面的操作符也是高度重叠的。不仅如此这些操作符跟Java 8、C#、Scala、Python等语言的API也高度重叠。
而这就意味着通过这节课的学习你不仅可以对Kotlin的Flow、Sequence有更全面的认识将来你接触其他计算机语言的时候也可以轻松上手。
## 思考题
前面我们提到过Kotlin的集合操作符都不会修改原本的集合它们返回的集合是一个全新的集合。这恰好就体现出了Kotlin推崇的不变性和无副作用的特点。那么请问这样的方式是否存在劣势我们平时该如何取舍
欢迎在留言区分享你的答案,也欢迎你把今天的内容分享给更多的朋友。