温馨提示×

温馨提示×

您好,登录后才能下订单哦!

密码登录×
登录注册×
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》

如何在Go的函数中得到调用者的函数名

发布时间:2021-09-13 23:13:58 来源:亿速云 阅读:141 作者:chen 栏目:web开发

这篇文章主要讲解了“如何在Go的函数中得到调用者的函数名”,文中的讲解内容简单清晰,易于学习与理解,下面请大家跟着小编的思路慢慢深入,一起来研究和学习“如何在Go的函数中得到调用者的函数名”吧!

func Foo() {     fmt.Println("谁在调用我?")     bar() } func Bar() {     fmt.Println("谁又在调用我?") }

首先打印函数本身的名称

最简单的方式就是硬编码。 因为在编译之前,我们肯定知道打印的时候所在哪个函数,但是更好的方式是编写一个通用的函数,比如下面的例子:

package main import (     "fmt"     "runtime" ) func main() {     Foo() } func Foo() {     fmt.Printf("我是 %s, 谁在调用我?\n", printMyName())     Bar() } func Bar() {     fmt.Printf("我是 %s, 谁又在调用我?\n", printMyName()) } func printMyName() string {     pc, _, _, _ := runtime.Caller(1)     return runtime.FuncForPC(pc).Name() }

输出结果:

我是 main.Foo, 谁在调用我? 我是 main.Bar, 谁又在调用我?

可以看到函数在被调用的时候,printMyName把函数本身的名字打印出来了,注意这里Caller的参数是1,  因为我们将业务代码封装成了一个函数。

首先打印函数调用者的名称

将上面的代码修改一下,增加一个新的printCallerName的函数,可以打印调用者的名称。

func main() {     Foo() } func Foo() {     fmt.Printf("我是 %s, %s 在调用我!\n", printMyName(), printCallerName())     Bar() } func Bar() {     fmt.Printf("我是 %s, %s 又在调用我!\n", printMyName(), printCallerName()) } func printMyName() string {     pc, _, _, _ := runtime.Caller(1)     return runtime.FuncForPC(pc).Name() } func printCallerName() string {     pc, _, _, _ := runtime.Caller(2)     return runtime.FuncForPC(pc).Name() }

相关函数介绍

你可以通过runtime.Caller、runtime.Callers、runtime.FuncForPC等函数更详细的跟踪函数的调用堆栈。

1、func Caller(skip int) (pc uintptr, file string, line int, ok bool)

Caller可以返回函数调用栈的某一层的程序计数器、文件信息、行号。

0 代表当前函数,也是调用runtime.Caller的函数。1 代表上一层调用者,以此类推。

2、func Callers(skip int, pc []uintptr) int

Callers用来返回调用站的程序计数器, 放到一个uintptr中。

0 代表 Callers 本身,这和上面的Caller的参数的意义不一样,历史原因造成的。 1 才对应这上面的 0。

比如在上面的例子中增加一个trace函数,被函数Bar调用。

&hellip;&hellip; func Bar() {     fmt.Printf("我是 %s, %s 又在调用我!\n", printMyName(), printCallerName())     trace() } func trace() {     pc := make([]uintptr, 10) // at least 1 entry needed     n := runtime.Callers(0, pc)     for i := 0; i < n; i++ {         f := runtime.FuncForPC(pc[i])         file, line := f.FileLine(pc[i])         fmt.Printf("%s:%d %s\n", file, line, f.Name())     } }

输出结果可以看到这个goroutine的整个栈都打印出来了:

/usr/local/go/src/runtime/extern.go:218 runtime.Callers /Users/yuepan/go/src/git.intra.weibo.com/platform/tool/g/main.go:34 main.trace /Users/yuepan/go/src/git.intra.weibo.com/platform/tool/g/main.go:20 main.Bar /Users/yuepan/go/src/git.intra.weibo.com/platform/tool/g/main.go:15 main.Foo /Users/yuepan/go/src/git.intra.weibo.com/platform/tool/g/main.go:10 main.main /usr/local/go/src/runtime/proc.go:210 runtime.main /usr/local/go/src/runtime/asm_amd64.s:1334 runtime.goexit

3、func CallersFrames(callers []uintptr) *Frames

上面的Callers只是或者栈的程序计数器,如果想获得整个栈的信息,可以使用CallersFrames函数,省去遍历调用FuncForPC。

上面的trace函数可以更改为下面的方式:

func trace2() {     pc := make([]uintptr, 10) // at least 1 entry needed     n := runtime.Callers(0, pc)     frames := runtime.CallersFrames(pc[:n])     for {         frame, more := frames.Next()         fmt.Printf("%s:%d %s\n", frame.File, frame.Line, frame.Function)         if !more {             break         }     } }

4、func FuncForPC(pc uintptr) *Func

FuncForPC 是一个有趣的函数, 它可以把程序计数器地址对应的函数的信息获取出来。如果因为内联程序计数器对应多个函数,它返回最外面的函数。

它的返回值是一个*Func类型的值,通过*Func可以获得函数地址、文件行、函数名等信息。

除了上面获取程序计数器的方式,也可以通过反射的方式获取函数的地址:

runtime.FuncForPC(reflect.ValueOf(foo).Pointer()).Name()

5、获取程序堆栈

在程序panic的时候,一般会自动把堆栈打出来,如果你想在程序中获取堆栈信息,可以通过debug.PrintStack()打印出来。比如你在程序中遇到一个Error,但是不期望程序panic,只是想把堆栈信息打印出来以便跟踪调试,你可以使用debug.PrintStack()。

抑或,你自己读取堆栈信息,自己处理和打印:

func DumpStacks() {     buf := make([]byte, 16384)     buf = buf[:runtime.Stack(buf, true)]     fmt.Printf("=== BEGIN goroutine stack dump ===\n%s\n=== END goroutine stack dump ===", buf) }

参考 调试利器:dump goroutine 的 stacktrace。

利用堆栈信息还可以获取goroutine的id, 参考: 再谈谈获取 goroutine id 的方法

func GoID() int {     var buf [64]byte     n := runtime.Stack(buf[:], false)     idField := strings.Fields(strings.TrimPrefix(string(buf[:n]), "goroutine "))[0]     id, err := strconv.Atoi(idField)     if err != nil {         panic(fmt.Sprintf("cannot get goroutine id: %v", err))     }     return id }

感谢各位的阅读,以上就是“如何在Go的函数中得到调用者的函数名”的内容了,经过本文的学习后,相信大家对如何在Go的函数中得到调用者的函数名这一问题有了更深刻的体会,具体使用情况还需要大家实践验证。这里是亿速云,小编将为大家推送更多相关知识点的文章,欢迎关注!

向AI问一下细节

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

go
AI