Go range over function 迭代器如何把停止信号传给生产方

用 range 遍历函数迭代器时，停止信号不是额外的 context，也不是生产方自己猜出来的状态：当循环因为 break 或 return 提前结束，Go 生成的 yield 回调会返回 false。迭代器每次调用 yield 后都要立刻判断这个布尔值，收到 false 就返回；如果改用 iter.Pull 手动读取，则要用 defer stop() 释放未读完的生产资源。

range over function 的停止信号来自哪里

Go 1.23 起，for range 支持三种函数形态：func(yield func() bool)、func(yield func(V) bool) 和 func(yield func(K, V) bool)。标准库把后两种常用形态命名为 iter.Seq 与 iter.Seq2。生产方负责“推送”值，循环体负责消费值，二者之间唯一重要的停止合同就是 yield 的布尔返回值。

下面这个例子只在找到第一个高优先级任务后停止。return 离开函数时，正在执行的 range 循环会结束，迭代器下一次不应再调用 yield。

package main

import "iter"

type Task struct {
	Name  string
	Level string
}

func Tasks(items []Task) iter.Seq[Task] {
	return func(yield func(Task) bool) {
		for _, item := range items {
			// yield 返回 false 代表消费者不再需要后续任务。
			if !yield(item) {
				return
			}
		}
	}
}

func FirstCritical(items []Task) (Task, bool) {
	for item := range Tasks(items) {
		if item.Level == "critical" {
			// return 会让 range 生成的 yield 返回 false。
			return item, true
		}
	}
	return Task{}, false
}

生产方为什么必须立刻判断 yield 返回值

yield 不是普通的“写入函数”。消费者结束循环后，它已经表示“不允许再提供值”。如果生产方忽略返回值，继续调用 yield，就违反了迭代器合同；这类错误往往出现在把旧的 Push(func(V) bool) 改成 iter.Seq[V] 时。

生产方还可能持有文件、网络连接、锁或后台 goroutine。把清理放到 defer，再在 yield 返回 false 时走同一个返回路径，能同时覆盖正常耗尽和提前停止：

func Records(src []Task) iter.Seq[Task] {
	return func(yield func(Task) bool) {
		// 真实代码可在这里打开资源，并让 defer 统一收尾。
		for _, record := range src {
			// 每次推送后立即判断，不能把判断挪到下一轮。
			if !yield(record) {
				return
			}
		}
	}
}

这里不要额外加一个“消费者已取消”的共享变量来替代 yield 返回值。只要迭代器本身是同步调用链，布尔返回已经是最短、最明确的反馈通道；只有生产方内部启动了独立 goroutine 时，才需要额外设计资源退出机制，并确保它能被这条返回路径触发。

break、return、正常耗尽分别意味着什么

例如只取前两条记录时，消费者不需要知道生产方内部是切片、树还是网络适配器：

count := 0
for record := range Records(items) {
	// 处理当前记录，达到上限后让 yield 收到停止反馈。
	consume(record)
	count++
	if count == 2 {
		break
	}
}

手动拉取时为什么必须 defer stop

普通 range 会替调用方处理停止反馈；但 iter.Pull 把 push 迭代器转换成 next 与 stop 两个函数后，调用方自己掌握读取边界。只读到一半就返回时，必须调用 stop，否则底层生产方可能仍在等待或持有资源。

func FindPair(items []Task) (Task, bool) {
	next, stop := iter.Pull(Tasks(items))
	defer stop() // 手动拉取提前返回时，确保迭代器收到停止信号。

	for {
		item, ok := next()
		if !ok {
			return Task{}, false
		}
		if item.Level == "critical" {
			// defer stop 会处理尚未读完的剩余序列。
			return item, true
		}
	}
}

选择规则很简单：一个顺序消费循环优先直接 range；需要并行比较两个序列、和旧式逐次读取 API 对接，或必须在每次读取后做决定时，再使用 iter.Pull。两者底层都依赖同一个原则：停止必须回到生产方。

相关问题

yield 返回 false 是谁返回的？

使用 range 时是编译器生成的回调根据循环是否继续来返回；迭代器生产方只负责读取并尊重这个结果。

只遍历切片也需要 stop 吗？

直接 range 一个内存切片通常不需要额外 stop，但自定义迭代器若打开资源或启动 goroutine，仍应在迭代器内部用 defer 清理。

range over function 从哪个 Go 版本开始支持？

该语言能力随 Go 1.23 引入；项目若要兼容更早版本，应继续使用普通函数调用、切片或已有的 pull 式接口。