如何检查Go语言公共函数/结构体是否未被包外使用？

一、GoLand 可视化操作 #

• 右键点击目标Foo函数/结构体，选择Find Usages（快捷键：Alt+F7）
• 搜索结果窗口中，直接查看每条结果的包路径，和Foo所在包对比就能判断是否有包外引用；嫌麻烦的话，点击结果窗口右上角的Filter按钮，选择Exclude from current package，可直接只显示包外引用
• 也可以将搜索范围（Scope）调整为Project Files，确保扫描覆盖整个代码库

二、Go官方工具（程序化解决方案） #

1. Go 1.21+ 使用go grep #

在项目根目录执行以下命令，将./your/package/path替换为Foo所在的包路径：

go grep -r "Foo" ./ --exclude="$(go list -f '{{.Dir}}/*' ./your/package/path)"

命令会递归扫描整个项目的Foo引用，自动排除目标包内的文件，剩余结果即为包外引用。

2. go list + grep组合命令 #

同样在项目根目录执行，替换目标包路径：

go list ./... | grep -v "./your/package/path" | xargs grep -l "Foo" 2>/dev/null

先列出所有非目标包的文件，再从中筛选包含Foo引用的文件路径，直接得到结果。

3. 进阶：自定义go vet检查 #

如果需要批量检查多个公共符号，可以编写简单的go vet插件，通过Go的AST（抽象语法树）分析代码：

• 遍历项目所有包的AST结构
• 识别所有标识符引用，判断是否指向目标包的公共符号
• 输出跨包引用的具体位置，适合自动化批量检查场景

三、使用gopls查询 #

在终端执行以下命令，替换包路径和符号名：

gopls references -d ./your/package/path Foo

命令会返回所有Foo的引用位置，自行过滤掉当前包的结果即可。

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