Go range函數(shù)

Go 1.22 中可以 range 一個整數(shù)，比如下面的代碼：

for i := range 10 {
    fmt.Println(i)
}

這個大家都已經(jīng)知道了，其實(shí)對應(yīng)的提案中還有一個隱藏的功能，就是可以 range 一個函數(shù)，比如下面的代碼(摘自官方代碼庫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 中是一個實(shí)驗(yàn)性的功能，還不確定未來在哪個版本中會被正式支持。

官方 wiki 中也有一篇介紹: Rangefunc Experiment[2]，類似問答的形式，也是必讀的知識庫。

這個功能去年 Russ Cox 發(fā)起討論(#56413[3]), 并建立一個提案(#61405[4]),大家討論都很激烈啊，幾百次的討論，所以我也不準(zhǔn)備介紹前因后果了，直接了當(dāng)?shù)恼f結(jié)論。 先前, for-range所能遍歷(迭代)的類型很有限，只能是 slice、數(shù)組、map、字符串、channel 等。 現(xiàn)在，除了上面的五種類型，還可以是整數(shù)和三種三種函數(shù)。

當(dāng)然for x := range n { ... }等價于for x := T(0); x < n; x++ { ... }, 其中 T 是 n 的類型。這個大家都知道了。

range 的類型

三個函數(shù)可能大家不是很了解，很正常，目前這只是一個實(shí)驗(yàn)性的功能。當(dāng)然 range 的類型如下：

本文介紹的就是后三種形式

三種可遍歷的函數(shù)

假設(shè)f是一個這樣的函數(shù):func(func()bool) bool, 那么for x := range f { ... }類似于f(func(x T1, y T2) bool { ... })，其中 for 循環(huán)移動到方法體中了。yield的 bool 返回值指示是否還要繼續(xù)遍歷。

對于這樣一個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
   }
  }
 }

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

運(yùn)行可以看到結(jié)果符合預(yù)期，我們遍歷了 26 個小寫字母，注意 range 的數(shù)據(jù)類型是我們的函數(shù):

這里，fn 這個函數(shù)沒有返回值，其實(shí)也可以有 bool 返回值，有 bool 返回值就可以組合多個 range 函數(shù)，可以容易寫出復(fù)雜且難以維護(hù)的代碼，減少自己失業(yè)的可能。 這里的yield函數(shù)接收兩個參數(shù)，第一個是int類型，第二個是byte類型，返回值是bool類型，這個yield函數(shù)的返回值決定了是否繼續(xù)遍歷。當(dāng)然這里我們可以寫泛型的程序，這里為了簡單，就不寫了。

下面是一個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)
    }

當(dāng)然 yield 函數(shù)也可以沒有參數(shù)，比如func(func()bool) bool，下面這個例子就是無參數(shù)的形式，輸出結(jié)果是 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 函數(shù)的形式，我們可以進(jìn)行改寫，比如兩個參數(shù)的列子：

 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參數(shù)名稱不是一個關(guān)鍵字，它只是一個普通的參數(shù)名稱，可以隨便取名字，但是為了模仿和其它語言中的generator,使用了yield這樣一個名稱，以至于代碼更加易讀。

看起來這個功能就是一個語法糖， 代碼rangefunc/rewrite[5]將 range-over-func 代碼寫成非 range-over-func 代碼的形式。

為什么要這樣做？

標(biāo)準(zhǔn)庫中就有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等各種遍歷的函數(shù)，所以如果有一種統(tǒng)一的格式更好。

第三方庫中有更多的類似代碼。

雖然這個功能還沒有正式支持，但是我看到有些庫摩拳擦掌準(zhǔn)備使用了，而sqlrange[6]更進(jìn)一步，已經(jīng)支持了。

當(dāng)然你使用它必須下載 Go 1.22 或者 gotip, 并且設(shè)置export GOEXPERIMENT=rangefunc。

它提供了Query和Exec可遍歷函數(shù)。比如Query從一個表中查詢Point數(shù)據(jù)：

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遍歷完會自動關(guān)閉。

參考文檔

[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 

以上就是Go語言for-range函數(shù)使用技巧實(shí)例探究的詳細(xì)內(nèi)容，更多關(guān)于go for-range函數(shù)的資料請關(guān)注腳本之家其它相關(guān)文章！

最新評論