如何用go/ast实现自定义Lint规则检查Go结构体Foo的Bar字段创建方式？

核心思路修正 #

你之前用ast.StructType找错了节点类型——StructType对应结构体定义（type Foo struct {...}），而结构体实例化对应的AST节点是ast.CompositeLit（比如Foo{...}这种字面量写法），这是整个规则的核心切入点。

具体实现步骤 #

1. 识别目标实例化节点 #

遍历AST时，筛选出所有ast.CompositeLit类型的节点，这些就是结构体实例化的语法对应。

2. 验证实例化类型为上游Foo #

仅靠AST的语法信息没法确认这个实例化的是不是你要的上游Foo，必须结合go/types做类型检查：

• 对每个CompositeLit，通过pass.TypesInfo.TypeOf(cl.Type)获取其实际类型。
• 把类型转换成*types.Named，检查其所属包的路径和类型名是否匹配上游的Foo（比如上游包是example.com/upstream，则类型需是upstream.Foo）。

3. 检查Bar字段的赋值是否符合要求 #

遍历CompositeLit.Elts里的字段赋值元素，找到Bar字段的显式赋值（ast.KeyValueExpr类型，Key是Bar）：

• 确认Bar字段的值是直接调用standardizedBarCalculator：
  • 值的类型必须是ast.CallExpr（函数调用）。
  • 调用的函数必须是standardizedBarCalculator（如果该函数在其他包，还要验证包路径）。
• 若Bar的值是变量引用（比如之前的bar变量）或其他函数调用，就触发Lint告警。

核心代码实现 #

下面是基于go/analysis框架的核心逻辑（可以直接集成到golangci-lint中）：

package main

import (
	"go/ast"
	"go/types"

	"golang.org/x/tools/go/analysis"
	"golang.org/x/tools/go/analysis/passes/inspect"
	"golang.org/x/tools/go/ast/inspector"
)

var FooBarCheck = &analysis.Analyzer{
	Name: "foobarcheck",
	Doc:  "Ensures Foo instances use standardizedBarCalculator for Bar field",
	Run:  runCheck,
	Requires: []*analysis.Analyzer{
		inspect.Analyzer,
	},
}

func runCheck(pass *analysis.Pass) (interface{}, error) {
	inspector := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)

	// 只遍历CompositeLit节点
	nodeFilter := []ast.Node{(*ast.CompositeLit)(nil)}
	inspector.Preorder(nodeFilter, func(n ast.Node) {
		cl := n.(*ast.CompositeLit)

		// 检查当前实例化的类型是否为上游的Foo
		typ := pass.TypesInfo.TypeOf(cl.Type)
		if typ == nil {
			return
		}
		namedType, ok := typ.(*types.Named)
		if !ok {
			return
		}
		typeObj := namedType.Obj()
		// 替换为你的上游包路径和Foo类型名
		if typeObj.Pkg().Path() != "example.com/your-upstream-package" || typeObj.Name() != "Foo" {
			return
		}

		// 遍历字段赋值，检查Bar字段
		for _, elt := range cl.Elts {
			keyValExpr, ok := elt.(*ast.KeyValueExpr)
			if !ok {
				continue // 跳过隐式顺序赋值，若要处理需额外逻辑
			}
			keyIdent, ok := keyValExpr.Key.(*ast.Ident)
			if !ok || keyIdent.Name != "Bar" {
				continue
			}

			// 检查是否是standardizedBarCalculator的直接调用
			callExpr, ok := keyValExpr.Value.(*ast.CallExpr)
			if !ok {
				pass.Reportf(keyValExpr.Value.Pos(), "Bar字段必须直接使用standardizedBarCalculator计算")
				continue
			}
			callFuncIdent, ok := callExpr.Fun.(*ast.Ident)
			if !ok || callFuncIdent.Name != "standardizedBarCalculator" {
				// 若函数在其他包，需额外验证包路径
				// funcObj := pass.TypesInfo.ObjectOf(callFuncIdent)
				// if funcObj == nil || funcObj.Pkg().Path() != "your-package-path" { ... }
				pass.Reportf(keyValExpr.Value.Pos(), "Bar字段必须使用standardizedBarCalculator计算")
			}
		}
	})

	return nil, nil
}

补充说明 #

• 如果存在隐式字段赋值（即不写字段名，按结构体字段顺序赋值），需要额外处理：通过namedType.Underlying().(*types.Struct)获取Foo的字段顺序，找到Bar字段的索引，再对应检查CompositeLit.Elts中对应位置的赋值。
• 如果standardizedBarCalculator是跨包函数，需要通过pass.TypesInfo.ObjectOf(callFuncIdent)获取函数对象，验证其所属包路径。
• 可以将这个Analyzer集成到golangci-lint中，配置到项目的lint流程里，实现自动检查。

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