如何基于AST查找Go代码中返回FooBar结构体的函数与方法？

命令行工具方案 #

1. 利用gopls进行精确查询 #

gopls是Go官方语言服务器，基于AST解析实现精确符号查询，完全避免grep类工具的误匹配问题。执行以下命令即可查找返回FooBar或*FooBar的函数/方法：

gopls "query 'func() FooBar' 'func() *FooBar' 'func(...) FooBar' 'func(...) *FooBar'" ./...

如果需要限定结构体所属包，补充包路径即可：

gopls "query 'func() your/package/path.FooBar' 'func() *your/package/path.FooBar'" ./...

2. 自定义AST遍历脚本 #

如果需要更灵活的匹配逻辑（比如过滤特定目录、处理嵌套类型等），可以写一个简单的Go脚本遍历AST：

package main

import (
	"flag"
	"fmt"
	"go/ast"
	"go/parser"
	"go/token"
	"os"
	"path/filepath"
	"strings"
)

var targetType = flag.String("type", "FooBar", "目标返回类型")

func main() {
	flag.Parse()
	if len(flag.Args()) == 0 {
		fmt.Println("使用方式: go run search.go -type FooBar ./...")
		os.Exit(1)
	}

	fset := token.NewFileSet()
	for _, path := range flag.Args() {
		_ = filepath.Walk(path, func(path string, info os.FileInfo, err error) error {
			if err != nil || info.IsDir() || !strings.HasSuffix(path, ".go") {
				return err
			}
			f, err := parser.ParseFile(fset, path, nil, parser.AllErrors)
			if err != nil {
				return err
			}
			inspectAST(f, fset, path)
			return nil
		})
	}
}

func inspectAST(f *ast.File, fset *token.FileSet, filePath string) {
	ast.Inspect(f, func(n ast.Node) bool {
		if fnDecl, ok := n.(*ast.FuncDecl); ok {
			checkReturnType(fnDecl.Type.Results, fnDecl.Name.Name, fset.Position(fnDecl.Pos()), filePath)
		}
		return true
	})
}

func checkReturnType(results *ast.FieldList, funcName string, pos token.Position, filePath string) {
	if results == nil {
		return
	}
	for _, field := range results.List {
		// 检查命名返回值
		for _, name := range field.Names {
			if name.Name == *targetType {
				fmt.Printf("%s:%d: %s 返回 %s\n", filePath, pos.Line, funcName, *targetType)
			}
		}
		// 检查匿名返回值（包括指针类型）
		switch typ := field.Type.(type) {
		case *ast.Ident:
			if typ.Name == *targetType {
				fmt.Printf("%s:%d: %s 返回 %s\n", filePath, pos.Line, funcName, *targetType)
			}
		case *ast.StarExpr:
			if ident, ok := typ.X.(*ast.Ident); ok && ident.Name == *targetType {
				fmt.Printf("%s:%d: %s 返回 *%s\n", filePath, pos.Line, funcName, *targetType)
			}
		}
	}
}

保存为search.go，运行命令：

go run search.go -type FooBar ./path/to/your/code

脚本会精准识别所有返回FooBar或*FooBar的函数，支持命名返回值和匿名返回值场景。

VSCode集成方案 #

VSCode的官方Go插件内置gopls支持，可直接利用AST查询功能：

• 打开命令面板（Ctrl+Shift+P / Cmd+Shift+P）
• 输入Go: Workspace Symbol
• 在搜索框输入func() FooBar或func() *FooBar，即可看到所有符合条件的函数/方法，点击可直接跳转至代码位置

如果需要自定义查询逻辑，也可以配置VSCode任务调用上述自定义脚本：

1. 在项目根目录创建.vscode/tasks.json
2. 添加以下任务配置：

{
    "version": "2.0.0",
    "tasks": [
        {
            "label": "搜索返回FooBar的函数",
            "type": "shell",
            "command": "go run ${workspaceFolder}/search.go -type FooBar ${workspaceFolder}/...",
            "problemMatcher": {
                "owner": "go",
                "fileLocation": "absolute",
                "pattern": {
                    "regexp": "^(.*):(\\d+): (.*)$",
                    "file": 1,
                    "line": 2,
                    "message": 3
                }
            },
            "presentation": {
                "reveal": "always",
                "panel": "shared"
            }
        }
    ]
}

之后通过命令面板运行Tasks: Run Task -> 搜索返回FooBar的函数，结果会在终端显示，且支持点击跳转。

内容的提问来源于stack exchange，提问作者guettli