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

205 阅读4分钟
原文链接: click.aliyun.com

有时候在Go的函数调用的过程中,我们需要知道函数被谁调用,比如打印日志信息等。例如下面的函数,我们希望在日志中打印出调用者的名字。


1func Foo() { 2 fmt.Println("谁在调用我?") 3 bar() 4} 5func Bar() { 6 fmt.Println("谁又在调用我?") 7} 首先打印函数本身的名称

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


1package main 2import ( 3 "fmt" 4 "runtime" 5) 6func main() { 7 Foo() 8} 9func Foo() { 10 fmt.Printf("我是 %s, 谁在调用我?\n", printMyName()) 11 Bar() 12} 13func Bar() { 14 fmt.Printf("我是 %s, 谁又在调用我?\n", printMyName()) 15} 16func printMyName() string { 17 pc, _, _, _ := runtime.Caller(1) 18 return runtime.FuncForPC(pc).Name() 19}

输出结果:


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

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

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

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


1func main() { 2 Foo() 3} 4func Foo() { 5 fmt.Printf("我是 %s, %s 在调用我!\n", printMyName(), printCallerName()) 6 Bar() 7} 8func Bar() { 9 fmt.Printf("我是 %s, %s 又在调用我!\n", printMyName(), printCallerName()) 10} 11func printMyName() string { 12 pc, _, _, _ := runtime.Caller(1) 13 return runtime.FuncForPC(pc).Name() 14} 15func printCallerName() string { 16 pc, _, _, _ := runtime.Caller(2) 17 return runtime.FuncForPC(pc).Name() 18} 相关函数介绍

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

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

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

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

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

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

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

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


1…… 2func Bar() { 3 fmt.Printf("我是 %s, %s 又在调用我!\n", printMyName(), printCallerName()) 4 trace() 5} 6func trace() { 7 pc := make([]uintptr, 10) // at least 1 entry needed 8 n := runtime.Callers(0, pc) 9 for i := 0; i < n; i++ { 10 f := runtime.FuncForPC(pc[i]) 11 file, line := f.FileLine(pc[i]) 12 fmt.Printf("%s:%d %s\n", file, line, f.Name()) 13 } 14}

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


1/usr/local/go/src/runtime/extern.go:218 runtime.Callers 2/Users/yuepan/go/src/git.intra.weibo.com/platform/tool/g/main.go:34 main.trace 3/Users/yuepan/go/src/git.intra.weibo.com/platform/tool/g/main.go:20 main.Bar 4/Users/yuepan/go/src/git.intra.weibo.com/platform/tool/g/main.go:15 main.Foo 5/Users/yuepan/go/src/git.intra.weibo.com/platform/tool/g/main.go:10 main.main 6/usr/local/go/src/runtime/proc.go:210 runtime.main 7/usr/local/go/src/runtime/asm_amd64.s:1334 runtime.goexit func CallersFrames(callers []uintptr) *Frames

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

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


1func trace2() { 2 pc := make([]uintptr, 10) // at least 1 entry needed 3 n := runtime.Callers(0, pc) 4 frames := runtime.CallersFrames(pc[:n]) 5 for { 6 frame, more := frames.Next() 7 fmt.Printf("%s:%d %s\n", frame.File, frame.Line, frame.Function) 8 if !more { 9 break 10 } 11 } 12} func FuncForPC(pc uintptr) *Func

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

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

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

1runtime.FuncForPC(reflect.ValueOf(foo).Pointer()).Name()
获取程序堆栈

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

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


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

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

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


1func GoID() int { 2 var buf [64]byte 3 n := runtime.Stack(buf[:], false) 4 idField := strings.Fields(strings.TrimPrefix(string(buf[:n]), "goroutine "))[0] 5 id, err := strconv.Atoi(idField) 6 if err != nil { 7 panic(fmt.Sprintf("cannot get goroutine id: %v", err)) 8 } 9 return id 10}
原文发布时间为:2018-11-5 本文作者:smallnest 本文来自云栖社区合作伙伴“Golang语言社区”,了解相关信息可以关注“ Golang语言社区”。