Go Initializer.Rhs 怎样定位初始化表达式的原文

我在给 Go 包级初始化做索引时，最容易踩的坑就是把 types.Initializer.Rhs 当成已经准备好的字符串。它其实是一个 ast.Expr：Info.InitOrder 负责告诉你初始化项，Rhs 只负责指向对应的表达式节点。要得到可读文本，可以用 types.ExprString；要保留源文件里的空格、换行和写法，则应根据 Pos、End 回到源字节切片。

下面这套做法适合静态分析、依赖图和诊断日志：先从初始化顺序拿到对象，再选择“规范文本”或“原始片段”，最后用 token.File 把位置转换成文件偏移。

先从 Info.InitOrder 找到 Rhs

go/types.Info.InitOrder 保存包级初始化项。存在依赖关系的变量会按拓扑顺序排列，互不相关的项保持源码顺序；没有初始化表达式的变量不会进入列表。每个 Initializer 的 Lhs 是一个或多个 *types.Var，Rhs 则是这组变量共享的 ast.Expr。

// 这个示例只读取类型检查结果，不运行被分析的包级初始化代码。
func printInitializers(info *types.Info) {
	for _, init := range info.InitOrder {
		// 一个多值表达式可能对应多个左值变量。
		var names []string
		for _, obj := range init.Lhs {
			names = append(names, obj.Name())
		}
		// ExprString 给出稳定的表达式文本，但会做规范化排版。
		fmt.Printf("%s = %s\\n", strings.Join(names, ", "), types.ExprString(init.Rhs))
	}
}

例如 var total = base + 2 的 Rhs 就是表示 base + 2 的 AST 节点。这里不要从 Lhs[0].String() 拼回整行：多值初始化、显式类型和表达式括号都可能让这种拼接丢失信息。

规范文本和源码原文是两种需求

如果用途是日志、索引键或依赖图节点，types.ExprString(init.Rhs) 通常更合适。它把 AST 重新打印成稳定表达式，便于同一语义在不同排版下比较；但它不是原始源码，注释、空格和部分括号布局不应被当作可恢复的事实。

如果用户要跳回编辑器、生成诊断范围或展示原文件片段，就应该保留解析时的源字节，并把表达式的 token 位置映射为当前文件的 offset。token.Pos 是 FileSet 内的紧凑位置值，不能直接拿来索引字符串。

// rawExprSource 按表达式位置截取一个文件中的原始源码片段。
func rawExprSource(fset *token.FileSet, src []byte, expr ast.Expr) (string, error) {
	// Rhs 没有合法位置时，不能猜测它属于哪个文件。
	file := fset.File(expr.Pos())
	if file == nil || expr.Pos() == token.NoPos || expr.End() == token.NoPos {
		return "", fmt.Errorf("表达式没有可用源码位置")
	}
	start := file.Offset(expr.Pos())
	end := file.Offset(expr.End())
	// End 表示表达式末尾之后的位置，因此切片右边界直接使用 end。
	if start  len(src) {
		return "", fmt.Errorf("表达式位置超出源文件范围")
	}
	return string(src[start:end]), nil
}

这段函数保留的是表达式本身的原始字节，不会自动带上声明前后的空白。多文件包要为每个 *token.File 保存对应的源字节；不能把某一个文件的 src 复用于所有 Rhs。

把两种文本一起放进初始化索引

实际索引通常同时需要“用于比较的规范文本”和“用于定位的原文”。前者来自 ExprString，后者来自位置切片；两者并不冲突。下面的完整片段用一个源文件演示从解析、类型检查到输出两种结果的连接方式，示例只描述静态分析数据，不执行目标包。

// collectInitText 把初始化对象、规范表达式和源码片段放在一起。
func collectInitText(source string) error {
	fset := token.NewFileSet()
	file, err := parser.ParseFile(fset, "demo.go", source, parser.ParseComments)
	if err != nil {
		return err
	}
	info := &types.Info{}
	// Check 会填充 InitOrder；类型错误时信息可能不完整。
	if _, err := (&types.Config{}).Check("demo", fset, []*ast.File{file}, info); err != nil {
		return err
	}
	for _, init := range info.InitOrder {
		raw, err := rawExprSource(fset, []byte(source), init.Rhs)
		if err != nil {
			return err
		}
		// 规范文本适合键，原文适合跳转和诊断展示。
		fmt.Printf("key=%q raw=%q\\n", types.ExprString(init.Rhs), raw)
	}
	return nil
}

如果包存在类型错误，官方文档允许收集到的信息是不完整的。因此索引器应把“没有 InitOrder 项”和“类型检查提前失败”分开记录；不要在错误包上静默生成一个看似完整的初始化列表。

常见边界：多值初始化、括号和多文件

我的经验是把这两个字段都写进内部记录：expr_canonical 用于去重和依赖图，expr_source 用于用户看到的诊断。这样既不会拿格式差异误判两个表达式不同，也不会为了“好看”丢掉源文件中真正存在的写法。

相关问题

Initializer.Rhs 能直接得到文件名吗？

不能。它是 ast.Expr，文件归属和位置要通过与解析时相同的 token.FileSet 查询。

为什么不用 fmt.Sprint(init.Rhs)？

AST 节点的默认格式不应作为源码恢复协议。需要规范文本用 types.ExprString，需要原文用位置切片。

Rhs 的 End 能直接作为切片终点吗？

在同一个 token.File 中，应先用 file.Offset 转成文件内偏移，再检查范围后切片；不能直接把 token.Pos 当成字节下标。