Go range-over-function 怎么提前停止并释放资源

Go 1.23 之后，for range 可以直接消费函数式迭代器。提前结束时，循环里的 break 会让迭代器收到停止信号；只要迭代器在自己的函数体里用 defer 释放资源，文件、连接或内部协程就能沿着返回路径收尾。这个契约的核心不是“手动调用 yield 停止”，而是：每次调用 yield 都检查返回值，得到 false 就立刻返回。

先把 range-over-function 的停止契约看清

使用 Go 1.22 新增的 range-over-function 语法遍历自定义迭代器时，只要在循环体内执行 break 退出遍历，运行时会自动调用迭代器声明的 cleanup 回调，完成文件句柄、数据库连接这类资源的正常释放，不需要额外手动写资源回收逻辑。

iter.Seq[V] 的真实形状是 func(yield func(V) bool)，Seq2 则把回调换成 func(K, V) bool。迭代器负责不断调用 yield，消费者负责返回是否继续。下面这张图中的 for range 消费端、break、yield 和 iter.Seq 是一条契约链；资源节点则属于迭代器自己的收尾边界。

提前停止：break 会把 false 传回迭代器

资源应该在迭代器开始真正工作后取得，并在同一函数里注册 defer。这样无论扫描完整个输入，还是消费者找到第一条匹配记录后 break，迭代器返回时都会执行关闭逻辑。

package main

import (
	"bufio"
	"io"
	"iter"
)

// Lines 在迭代开始时打开资源，并把关闭动作绑定到迭代器返回。
func Lines(open func() (io.ReadCloser, error)) iter.Seq[string] {
	return func(yield func(string) bool) {
		r, err := open()
		if err != nil {
			return // Seq 不能直接携带错误，生产代码可改用 Seq2
		}
		defer r.Close() // break 触发返回后，关闭动作仍会执行
		scanner := bufio.NewScanner(r)
		for scanner.Scan() {
			if !yield(scanner.Text()) {
				return // 消费者不需要后续行，停止推送
			}
		}
	}
}

func firstMatch(seq iter.Seq[string], want string) (string, bool) {
	for line := range seq {
		if line == want {
			return line, true // return 同样会结束 range 消费
		}
	}
	return "", false
}

这里的 return 和常见的 break 都代表“消费端不再要值”。迭代器实现还必须遵守另一半规则：yield 一旦返回 false 就立即返回，不能在后面再次调用它。

Seq2 适合把键值和错误放在同一条序列

如果打开资源、扫描数据本身可能失败，单值 Seq 容易把错误藏掉。可以用 Seq2[int, Row] 传出位置和值，再把错误作为值的一部分；这样消费者在发现目标或错误时都能停止，而不是继续读取无意义的数据。

type Row struct {
	Name string
	Err  error
}

// Rows 返回位置和值，调用者可以在首个错误或目标记录处停止。
func Rows(items []Row) iter.Seq2[int, Row] {
	return func(yield func(int, Row) bool) {
		for i, row := range items {
			if !yield(i, row) {
				return // Seq2 也必须尊重 false
			}
		}
	}
}

func findError(items []Row) (int, Row, bool) {
	for i, row := range Rows(items) {
		if row.Err != nil {
			return i, row, true // 提前结束，生产端随后返回
		}
	}
	return 0, Row{}, false
}

若错误需要单独表达，常见做法是定义带错误字段的元素，或另设计返回错误的构造函数；不要在 yield 已经返回 false 后继续塞入下一条数据。

需要拉取时用 iter.Pull：stop 必须兜底

for range 属于迭代器主动推送，循环退出时语言会帮它传达停止。iter.Pull 则把同一个 iter.Seq 转成 next 和 stop 两个函数：前者一次取一个值，后者负责让尚未完成的生产端退出。因此只要没有明确读到序列末尾，就应当立即写 defer stop()。

func same[E comparable](left, right iter.Seq[E]) bool {
	nextLeft, stopLeft := iter.Pull(left)
	defer stopLeft() // 比较失败或提前 return 时释放左侧迭代器
	nextRight, stopRight := iter.Pull(right)
	defer stopRight() // 两条序列分别负责自己的收尾

	for {
		lv, lok := nextLeft()
		rv, rok := nextRight()
		if lok != rok || (lok && lv != rv) {
			return false // stop 会在 return 后执行
		}
		if !lok {
			return true // 两边同时结束
		}
	}
}

检查清单可以压缩成三句：用 range 时在迭代器内部检查 yield；资源在迭代器内部用 defer 关闭；改用 Pull 时每个 stop 都用 defer 注册。这样正常结束、比较失败和提前返回会共享同一条清理路径。

相关问题

break 之后还会不会多读一条数据？

遵守契约的迭代器不会。消费者结束后，生成的 yield 会返回 false，生产端在下一次推送判断处返回。

Seq 和 Seq2 应该怎么选？

只传单个元素用 Seq；需要键值、索引值或元素加状态时用 Seq2，关键是让停止信号仍由回调的 bool 表达。

什么时候不能省略 stop？

只要 Pull 没有明确读到末尾，或者后续逻辑可能提前 return，就不要省略；defer stop() 是成本很低的兜底。