Go语言如何获取当前模块名以简化函数全路径用于日志命名

1. 是否有更优的函数全限定路径获取方式 #

没有，runtime.FuncForPC(reflect.ValueOf(fn).Pointer())是目前Go原生提供的唯一稳定获取运行时函数全限定名的方案，没有性能或易用性更优的原生实现。

2. 如何得到期望的函数名格式 #

Go确实没有在运行时暴露模块元数据的API，你可以通过以下三种方案实现需求，按实现成本从低到高排序：

方案1：运行时动态提取模块前缀（无需额外配置，推荐） #

你可以在utils包初始化时，通过当前包的函数全限定名反向提取出模块前缀，无需硬编码模块名：

package utils

import (
	"reflect"
	"runtime"
	"strings"
)

var modulePrefix string

func init() {
	// 获取当前init函数的程序计数器
	pc, _, _, _ := runtime.Caller(0)
	currentFuncFullName := runtime.FuncForPC(pc).Name()
	// 去掉当前函数的后缀，得到模块前缀
	// 示例中currentFuncFullName为github.com/xxx/functionname/utils.init·0
	// 截取到/utils.之前的部分就是模块根路径
	suffixIndex := strings.LastIndex(currentFuncFullName, "/utils.")
	modulePrefix = currentFuncFullName[:suffixIndex] + "/"
}

func GetFunctionName(fn interface{}) string {
	value := reflect.ValueOf(fn)
	ptr := value.Pointer()
	fullName := runtime.FuncForPC(ptr).Name()
	// 移除模块前缀，再将路径分隔符替换为.
	relPath := strings.TrimPrefix(fullName, modulePrefix)
	return strings.ReplaceAll(relPath, "/", ".")
}

该方案无需修改编译流程，直接运行即可输出你期望的long.HandlerA、long.nested.path.HandlerB格式。

方案2：编译期通过ldflags注入模块名 #

如果你希望避免运行时的前缀计算开销，可以在编译时通过链接参数注入模块名：

1. 在utils包中添加变量：

package utils

var ModulePrefix string

2. 编译时添加ldflags参数：

go build -ldflags "-X 你的utils包完整路径.ModulePrefix=你的模块完整路径/"

示例中对应命令为：

go build -ldflags "-X github.com/naftulikay/golang-webapp/experiments/functionname/utils.ModulePrefix=github.com/naftulikay/golang-webapp/experiments/functionname/"

后续GetFunctionName直接使用该常量做前缀裁剪即可。

方案3：go generate自动生成模块名常量 #

如果你不想手动维护编译参数，可以通过go generate自动读取go.mod的模块名生成常量：

1. 在utils包下创建gen_module.go文件：

//go:build ignore
package main

import (
	"os"
	"golang.org/x/mod/modfile"
)

func main() {
	modData, err := os.ReadFile("go.mod")
	if err != nil {
		panic(err)
	}
	modFile, err := modfile.Parse("go.mod", modData, nil)
	if err != nil {
		panic(err)
	}
	outputContent := []byte(`// Code generated by gen_module.go; DO NOT EDIT.
package utils

const ModulePrefix = "` + modFile.Module.Mod.Path + `" + "/"
`)
	if err := os.WriteFile("module_def.go", outputContent, 0644); err != nil {
		panic(err)
	}
}

2. 在utils包的任意go文件头部添加生成指令：

//go:generate go run gen_module.go

3. 每次go.mod的模块名修改后，执行go generate ./utils即可自动生成module_def.go文件，其中包含最新的模块前缀常量，直接在GetFunctionName中使用即可。

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