在 Go 中获取当前模块的名称

Question

我正在尝试为我正在编写的 HTTP 处理程序自动创建命名记录器，并在其中传递了一个函数（指针）。

我正在使用this question 中提到的代码来获取函数的名称：

package utils

import (
    "reflect"
    "runtime"
)

func GetFunctionName(fn interface{}) string {
    value := reflect.ValueOf(fn)
    ptr := value.Pointer()
    ffp := runtime.FuncForPC(ptr)

    return ffp.Name()
}

我在我的main 函数中使用它来尝试如下：

package main

import (
    "github.com/naftulikay/golang-webapp/experiments/functionname/long"
    "github.com/naftulikay/golang-webapp/experiments/functionname/long/nested/path"
    "github.com/naftulikay/golang-webapp/experiments/functionname/utils"
    "log"
)

type Empty struct{}

func main() {
    a := long.HandlerA
    b := path.HandlerB
    c := path.HandlerC

    log.Printf("long.HandlerA: %s", utils.GetFunctionName(a))
    log.Printf("long.nested.path.HandlerB: %s", utils.GetFunctionName(b))
    log.Printf("long.nested.path.HandlerC: %s", utils.GetFunctionName(c))
}

我看到这样的输出：

github.com/naftulikay/golang-webapp/experiments/functionname/long.HandlerA

这没关系，但我想要long.HandlerA、long.nested.path.HandlerB 等输出。

如果我能得到 Go 模块名称 (github.com/naftulikay/golang-webapp/experiments/functionname)，然后我可以使用 strings.Replace 删除模块名称以到达 long/nested/path.HandlerB，然后 strings.Replace 将 / 替换为 . 到最终达到我想要的值，即long.nested.path.HandlerB。

第一个问题是：我能否比runtime.FuncForPC(reflect.ValueOf(fn).Pointer()) 更好地获取函数的合格路径？

如果答案是否定的，有没有办法使用 runtime 或 reflect 获取当前 Go 模块名称，以便我可以将 runtime.FuncForPC 的输出转换为我需要的?

再一次，我得到如下值：

• github.com/naftulikay/golang-webapp/experiments/functionname/long.HandlerA
• github.com/naftulikay/golang-webapp/experiments/functionname/long/nested/path.HandlerB
• github.com/naftulikay/golang-webapp/experiments/functionname/long/nested/path.HandlerC

我想获得如下值：

• long.HandlerA
• long.nested.path.HandlerB
• long.nested.path.HandlerC

编辑： 看来 Go 没有模块的运行时表示，这没关系，如果我可以在编译时这样做，那也很好。我已经看过 codegen 文档，但我很难弄清楚如何编写可以从 go generate 使用的自定义 codegen。

Answer 1

模块信息包含在可执行二进制文件中，可以使用debug.ReadBuildInfo()函数获取（唯一的要求是必须使用模块支持构建可执行文件，但这是当前版本中的默认设置，很可能仅在未来的版本中）。

BuildInfo.Path是当前模块的路径。

假设您有以下go.mod 文件：

module example.com/foo

读取构建信息的示例：

bi, ok := debug.ReadBuildInfo()
if !ok {
    log.Printf("Failed to read build info")
    return
}

fmt.Println(bi.Path)

这将输出（在Go Playground 上尝试）：

example.com/foo

查看相关：Golang - How to display modules version from inside of code

Answer 2

如果您的目标是只是在您的程序中提供可用模块的名称，并且如果您可以在链接时设置此值，那么您可以使用 -ldflags 构建选项.

您可以在模块目录中使用go list -m 获取模块的名称。

您可以将所有内容放在 Makefile 或 shell 脚本中：

MOD_NAME=$(go list -m)
go build -ldflags="-X 'main.MODNAME=$MOD_NAME'" -o main ./...

main.go 看起来像：

package main

import "fmt"

var MODNAME string

func main() {
    fmt.Println(MODNAME) // example.com
}

---

使用提到的"golang.org/x/mod/modfile" 包，示例可能如下所示：

package main

import (
    "fmt"
    "golang.org/x/mod/modfile"
    _ "embed"
)

//go:embed go.mod
var gomod []byte

func main() {
    f, err := modfile.Parse("go.mod", gomod, nil)
    if err != nil {
        panic(err)
    }
    fmt.Println(f.Module.Mod.Path) // example.com
}

但是，在您的用例中嵌入整个 go.mod 文件似乎有点过头了。当然，您也可以在运行时打开该文件，但这意味着您必须将go.mod 与您的可执行文件一起部署。使用 -ldflags 设置模块名称更直接 IMO。