• for-range一个函数,还可以这么用?
  • 发布于 1个月前
  • 77 热度
    0 评论
Go 1.22 中可以 range 一个整数,比如下面的代码:
for i := range 10 {
    fmt.Println(i)
}
这个大家都已经知道了,其实对应的提案中还有一个隐藏的功能,就是可以 range 一个函数,比如下面的代码(摘自官方代码库internal/trace/v2/event.go[1]):
// Frames is an iterator over the frames in a Stack.
func (s Stack) Frames(yield func(f StackFrame) bool) bool {
 if s.id == 0 {
  return true
 }
 stk := s.table.stacks.mustGet(s.id)
 for _, f := range stk.frames {
  sf := StackFrame{
   PC:   f.pc,
   Func: s.table.strings.mustGet(f.funcID),
   File: s.table.strings.mustGet(f.fileID),
   Line: f.line,
  }
  if !yield(sf) {
   return false
  }
 }
 return true
}
就少有介绍了。
本文尝试介绍它,让读者先了解一下,它在 Go 1.22 中是一个实验性的功能,还不确定未来在哪个版本中会被正式支持。官方 wiki 中也有一篇介绍: Rangefunc Experiment[2],类似问答的形式,也是必读的知识库。

这个功能去年 Russ Cox 发起讨论(#56413[3]), 并建立一个提案(#61405[4]),大家讨论都很激烈啊,几百次的讨论,所以我也不准备介绍前因后果了,直接了当的说结论。 先前, for-range所能遍历(迭代)的类型很有限,只能是 slice、数组、map、字符串、channel 等。 现在,除了上面的五种类型,还可以是整数和三种三种函数。

当然for x := range n { ... }等价于for x := T(0); x < n; x++ { ... }, 其中 T 是 n 的类型。这个大家都知道了。

三个函数可能大家不是很了解,很正常,目前这只是一个实验性的功能。当然 range 的类型如下:
Range 表达式 第一个值 第二个值
array or slice a [n]E, *[n]E, or []E index i int a[i] E
string s string type index i int see below rune
map m map[K]V key k K m[k] V
channel c chan E, <-chan E element e E
integer n integer type index i int
function, 0 values f func(func()bool) bool

function, 1 value f func(func(V)bool) bool value v V
function, 2 values f func(func(K, V)bool) bool key k K v V
本文介绍的就是后三种形式

三种可遍历的函数
假设f是一个这样的函数:func(func()bool) bool, 那么for x := range f { ... }类似于f(func(x T1, y T2) bool { ... }),其中 for 循环移动到方法体中了。yield的 bool 返回值指示是否还要继续遍历。

对于这样一个f,下面的格式都可以:
for x, y := range f { ... }
for x, _ := range f { ... }
for _, y := range f { ... }
for x := range f { ... }
for range f { ... }
下面是一个例子:
 var fn = func(yield func(k int, v byte) bool) {
  for i := 0; i < 26; i++ {
   if !yield(i, byte('a'+i)) {
    return
   }
  }
 }
 // 堆代码 duidaima.com
 for k, v := range fn {
  fmt.Printf("%d: %c\n", k, v)
 }
运行可以看到结果符合预期,我们遍历了 26 个小写字母,注意 range 的数据类型是我们的函数:

这里,fn 这个函数没有返回值,其实也可以有 bool 返回值,有 bool 返回值就可以组合多个 range 函数,可以容易写出复杂且难以维护的代码,减少自己失业的可能。 这里的yield函数接收两个参数,第一个是int类型,第二个是byte类型,返回值是bool类型,这个yield函数的返回值决定了是否继续遍历。当然这里我们可以写泛型的程序,这里为了简单,就不写了。

下面是一个f是func(func(V)bool) bool的例子:
    var fn = func(yield func(v byte) bool) {
        for i := 0; i < 26; i++ {
            if !yield(byte('a' + i)) {
                return
            }
        }
    }

    for v := range fn {
        fmt.Printf("%c\n", v)
    }

当然 yield 函数也可以没有参数,比如func(func()bool) bool,下面这个例子就是无参数的形式,输出结果是 26。
package main

import "fmt"

func main() {
 var fn = func(yield func() bool) {
  for i := 0; i < 26; i++ {
   if !yield() {
    return
   }
  }
 }

 var count int
 for range fn {
  count++
 }
 fmt.Println(count)
}
如果不使用 for-range 函数的形式,我们可以进行改写,比如两个参数的列子:
 var fn = func(yield func(k int, v byte) bool) {
  for i := 0; i < 26; i++ {
   if !yield(i, byte('a'+i)) {
    return
   }
  }
 }

 fn(func(k int, v byte) bool {
  fmt.Printf("%d: %c\n", k, v)
  return true
 })
注意yield参数名称不是一个关键字,它只是一个普通的参数名称,可以随便取名字,但是为了模仿和其它语言中的generator,使用了yield这样一个名称,以至于代码更加易读。

看起来这个功能就是一个语法糖, 代码rangefunc/rewrite[5]将 range-over-func 代码写成非 range-over-func 代码的形式。

为什么要这样做?
标准库中就有 archive/tar.Reader.Next, bufio.Reader.ReadByte, bufio.Scanner.Scan, container/ring.Ring.Do, database/sql.Rows, expvar.Do, flag.Visit, go/token.FileSet.Iterate, path/filepath.Walk, go/token.FileSet.Iterate, runtime.Frames.Next 和sync.Map.Range等各种遍历的函数,所以如果有一种统一的格式更好。

第三方库中有更多的类似代码。虽然这个功能还没有正式支持,但是我看到有些库摩拳擦掌准备使用了,而sqlrange[6]更进一步,已经支持了。当然你使用它必须下载 Go 1.22 或者 gotip, 并且设置export GOEXPERIMENT=rangefunc。它提供了Query和Exec可遍历函数。比如Query从一个表中查询Point数据:
type Point struct {
    X float64 `sql:"x"`
    Y float64 `sql:"y"`
}

for p, err := range sqlrange.Query[Point](db, `select x, y from points` "Point") {
    if err != nil {
        ...
    }
    ...
}

遍历查询和 ORM 一气呵成。这里的资源管理是自动的,底层的*sql.Rows遍历完会自动关闭。


参考资料
[1]internal/trace/v2/event.go: https://github.com/golang/go/blob/97daa6e94296980b4aa2dac93a938a5edd95ce93/src/internal/trace/v2/event.go#L262
[2]Rangefunc Experiment: https://go.dev/wiki/RangefuncExperiment
[3]#56413: https://github.com/golang/go/discussions/56413
[4]#61405: https://github.com/golang/go/issues/61405
[5]rangefunc/rewrite: https://go.googlesource.com/go/+/refs/changes/41/510541/7/src/cmd/compile/internal/rangefunc/rewrite.go
[6]sqlrange: https://github.com/achille-roussel/sqlrange

用户评论