仓颉 std.collection 迭代器操作函数实战:filter / step / skip 与 pipeline 流水线编程
仓颉 std.collection 迭代器操作函数实战:filter / step / skip 与 pipeline 流水线编程
本文以 迭代器操作函数用例 为骨架,系统讲解仓颉标准库 std.collection 中迭代器操作函数(filter、step、skip、forEach、collectString、contains 等)与 pipeline(|>)表达式组合使用的完整方法。读完本文,你将掌握"先构造变换函数、再以管道方式串联作用于集合"的函数式迭代风格,理解每个操作函数的参数语义与边界行为,并能够独立写出可运行的流水线式集合处理代码。
迭代器操作函数:为什么能与 pipeline 天然配合
std.collection 包在提供常见数据结构(ArrayList、HashMap、HashSet、TreeSet 等)的同时,还提供了一批面向 Iterable<T> 的集合操作函数,完整清单见 集合操作函数列表。这些函数的一个显著特点是采用柯里化(currying)式签名:先接收操作参数,返回一个"待作用于迭代器的函数",再将该函数应用到 Iterable<T> 上。例如:
filter<T>(predicate: (T) -> Bool): (Iterable<T>) -> Iterator<T>step<T>(count: Int64): (Iterable<T>) -> Iterator<T>skip<T>(count: Int64): (Iterable<T>) -> Iterator<T>forEach<T>(action: (T) -> Unit): (Iterable<T>) -> Unit
这种"先给参数、后给数据"的设计,恰好匹配仓颉语言的 pipeline 表达式 a |> f(等价于 f(a))的求值顺序:把迭代器写在管道左侧,把操作函数写在右侧,数据自左向右流动,多个操作自然串联成一条处理流水线。这也是本文样例能够写成"一步一 |>"的根本原因。
完整用例代码
以下代码完整引自 sample_iterator.md(原文档带有 <!-- verify --> 验证标记,即该用例经过实际编译运行校验):
import std.collection.*
main() {
let arr = [-1, 2, 3, 4, 5, 6, 7, 8, 9]
arr |> filter{a: Int64 => a > 0} |> // filter -1
step<Int64>(2) |> // [2, 4, 6, 8]
skip<Int64>(2) |> // [6, 8]
forEach<Int64>(println)
let str = arr |> filter{a: Int64 => a % 2 == 1} |> collectString<Int64>(delimiter: ">")
println(str)
println(arr |> contains(6_i64))
return 0
}
运行结果:
6
8
3>5>7>9
true
可以看到,一条管道完成"筛选 → 步进取样 → 跳过 → 遍历输出",另一条管道完成"筛选 → 拼接字符串",最后还用 contains 做了一次元素存在性判断。下面逐环节拆解。
第一条管道:filter → step → skip → forEach
1. filter:按谓词筛选
arr |> filter{a: Int64 => a > 0} 等价于 filter{a: Int64 => a > 0}(arr)。谓词 {a: Int64 => a > 0} 对每个元素求值,只保留返回 true 的元素,因此 -1 被过滤掉(代码注释 // filter -1 即指此意),得到中间序列 [2, 3, 4, 5, 6, 7, 8, 9]。
从函数签名看,filter 返回的是一个新的 Iterator<T>,而不是修改原迭代器,因此它属于"产生新迭代器"的中间操作。关于该函数的完整签名与参数说明,见 collection_package_function.md。
2. step:步进取样
step<Int64>(2) 作用于 [2, 3, 4, 5, 6, 7, 8, 9],得到 [2, 4, 6, 8]。根据 API 文档,step(count) 的功能是"迭代器每次调用 next() 跳过特定个数":每取出一个元素,后续调用 next() 时跳过 count 个元素,直到迭代器为空。因此步长取 2 时,取索引 0、2、4、6 位置的元素。
注意 step 的参数约束:当 count <= 0 时抛出 IllegalArgumentException。与下文 skip 不同,step 不允许 count 为 0 或负数。
3. skip:跳过前 N 个元素
skip<Int64>(2) 作用于 [2, 4, 6, 8],跳过最前面的 2 个元素,得到 [6, 8]。skip 的完整语义(来自 API 文档)为:
count < 0:抛出IllegalArgumentException;count == 0:不跳过任何元素,返回原迭代器;0 < count < 迭代器大小:跳过前count个元素,返回含剩余元素的新迭代器;count >= 迭代器大小:跳过全部元素,返回空迭代器。
step 与 skip 的差异是理解本用例的关键:skip 是"一次性丢弃开头若干个元素",step 是"取样时按固定间隔跳步",两者都可以用于抽取子序列,但语义与参数边界完全不同。
4. forEach:终止操作,遍历输出
forEach<Int64>(println) 对剩余元素 [6, 8] 逐个执行 println,因此在控制台输出两行 6 和 8。forEach 的签名是 (T) -> Unit,它不返回新迭代器,而是直接遍历全部元素执行副作用,属于终止操作(详见后文"中间操作与终止操作")。
第二条管道:filter → collectString 字符串拼接
let str = arr |> filter{a: Int64 => a % 2 == 1} |> collectString<Int64>(delimiter: ">")
先筛选出奇数:arr 中满足 a % 2 == 1 的元素为 3, 5, 7, 9。这里有一个值得注意的细节:-1 虽然在数学上是奇数,但从运行结果 3>5>7>9 可知,仓颉对负数取模的结果符号与除数相关(-1 % 2 的结果为 -1),因此 -1 并不满足 a % 2 == 1,被一并过滤。这一点也从侧面说明:筛选谓词的行为必须以实际运行结果为准,不能想当然套用数学直觉。
collectString<T>(delimiter: String = "") 要求元素类型 T <: ToString,将迭代器中的每个元素转换为字符串,并用 delimiter 指定的分隔符拼接。delimiter 是带默认值的具名参数,默认值为空字符串;本用例传入 ">",因此输出 3>5>7>9。若改为 delimiter: ", ",输出将变为 3, 5, 7, 9。该函数是"迭代器转字符串"的便捷工具,比手写循环拼接更简洁。
contains:元素存在性判断
println(arr |> contains(6_i64))
contains<T>(element: T): (Iterable<T>) -> Bool(约束 T <: Equatable<T>)遍历迭代器,判断其中是否包含指定元素,输出 true。注意示例中传入的是 6_i64——仓颉的整型字面量后缀,确保与数组元素类型 Int64 一致,避免类型不匹配。这条管道也体现了柯里化风格:contains(6_i64) 先绑定待查找元素,再作用于 arr。
参数语义速查
下表汇总本文涉及的迭代器操作函数及其边界行为(依据 collection_package_function.md):
| 函数 | 签名要点 | 参数边界与异常 |
|---|---|---|
filter<T> |
(predicate: (T) -> Bool) -> (Iterable<T>) -> Iterator<T> |
谓词返回 true 则保留 |
step<T> |
(count: Int64) -> (Iterable<T>) -> Iterator<T> |
count <= 0 抛 IllegalArgumentException;每次取一个后跳过 count 个 |
skip<T> |
(count: Int64) -> (Iterable<T>) -> Iterator<T> |
count < 0 抛异常;count == 0 原样返回;count >= 大小 返回空迭代器 |
forEach<T> |
(action: (T) -> Unit) -> (Iterable<T>) -> Unit |
遍历全部元素执行副作用 |
collectString<T> |
(delimiter!: String = "") -> (Iterable<T>) -> String,T <: ToString |
分隔符默认 "" |
contains<T> |
(element: T) -> (Iterable<T>) -> Bool,T <: Equatable<T> |
命中即返回 true |
std.collection 还提供 take、map、flatMap、fold、reduce、zip 等同类函数,均可按同样的管道方式组合使用,完整清单见 collection_package_overview.md 的函数列表。
中间操作与终止操作
理解迭代器操作函数,还需要区分两类性质不同的操作。在 core 包 Iterator 类的 API 文档 中有明确说明:
- 中间操作(如
skip、step、map、filter):产生一个新的迭代器,返回类型为Iterator<T>,可以在其上继续串联后续操作; - 终止操作(如
count、all、any、forEach):根据迭代器产生的元素计算结果,不产生新迭代器,通常位于管道末尾。
每种迭代器方法都会消耗迭代器中不同数量的元素。掌握这一分类,有助于判断一个管道在哪里"收尾"、返回值是什么类型,避免把终止操作的返回值继续 |> 下去导致编译错误。
对比:迭代器的三种消费方式
std.collection 的样例集中,除了本文的管道式遍历,还展示了其他两种迭代方式,可作为对照:
- 管道式(本文):
arr |> filter{...} |> forEach(println),声明式、可读性最好; while+match手动遍历:见 HashSet 的 add/iterator/remove 用例,通过set.iterator()获取迭代器,循环调用next()并以match匹配Some(v)/None决定是否结束;for-in遍历:见 TreeSet 的 add/iterator/remove 用例,for (e in itset)直接遍历迭代器。
三种方式殊途同归,管道式写法在需要"筛选 + 变换 + 截取 + 聚合"多步组合时最简洁;而手动 next() 遍历则适合需要在中途打断或访问底层 Option<T> 返回值的场景。
小结
本文以 sample_iterator.md 为骨架,完整还原了 filter、step、skip、forEach、collectString、contains 六个迭代器操作函数与 pipeline 表达式的组合用法,并补充了参数边界、异常行为、中间/终止操作分类等底层语义。参照文中代码,你可以在自己的仓颉项目中直接运行并扩展——把 step/skip 换成 take/map/flatMap,把 collectString 换成 collectArrayList、collectArray 或 collectHashSet,即可灵活应对大部分集合处理需求。