Go go/ast.Preorder 如何遍历语法树：迭代器消费、提前停止与节点类型判断

做源码检查工具时，最先遇到的不是语法解析，而是“遍历到哪里算完成”。Go 1.23 提供的 go/ast.Preorder 返回一个 iter.Seq[ast.Node]，可以直接用 range 按深度优先前序读取节点；找到目标后用 break 结束消费，代码比手动维护回调状态更容易核对。

把任务拆成三步就够了：parser.ParseFile 生成 *ast.File，ast.Preorder 依次提供节点，类型断言只处理真正关心的 *ast.CallExpr 或 *ast.Ident。需要控制某个子树是否继续深入时，再换回 ast.Inspect。

先看清扫描工具为什么会误判

假设检查器要判断一份 Go 源码里是否调用了 fmt.Println。旧实现常把 ast.Inspect 回调、嵌套布尔变量和“是否已经找到”混在一起：回调返回值决定是否继续下钻，外层变量又决定何时停止，结果是找到调用后仍然遍历完整个文件，或者误把同名标识符当成调用。

这次只保留一个明确结果：parseAndScan 负责解析并调用扫描器，ast.Preorder 负责给出节点，*ast.CallExpr 负责确认“这是一次调用”。如果结果只要求是否命中，扫描器在确认目标后立刻结束。

用 ParseFile 和 Preorder 建一条可复查的路径

下面的示例接收源码字符串，扫描是否存在对 fmt.Println 的调用。parser.ParseFile 先构造语法树；解析错误直接返回，避免把不完整的树交给后面的判断。

package scan

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

func parseAndScan(src string) (bool, error) {
    fset := token.NewFileSet()
    file, err := parser.ParseFile(fset, "source.go", src, 0)
    if err != nil {
        return false, err
    }

    for n := range ast.Preorder(file) {
        call, ok := n.(*ast.CallExpr)
        if !ok {
            continue
        }
        selector, ok := call.Fun.(*ast.SelectorExpr)
        if !ok || selector.Sel.Name != "Println" {
            continue
        }
        ident, ok := selector.X.(*ast.Ident)
        if ok && ident.Name == "fmt" {
            return true, nil
        }
    }
    return false, nil
}

这里的控制流有三个核对点：解析失败从 parser.ParseFile 返回；非调用节点通过 continue 忽略；命中 fmt.Println 后通过 return true 结束函数。Preorder 本身不会替你判断节点类型，也不会把选择器名称自动拼成完整调用名。

为什么 range 可以提前结束

ast.Preorder(file) 的返回值是迭代序列，range 每次取出一个节点并执行循环体。循环体中的 return 或 break 会停止当前消费，因此不需要为这个简单的“找到即停”任务额外维护回调状态。

若要统计全部调用，把命中分支改成累加并继续消费；若要在遍历一个函数时跳过它的内部子树，Preorder 就不够直接，应使用 ast.Inspect，在回调里对该节点返回 false。两者都是深度优先遍历，但控制粒度不同。

遇到错误时按顺序收口

解析错误与“没有找到目标”不是一回事。parser.ParseFile 返回错误时，调用方应保留错误上下文；成功解析但扫描不到 fmt.Println 时，返回的是 false, nil。把这两种结果合成一个 false，会让 CI 把语法损坏误报成规则未命中。

类型断言也要保留失败分支。selector.X 可能不是 *ast.Ident，例如调用链更复杂时它可能是另一个表达式；先断言再读取 ident.Name，比直接强制转换安全。

相关问题

Preorder 会不会漏掉根节点？

不会。官方文档说明它遍历指定根节点之下并包含根节点的所有节点，顺序是深度优先前序。

什么时候继续使用 Inspect？

当扫描器需要针对某个节点决定是否继续进入子树，或需要回调式的进入控制时，Inspect 更直接；只想按顺序读取并在命中后停止时，Preorder 更简洁。

为什么不能只判断 Ident.Name？

因为同一个标识符可能出现在声明、参数或其他表达式中。先确认 *ast.CallExpr，再确认 *ast.SelectorExpr 和 fmt.Println，才能把“调用”与“同名文字”分开。

把验收标准写进测试

至少准备三组输入：含有 fmt.Println 的合法源码、只有 fmt.Printf 的合法源码，以及缺右括号的非法源码。预期分别是 true, nil、false, nil 和非空错误。这样既验证 Preorder 的命中路径，也验证解析错误没有被吞掉。