关于后端:如何在go重打印函数调用者信息Caller

如何在 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 等函数更具体的跟踪函数的调用堆栈。

func Caller(skip int) (pc uintptr, file string, line int, ok bool)
Caller 能够返回函数调用栈的某一层的程序计数器、文件信息、行号。

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

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

0 代表 Callers 自身，这和下面的 Caller 的参数的意义不一样，历史起因造成的。1 才对应这下面的 0。

比方在下面的例子中减少一个 trace 函数，被函数 Bar 调用。

……
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

下面的 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}
    }
}

FuncForPC 是一个乏味的函数，它能够把程序计数器地址对应的函数的信息获取进去。如果因为内联程序计数器对应多个函数，它返回最里面的函数。

它的返回值是一个Func 类型的值，通过Func 能够取得函数地址、文件行、函数名等信息。

除了下面获取程序计数器的形式，也能够通过反射的形式获取函数的地址：

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

在程序 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
}

本文由 mdnice 多平台公布

关于后端:如何在go重打印函数调用者信息Caller

相干函数介绍

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

func CallersFrames(callers []uintptr) *Frames

func FuncForPC(pc uintptr) *Func

获取程序堆栈

获取 goroutine 的 id