Go ast.Preorder 怎样用 range 遍历语法树节点

如果你已经用 go/parser 得到了一棵 AST，只想按源码结构从父节点走到子节点，Go 的 ast.Preorder 可以直接交给 range 消费。它返回一个 iter.Seq[ast.Node]，包含传入的根节点，并按深度优先前序遍历；找到目标后用 break 就能停止继续取节点。

官方地址：https://pkg.go.dev/go/ast#Preorder

最小写法就是 for n := range ast.Preorder(root)：先对具体节点类型做类型断言，再在满足条件时处理或 break。如果你的需求是跳过某个子树，而不是结束整个遍历，应改看 ast.Inspect 或 ast.PreorderStack。

Preorder 到底按什么顺序返回节点

ast.Preorder(root) 会把 root 自己也放进序列，然后先访问父节点，再深入它的子节点。这个顺序叫 depth-first preorder，适合做标识符收集、声明扫描和“找到第一个符合条件的节点”等任务。

它和旧式回调遍历的主要区别是：调用方拿到的是可迭代序列，不需要自己维护进入节点、离开节点的回调状态。官方文档将该函数标记为 Go 1.23.0 添加；项目如果要兼容更早版本，需要先确认目标工具链是否提供它。

先把源码解析成 ast.Node

下面的示例用一段内存中的 Go 源码创建 *ast.File。解析失败时直接返回错误，避免把一个不完整的 AST 交给后续遍历。

package main

import (
    "fmt"
    "go/ast"
    "go/parser"
    "go/token"
)

func main() {
    src := `package demo

func add(a, b int) int {
    return a + b
}`

    // FileSet 负责保存 AST 中位置对象的文件与行列信息。
    fset := token.NewFileSet()
    // SkipObjectResolution 足够支撑本例的语法树遍历，不额外解析旧式对象关系。
    file, err := parser.ParseFile(fset, "demo.go", src, parser.SkipObjectResolution)
    if err != nil {
        // 解析错误必须先处理，否则后面没有可靠的根节点可遍历。
        fmt.Println("parse error:", err)
        return
    }

    // file 同时是 ast.Node，也是 Preorder 的遍历根节点。
    _ = ast.Preorder(file)
}

这里的 file 是遍历入口。ast.Node 是接口，实际节点可能是 *ast.File、*ast.FuncDecl、*ast.Ident 或其他具体类型，所以遍历时通常要按任务做类型断言。

用 range 筛选关心的节点

最常见的用法是只关心某一种节点。例如收集所有标识符时，循环变量先保持为 ast.Node，通过类型断言后再读取 Ident.Name。这样不会把接口值误当成拥有统一字段的结构体。

// printIdentifiers 按 AST 的前序顺序输出所有标识符。
func printIdentifiers(file *ast.File) {
    for node := range ast.Preorder(file) {
        // 只有 Ident 才有 Name 字段，其他节点直接跳过。
        ident, ok := node.(*ast.Ident)
        if !ok {
            continue
        }
        fmt.Println(ident.Name)
    }
}

不要在循环里重新构造一棵树，也不要用节点名称猜测节点类型。节点的具体类型决定了可读取的字段，前序顺序只决定访问先后。

找到目标后怎样提前停止

如果任务只是找到第一个函数声明、某个调用名或第一个匹配的标识符，就不必把完整序列消费完。在 range 内满足条件后使用 break，循环立即结束，后面的节点不会再交给当前消费者。

// firstFunctionName 返回 AST 中按前序遇到的第一个函数名。
func firstFunctionName(file *ast.File) (string, bool) {
    for node := range ast.Preorder(file) {
        // 先断言 FuncDecl，再读取函数声明的名称节点。
        decl, ok := node.(*ast.FuncDecl)
        if !ok || decl.Name == nil {
            continue
        }
        // 找到第一个目标后停止消费序列，不再扫描剩余子树。
        return decl.Name.Name, true
    }
    return "", false
}

上面的 return 比 break 更适合“找到结果就返回”的函数；如果还要在循环后统一整理结果，则使用 break，再让函数继续执行后续逻辑。

break 和跳过子树不是一回事

break 只结束当前的 range 循环，它表达的是“我不再消费后续节点”。它不是“跳过当前节点的子树”，也不能在保留后续兄弟节点的同时裁剪任意分支。

如果要在遍历过程中决定某个节点的子树是否继续访问，可以考虑：

常见问题

Preorder 会不会漏掉传入的根节点？

不会。官方语义是遍历指定根节点“之下并包含根节点”的所有节点，因此第一项就是传入的 root。

可以在 range 里修改 AST 吗？

可以在程序层面持有并修改节点指针，但这篇用法只讨论遍历和提前停止。修改节点还要考虑父子关系、位置字段和后续打印或类型检查的影响，不能把“能遍历”当成“修改后一定正确”。

什么时候不用 Preorder？

需要跳过子树、记录完整父节点栈或在每个节点前后执行回调时，优先阅读 ast.Inspect 和 ast.PreorderStack 的语义。只想按固定前序顺序读取节点时，Preorder 配合 range 更直接。

小结

记住三点即可：ast.Preorder(root) 返回可被 range 消费的节点序列；顺序包含 root 并遵循深度优先前序；找到目标后用 break 或 return 停止当前遍历。需要裁剪子树时换用带回调控制能力的 API，不要给 break 赋予它没有的语义。