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 的导出约定体现在标识符首字母上。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 还原参数与返回值

FuncDecl 的 Name 和 Type 是分开的:名字在 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 索引和源码检查都可以共享同一套基础结果结构。
-
430 收藏
-
469 收藏
-
375 收藏
-
268 收藏
-
327 收藏
-
326 收藏
-
456 收藏
-
208 收藏
-
100 收藏
-
310 收藏
-
428 收藏
-
336 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 485次学习