Go types.MethodSet.Lookup 怎样查找包内未导出方法

在源码分析、静态检查或代码补全工具里，拿到一个 *types.MethodSet 后，想查找小写的 refresh，不能只传方法名。MethodSet.Lookup(pkg, name) 会按“包身份 + 名称”匹配：导出方法的名称本身就是唯一标识，未导出方法则把包路径加入标识。命中时返回 *types.Selection，找不到时返回 nil。

官方地址：https://pkg.go.dev/go/types#MethodSet

直接结论：查找包内未导出方法时，把声明该方法的 *types.Package 传给 Lookup，名称必须保持原样，例如 methodSet.Lookup(checkedPkg, "refresh")。随后用 selection.Obj().(*types.Func) 取出方法对象；如果传入另一个包，通常会因为包路径不同而得到 nil。

先看 Lookup 到底匹配什么

当前 Go 官方文档对 Lookup 的定义很简短：返回“包和名称匹配的方法”，找不到就返回 nil。这里的返回值不是 *types.Func，而是描述选择关系的 *types.Selection。对于方法集合中的方法，调用 Obj() 后才会得到对应的 *types.Func。

实现层面可以把它理解成先计算 types.Id(pkg, name)，再在已经按对象 ID 排序的方法列表中查找同一个键。Id 对导出名直接返回名称；对未导出名则使用包路径和名称组合。因此，pkg.Name() 显示出来的短包名不是可靠的匹配依据，真正重要的是包路径。

从类型检查结果构造方法集合

MethodSet 不是从字符串直接创建的，通常先用 go/parser 解析源码，再让 go/types.Config.Check 生成类型信息。下面的示例只使用内存中的一段源码，定义一个同时拥有导出方法和未导出方法的 Widget：

package main

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

func main() {
	// 用固定源码构造一个可供 go/types 检查的包。
	const source = `package demo

type Widget struct{}

func (Widget) refresh() {}
func (Widget) Refresh() {}
`

	fset := token.NewFileSet()
	file, err := parser.ParseFile(fset, "widget.go", source, 0)
	if err != nil {
		// 解析失败时没有可靠的类型信息，立即停止后续查找。
		panic(err)
	}

	// Check 返回的包同时携带包路径、包名和包级作用域。
	checkedPkg, err := new(types.Config).Check(
		"example.com/demo",
		fset,
		[]*ast.File{file},
		nil,
	)
	if err != nil {
		// 类型检查失败时不要把不完整的方法集合当成最终结果。
		panic(err)
	}

	widget := checkedPkg.Scope().Lookup("Widget")
	if widget == nil {
		// 包级查找不到类型名时，说明输入源码与查询目标不一致。
		panic("Widget not found")
	}

	// 方法集合的形状由 Widget 这个 Type 决定。
	methodSet := types.NewMethodSet(widget.Type())
	fmt.Println(methodSet.Len())
}

这里的关键不是手工创建 types.Func，而是让类型检查器把方法、接收者和声明包关联起来。之后从 Scope().Lookup("Widget") 拿到的对象的 Type() 才能交给 types.NewMethodSet。如果查询的是指针类型，方法集合还会受到指针接收者规则影响，不能只把值类型和指针类型当成同一份结果。

用声明包查找未导出方法

有了方法集合和类型检查返回的包，就可以查找小写方法。下面的片段接在上一段代码之后，查询键中的包参数直接使用 checkedPkg：

// 使用声明 refresh 的包身份查找未导出方法。
selection := methodSet.Lookup(checkedPkg, "refresh")
if selection == nil {
	// nil 表示名称或包身份没有与方法集合中的对象匹配。
	panic("refresh not found")
}

// Selection.Obj 对方法选择返回 *types.Func。
method, ok := selection.Obj().(*types.Func)
if !ok {
	// 方法集合正常应返回函数对象；保留判断便于工具处理异常输入。
	panic("selection is not a function")
}

fmt.Println(method.Name())
fmt.Println(method.Pkg().Path())
fmt.Println(method.Signature())

这段查询应当关注三个层次：selection == nil 先判断是否命中，Obj() 再取对象，最后通过 Name()、Pkg().Path() 和 Signature() 读取方法信息。方法名仍然是本地名称 refresh，包路径则用来说明它属于哪个包。

为什么换一个包就会返回 nil

为了说明边界，可以构造一个路径不同的包并再次查询同一个小写名称：

// 这个包的路径与声明 refresh 的包不同。
foreignPkg := types.NewPackage("example.com/other", "other")

// 未导出名称的唯一标识包含包路径，因此这里不会命中 demo.refresh。
missing := methodSet.Lookup(foreignPkg, "refresh")
if missing == nil {
	fmt.Println("package identity does not match")
}

不要把这里的“包身份”理解成界面上显示的短名称。demo 和 other 是包名，但比较未导出标识符时，example.com/demo 与 example.com/other 才是决定性信息。即使两个包都声明了名为 refresh 的方法，它们也不是同一个未导出对象。

另一个容易混淆的点是导出方法。例如查询 Refresh 时，types.Id 对导出名称不追加包路径，所以包参数不承担区分作用；但为了让调用意图清晰，工具代码仍然可以统一传入当前分析包。

把 Lookup 结果接入源码分析工具

如果目标是做文档索引、静态检查或补全，建议把查找过程封装成一个小函数，把“方法名是否导出”“查询包是否可用”和“空结果”明确分开：

func findMethod(set *types.MethodSet, pkg *types.Package, name string) (*types.Func, bool) {
	// Lookup 负责处理导出名和未导出名的包身份规则。
	if set == nil {
		return nil, false
	}

	selection := set.Lookup(pkg, name)
	if selection == nil {
		// 没有命中不代表解析器出错，可能只是包或名称边界不对。
		return nil, false
	}

	method, ok := selection.Obj().(*types.Func)
	return method, ok
}

封装后，调用方只需要处理“有方法”和“没有方法”两种状态。若需要继续分析接收者路径，可以保留原始 Selection，因为它还包含 Recv()、Index() 等选择信息；若只需要声明对象，则返回 *types.Func 更直接。

常见问题

Lookup 的返回值为什么不是 *types.Func？

因为方法集合保存的是方法选择关系。*types.Selection 除了能通过 Obj() 得到函数对象，还能描述接收者和嵌入路径；只关心声明对象时再取出 *types.Func 即可。

查找 refresh 时可以传 nil 包吗？

不建议。未导出名称需要包路径参与唯一标识，传 nil 会落到没有具体包路径的标识，通常无法匹配声明在具体包中的方法。

用 checkedPkg.Name() 作为包参数可以吗？

不可以，Lookup 的参数类型是 *types.Package，不是字符串。更重要的是包名和包路径不是同一概念，应保留类型检查器返回的包对象，或构造路径一致的包对象。

为什么方法集合里没有指针接收者方法？

先检查传给 NewMethodSet 的类型是值还是指针。Go 的方法集合会根据接收者类型变化；这和 Lookup 的包身份匹配是两个独立问题，应该分别排查。

总结

types.MethodSet.Lookup 的核心不是“在列表里按字符串搜索”，而是按 types.Id(pkg, name) 搜索方法对象。查找包内未导出方法时，保留类型检查结果中的 *types.Package，传入精确的本地方法名；命中后从 *types.Selection 取 *types.Func，未命中则先检查包路径，再检查名称和方法集合的类型形状。

官方资料：https://pkg.go.dev/go/types#MethodSet　https://go.dev/src/go/types/methodset.go　https://go.dev/src/go/types/object.go