Go range over func 怎样让函数迭代器支持提前停止完成一个可复用的最小示例

如果一个旧项目用回调函数遍历集合，调用方通常只能在回调里设置一个“停止”变量，生产端还要额外检查这个变量。Go 1.23 之后，函数可以直接作为 for range 的范围表达式，停止信号由循环自动传回 yield，迁移后的接口更接近普通集合遍历。

官方地址：https://go.dev/blog/range-functions

最小做法是返回 iter.Seq[T]，在迭代器内部逐项调用 yield(item)；当它返回 false 时立即 return。调用方只需要在达到配额时 break，不再读取后续元素。

升级范围：先确认函数迭代器的版本边界

这次迁移依赖 Go 1.23 的语言变化。可参与 range 的函数不是任意函数，而是下面三种形状之一：只产生副作用的 func(func() bool)、产生一个值的 func(func(V) bool)，以及产生键值对的 func(func(K, V) bool)。标准库 iter.Seq[V] 就是第二种形状的命名类型。

变更对照：从旧式回调到 range over func

旧接口也能实现提前停止，但停止状态往往散落在回调闭包和生产循环之间，接口读起来不像一个普通集合。下面的旧写法只作为迁移对照，重点是它需要调用方显式返回一个布尔值，并由生产端决定是否检查。

package legacy

// Walk 使用旧式回调遍历；回调返回 false 表示不再需要后续元素。
func Walk(items []string, visit func(string) bool) {
	for _, item := range items {
		if !visit(item) {
			return // 生产端必须理解并遵守回调的停止协议。
		}
	}
}

这个接口并没有错，问题在于调用方不能写成自然的 for item := range ...，也很难把同一遍历器组合到其他支持范围遍历的工具中。迁移目标不是为了追求新语法，而是把“逐项产生数据”和“消费者何时结束”固定成统一协议。

新写法：让 iter.Seq 接住提前停止

下面的 Names 返回一个可复用的 iter.Seq[string]。消费者达到上限后执行 break，范围循环会让当前 yield 返回 false，迭代器检查到这个结果后退出。

package main

import (
	"fmt"
	"iter"
)

// Names 把只读切片包装成函数迭代器，避免先复制一份结果切片。
func Names(items []string) iter.Seq[string] {
	return func(yield func(string) bool) {
		for _, item := range items {
			if !yield(item) {
				return // 消费者 break 后，停止读取剩余元素。
			}
		}
	}
}

func main() {
	seen := 0
	for name := range Names([]string{"甲", "乙", "丙", "丁"}) {
		fmt.Println(name)
		seen++
		if seen == 2 {
			break // 这会让迭代器中的 yield 返回 false。
		}
	}
}

这里的提前停止是协议的一部分，不是一个约定俗成的标志变量。迭代器一旦收到 false，就不能再次调用 yield；如果迭代器持有文件、锁或其他资源，也应在 return 前完成清理。

回归检查：不要把 break 误解成并发安全

迁移后可以按这几个问题检查接口：

• 是否支持旧版本？如果模块仍需 Go 1.22 或更早版本，就不能在没有隔离措施的文件中直接使用该语法，应按项目兼容策略保留旧实现或使用构建约束。
• 是否还有后续调用？生产循环必须在 yield 返回 false 时立刻结束，不能继续发送数据。
• 底层数据是否会被修改？iter.Seq 不会自动提供快照；遍历期间并发写入同一切片仍需由调用方同步。
• 真的减少分配了吗？它可以省掉“先生成完整临时切片”这类中间容器，但闭包捕获、元素复制和业务 I/O 仍可能产生成本，结论应由 go test -benchmem 的对比结果决定。

迁移清单：什么时候值得换成函数迭代器

如果接口的主要任务是按顺序提供数据，且消费者经常只取前几项，返回 iter.Seq[T] 通常很合适；如果调用方需要排序、随机访问、重复遍历或修改集合，直接返回切片反而更直观。迁移时先固定元素顺序和并发约定，再把旧回调的停止逻辑移动到 yield=false 分支，最后用基准测试确认是否真的减少了中间分配。

一句话复盘：range over func 让函数迭代器拥有了 Go 原生范围遍历的消费方式，而提前停止的关键始终是生产端检查并尊重 yield 返回的 false。

相关问题

range over func 从哪个 Go 版本开始？Go 1.23 开始，range 支持符合约定签名的迭代器函数。

为什么 break 能停止函数迭代器？范围循环会把循环结束状态传回 yield，迭代器收到 false 后 return。

iter.Seq 能保证零分配吗？不能；它主要消除中间结果容器，闭包逃逸、元素大小和实际业务操作仍需单独测量。