Go1.23 新特性：爭議最大的 iter 迭代器，可遍歷萬物！
大家好，我是煎魚。
Go1.23 新版本中，在發布過程中爭議最大的新特性莫過于：迭代器（iterators）。
原本計劃先寫一個這個 proposal 的提出背景的，但沒想到，迭代器涉及的到 proposal 比較多，而且是由 rsc 親自負責。
總感覺 rsc 早有預謀，在 Go1.23 蓄力一擊，搞完就撤了。
Go1.23 新特性：迭代器
提出過程
我能翻到的最早明確提出要加迭代器是在 discussions/54245[1] 中進行了廣泛討論：
圖片
隨后折騰了許久，最終 rsc 牽頭在 discussions/56413[2] 做了初步敲定：
圖片
后面今年 《spec: add range over int, range over func》[3]，包含在 for-range int 和 function 中再次沖擊新特性：
圖片
我就不一一列舉和解釋了。大家可以理解為比較折騰高密度講了很久。
為什么要做
根據 Go 官方幾個 issues 和 discussions 的說法，匯總一下。具體緣由如下：
- 其他編程語言有提供：大多數變成語言都提供了使用迭代器接口遍歷存儲在容器中的值的標準化方法。
- Go 就差迭代器沒提供了：Go 提供了可用于 map、slices、stings、 array 和 channel 的 for range，但沒有為用戶編寫的容器提供任何通用機制，也沒有提供迭代器接口。
- 現在大家都各自為政：社區和官方最終采用了各種各樣的方法去實現類似功能，每種實現都采用了在當時情況下最合理的方法，但各自為政的決定卻給用戶帶來了許多困惑。
“容器” 指代的是什么
有同學會疑惑第一點中提到的容器是什么？
實際上指代的是：使用迭代器 “提供一種按順序訪問聚合對象元素的方法，而無需暴露其底層表現”。
這句話中所說的聚合對象就是上文中所提到的容器。聚合對象或容器只是一個包含其他值的值。
Go 標準庫里的各自實現
具體 Go 標準庫中各自為政的。例如：
- runtime.CallersFrames：Frames.Next 方法。
- bufio.Scanner：Scanner.Scan 方法。
- database/sql.Rows：Rows.Scan 和配套 Rows.Next 方法。
有興趣的可以自己看一下函數調用或實現。
平時寫業務代碼都會接觸到。這里就不深入展開了。
Go1.23 迭代器介紹
功能說明
在 Go 1.23 中，將會同時支持用戶定義容器類型的 for-range 和標準化形式的迭代器。
本次新版本中：
- 擴展了 for/range 語句，使其支持對函數類型的取值范圍。
- 添加了標準庫類型和函數，以支持將函數類型用作迭代器。
后續通過新增的迭代器的標準定義，我們編寫的函數可以順利地與不同的容器類型配合使用。
有種可以循環遍歷萬物的感覺。
迭代器的快速例子
以下是 Go1.23 中迭代器的一些基礎的標準例子。
分別包含：單值迭代器和二值迭代器。
前置知識：yield
在 Go 中，yield 關鍵字的引入使得函數可以像迭代器一樣工作。這一特性是在 Go 1.22 版本中被提出的，允許函數在執行過程中暫時掛起，并返回一個或多個值。
這種機制與其他編程語言（如：Python）中的 yield 關鍵字有些相似，但在 Go 中實現的方式有所不同。
以下是關于 Go 中 yield 關鍵字的一些關鍵點：
- 功能：yield 關鍵字使得函數能夠在執行時返回一個或多個值，并在下次調用時從上次返回的地方繼續執行。這樣可以有效地處理大量數據而不需要一次性加載所有數據。
- 用法：在 Go 中，yield 并不是一個獨立的關鍵字，而是作為一種函數參數的形式出現。具體來說，函數可以接受一個 yield 函數作為參數，該函數負責接收生成的值并返回一個布爾值，指示是否繼續迭代。
例子一：單值迭代器（iter.Seq）
示例代碼如下：
import (
"fmt"
"iter"
)
func Stat(v int) iter.Seq[int] {
return func(yield func(int) bool) {
for i := v; i >= 0; i-- {
if !yield(i) {
return
}
}
}
}
func main() {
for v := range Stat(11) {
fmt.Println(v)
}
}輸出結果：
11
10
9
8
7
6
5
4
3
2
1
0例子二：二值迭代器（iter.Seq2）
示例代碼如下：
func Backward[E any](s []E "E any") iter.Seq2[int, E] {
return func(yield func(int, E) bool) {
for i := len(s) - 1; i >= 0; i-- {
if !yield(i, s[i]) {
return
}
}
}
}
func main() {
sl := []string{"腦子", "進", "煎魚", "了"}
for i, s := range Backward(sl) {
fmt.Printf("%d: %s\n", i, s)
}
}輸出結果：
3: 了
2: 煎魚
1: 進
0: 腦子標準庫內的迭代器使用
slices
本次 Go1.23 在 slices 標準庫中針對迭代器，新增了：slices.All、slices.Values、slices.Collect 方法。
函數簽名如下：
func All[Slice ~[]E, E any](s Slice "Slice ~[]E, E any") iter.Seq2[int, E]
func Values[Slice ~[]E, E any](s Slice "Slice ~[]E, E any") iter.Seq[E]
func Collect[E any](seq iter.Seq[E] "E any") []E示例代碼如下：
func main() {
s1 := []int{1, 2, 3}
for k, v := range slices.All(s1) {
fmt.Println("k:", k, "v:", v)
}
for v := range slices.Values(s1) {
fmt.Println(v)
}
// slices.Collect 會將迭代器中的值收集到一個新的切片中并返回它
s2 := slices.Collect(slices.Values([]int{1, 2, 3}))
fmt.Println(s2)
}輸出結果：
k: 0 v: 1
k: 1 v: 2
k: 2 v: 3
1
2
3
[1 2 3]maps
maps 標準庫中針對迭代器，新增了：maps.All、maps.Keys、maps.Values、 方法。
函數簽名如下：
func All[Map ~map[K]V, K comparable, V any](m Map "Map ~map[K]V, K comparable, V any") iter.Seq2[K, V]
func Keys[Map ~map[K]V, K comparable, V any](m Map "Map ~map[K]V, K comparable, V any") iter.Seq[K]
func Values[Map ~map[K]V, K comparable, V any](m Map "Map ~map[K]V, K comparable, V any") iter.Seq[V]示例代碼如下：
func main() {
m := map[string]int{
"腦子": 1,
"進": 2,
"煎魚": 3,
"了": 4,
"嗎": 5,
}
for k, v := range maps.All(m) {
fmt.Println("k:", k, "v:", v)
}
for k := range maps.Keys(m) {
fmt.Println(k)
}
for v := range maps.Values(m) {
fmt.Println(v)
}
}輸出結果：
// maps.All
k: 嗎 v: 5
k: 腦子 v: 1
k: 進 v: 2
k: 煎魚 v: 3
k: 了 v: 4
// maps.Keys
腦子
進
煎魚
了
嗎
// maps.Values
3
4
5
1
2總結
Go1.23 的迭代器引入，對于 Go 來講是一個重要的里程碑。雖然在社區上引來了國外社區的大量爭議。但也帶來了 for-loop 的完整體系的建設，提供了迭代器可遍歷萬物的概念。
