登录
推荐 文章 Go 技术 课程 下载 专题 AI
首页 >  Golang >  Go教程

Go 解析 AST 时怎么只收集导出的函数声明

来源:17golang原创

时间:2026-09-07 19:28:25 475浏览 收藏

如果只想从 Go 源码 AST 中找出对外可见的函数,关键不是递归扫描所有节点,而是先把范围收窄到 *ast.File.Decls,再筛选 *ast.FuncDecl。函数名用 fn.Name.IsExported() 判断,方法则通过 fn.Recv 单独处理;签名不要自己拼参数,直接格式化 fn.Type 更稳。

最小可靠组合是:file.Decls 限定顶层声明,IsExported 过滤首字母大写的名称,format.Node 保留参数、返回值和类型参数。
要点速览
  • file.Decls 只包含文件级声明,不会把函数体内的匿名函数当成命名函数。
  • fn.Recv != nil 表示这是方法;是否收集方法应做成明确开关。
  • format.Node 输出 fn.Type,比手工拼接参数更不容易漏掉返回值和泛型。

先把范围限定在文件顶层的 *ast.FuncDecl

parser.ParseFile 返回一个 *ast.File。它的 Decls 是当前文件的顶层声明列表,里面可能有导入、常量、变量、类型和函数声明。只有断言为 *ast.FuncDecl 的节点才是带名字的函数或方法声明。

这和 ast.Inspect 递归遍历不同:后者会走进函数体,遇到 *ast.FuncLit(函数字面量)也很正常。若目标是“收集文件里声明了哪些函数”,直接遍历 file.Decls 既清楚又不会扩大结果范围。

Go parser.ParseFile、ast.File、file.Decls 与 FuncDecl 字段的顶层声明关系图
图1:从 parser.ParseFile 到 file.Decls,再落到 FuncDecl 的名称、接收者和类型字段,限定 AST 收集范围。

用导出标识过滤函数名并区分方法

Go 的导出约定体现在标识符首字母上。ast.Ident 提供了 IsExported 方法,也可以使用 token.IsExported(fn.Name.Name)。前者更贴合 AST 节点,代码中还要保留 fn.Name == nil 的保护,避免处理由其他工具构造的不完整 AST 时发生空指针。

方法的名字同样可以导出,但它有接收者。例如 func (Service) Run()Recv 不为空。下面这张表适合在写收集器前先定好边界:

源码形态AST 判断默认结果
func Public()FuncDecl,Name.IsExported 为 true,Recv 为空收集
func private()Name.IsExported 为 false排除
func (Service) Run()Name 导出,Recv 不为空按开关决定
func() {}FuncLit,不在 file.Decls排除

用 FuncType 还原参数与返回值

帮助读者理解名称过滤、方法判断和签名格式化如何汇合成 FuncInfo。
图2:导出名称与接收者先确定收集边界,FuncType 经 format.Node 格式化后形成可读签名。

FuncDeclNameType 是分开的:名字在 fn.Name,参数、结果和类型参数在 fn.Type。因此可以让标准库格式化 AST 类型节点,再把函数名补回去。这样不需要分别处理无返回值、多个返回值、命名结果或泛型等组合。

package main

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

type FuncInfo struct {
    Name      string
    Signature string
    IsMethod  bool
}

func collectExportedFuncs(src []byte, filename string, includeMethods bool) ([]FuncInfo, error) {
    fset := token.NewFileSet()
    file, err := parser.ParseFile(fset, filename, src, parser.ParseComments)
    if err != nil {
        return nil, fmt.Errorf("解析 Go 源码失败: %w", err)
    }

    result := make([]FuncInfo, 0)
    for _, decl := range file.Decls {
        fn, ok := decl.(*ast.FuncDecl)
        if !ok || fn.Name == nil || !fn.Name.IsExported() {
            continue // 只保留有名字且对外可见的声明
        }
        isMethod := fn.Recv != nil
        if isMethod && !includeMethods {
            continue // 默认只收集包级函数,方法由调用方显式开启
        }

        var typeText strings.Builder
        if err := format.Node(&typeText, fset, fn.Type); err != nil {
            return nil, fmt.Errorf("格式化 %s 的签名失败: %w", fn.Name.Name, err)
        }
        signature := strings.TrimPrefix(strings.TrimSpace(typeText.String()), "func")
        result = append(result, FuncInfo{
            Name: fn.Name.Name,
            Signature: "func " + fn.Name.Name + signature,
            IsMethod: isMethod,
        })
    }
    return result, nil
}

这里的 includeMethods 是有意暴露的边界:做包 API 索引时通常只要包级函数;做类型方法清单时再传入 true。如果格式化或解析失败,函数直接返回错误,不把不完整的签名悄悄写进结果。

用一个最小例子检查导出函数、方法和函数值

可以用下面的源码覆盖四种容易混淆的情况:包级导出函数、包级未导出函数、导出方法,以及函数体中的匿名函数。默认调用 collectExportedFuncs(src, "demo.go", false) 时,结果应只有 Public;把最后一个参数改成 true 后,再增加 Run

const src = `package demo

func Public(id int) string { return "ok" }
func private() {}

type Service struct{}
func (Service) Run() error { return nil }
func (Service) hidden() {}

func Wrapper() {
    callback := func() { /* 匿名函数不属于 file.Decls */ }
    _ = callback
}`

如果要把结果定位回源码行号,可在循环中调用 fset.Position(fn.Pos()).Line。这只是位置查询,不改变导出过滤规则;同样,AST 只能告诉你语法声明,跨包可见性、类型解析和符号引用关系需要再接入 go/types,不要把两层能力混为一谈。

常见问题

为什么不用 ast.Inspect 一次遍历全部节点?

如果还要分析函数体、注释或嵌套声明,ast.Inspect 很合适;只收集顶层函数时,file.Decls 更直接,也能天然避开 FuncLit

大写函数名就一定能被其他包调用吗?

它说明语法层面是导出命名,但是否属于可编译的完整包,还取决于包是否能通过解析、类型检查和构建。当前收集器只回答 AST 层面的声明问题。

怎样同时收集导出方法?

保留 fn.Name.IsExported(),并把 includeMethods 设为 true。如需记录接收者类型,再从 fn.Recv.List 读取接收者表达式,避免把方法误记成普通函数。

把“遍历范围、导出判断、方法开关、签名格式化”拆开后,AST 收集器就容易复用:文档生成、API 索引和源码检查都可以共享同一套基础结果结构。

声明:本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>