专栏首页网管叨bi叨如何在 Go 函数中获取调用者的函数名、文件名、行号...

如何在 Go 函数中获取调用者的函数名、文件名、行号...

背景

我们在应用程序的代码中添加业务日志的时候,不论是什么级别的日志,除了我们主动传给 Logger 让它记录的信息外,这行日志是由哪个函数打印的、所在的位置也是非常重要的信息,不然排查问题的时候很有可能就犹如大海捞针。

对于在记录日志时记录调用 Logger 方法的调用者的函数名、行号这些信息。有的日志库支持,比如 Zap

func main() {
  logger, _ := zap.NewProduction(zap.AddCaller())
  defer logger.Sync()

  logger.Info("hello world")
}

输出:

{"level":"info","ts":1587740198.9508286,"caller":"caller/main.go:9","msg":"hello world"}

不过如果想搞一个健壮的开发框架,不应该让自己跟某个日志库强绑定,更好的方法是开发一个日志的门面,程序里直接使用日志门面,再由门面调用日志库完成日志的记录。典型的 Java 的 slf4j 就是这个思路,程序里直接使用的是slf4j ,后面的 Logger 可以是 logback 也可以是 log4j 甚至是任何满足 slf4j 约定的日志库实现。

如果让我们用 Go 设计一个Log Facade,就需要我们自己在门面里获取调用者的函数名、文件位置了,那么在Go里面怎么实现这个功能呢?这就需要借助 runtime 标准库提供的 Caller 函数了。

本文主要介绍 runtime.Caller 的使用,上面说了那么多只是为了铺垫一下,学会它,在哪些地方可以应用上。

runtime.Caller

runtime.Caller 的函数签名如下:

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

Caller 函数会报告当前 Go 程序调用栈所执行的函数的文件和行号信息。参数skip为要上溯的栈帧数,0 表示Caller的调用者(Caller所在的调用栈),1 表示调用 Caller 调用者的调用者,以此类推。是不是有点晕,这里举个例子

func CallerA() {
  //获取的是 CallerA 这个函数的调用栈
  pc, file, lineNo, ok := runtime.Caller(0)
  //获取的是 CallerA函数的调用者的调用栈
  pc1, file1, lineNo1, ok1 := runtime.Caller(1)
}

函数的返回值为调用栈标识符、带路径的完整文件名、该调用在文件中的行号。如果无法获得信息,返回值 ok 会被设为 false。

获取调用者的函数名

runtime.Caller 返回值中第一个返回值是一个调用栈标识,通过它我们能拿到调用栈的函数信息 *runtime.Func,再进一步获取到调用者的函数名字,这里面会用到的函数和方法如下。

func FuncForPC(pc uintptr) *Func

func (*Func) Name

runtime.FuncForPC 函数返回一个表示调用栈标识符pc对应的调用栈的*Func;如果该调用栈标识符没有对应的调用栈,函数会返回nil

Name 方法返回该调用栈所调用的函数的名字,上面说了runtime.FuncForPC 有可能会返回 nil,不过Name方法在实现的时候做了这种情况的判断,避免出现panic 的可能,所以我们可以放心大胆的使用。

func (f *Func) Name() string {
 if f == nil {
  return ""
 }
 fn := f.raw()
 if fn.isInlined() { // inlined version
  fi := (*funcinl)(unsafe.Pointer(fn))
  return fi.name
 }
 return funcname(f.funcInfo())
}

使用示例

下面看一个使用 runtime.Callerruntime.FuncForPC 一起配合获取调用者信息的简单例子

package main

import (
 "fmt"
 "path"
 "runtime"
)

func getCallerInfo(skip int) (info string) {

 pc, file, lineNo, ok := runtime.Caller(skip)
 if !ok {

  info = "runtime.Caller() failed"
  return
 }
 funcName := runtime.FuncForPC(pc).Name()
 fileName := path.Base(file) // Base函数返回路径的最后一个元素
 return fmt.Sprintf("FuncName:%s, file:%s, line:%d ", funcName, fileName, lineNo)
}

func main() {

 // 打印出getCallerInfo函数自身的信息
 fmt.Println(getCallerInfo(0))
 // 打印出getCallerInfo函数的调用者的信息
 fmt.Println(getCallerInfo(1))
}

注意:这里我们演示地比较简单,往上追溯一个调用栈就能拿到调用者的信息。真正要实现日志门面之类的类库的时候,可能是会有几层封装,想在日志里记录的调用者信息应该是业务代码中打日志的位置,这时要向上回溯的层数肯定就不是 1 这么简单了,具体跳过几层要看实现的日志门面具体的封装情况。

总结

今天介绍了通过 runtime.Caller 回溯调用栈获取调用者的信息的方法,虽然强大,不过频繁获取这个信息也是会对程序性能有影响。我们的业务代码不应该依赖于它来实现,它发挥作用的地方更多的是对业务透明的一些类库在记录信息的时候才会被用到。

- END -

文章分享自微信公众号:
网管叨bi叨

本文参与 腾讯云自媒体分享计划 ,欢迎热爱写作的你一起参与!

作者:KevinYan11
原始发表时间:2022-05-05
如有侵权,请联系 cloudcommunity@tencent.com 删除。
登录 后参与评论
0 条评论

相关文章

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

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

    李海彬
  • Golang语言的函数调用信息

    函数的调用信息是程序中比较重要运行期信息, 在很多场合都会用到(比如调试或日志). Go语言 runtime 包的 runtime.Caller / runti...

    李海彬
  • Go语言实战笔记(十八)| Go log 日志

    在我们开发程序后,如果有一些问题需要对程序进行调试的时候,日志是必不可少的,这是我们分析程序问题常用的手段。

    飞雪无情
  • logrus中输出文件名、行号及函数名

    日志中输出文件名,行号及函数名是个比较有用的功能,那么在logrus中如何作到呢?

    跑马溜溜的球
  • logrus自定义日志输出格式

    所以,实现自定义日志格式,本质上就是实现Formatter接口,然后通过SetFormatter方式将其告知logrus。

    跑马溜溜的球
  • Lua 5.3 的调试库

    如果 message 有,且不是字符串或 nil, 函数不做任何处理直接返回 message。 否则,它返回调用栈的栈回溯信息。 字符串可选项 message ...

    bering
  • 《Go语言程序设计》读书笔记(二)函数

    《Go 语言程序设计》在线阅读地址:https://yar999.gitbooks.io/gopl-zh/content/

    KevinYan
  • Google Breakpad:脱离符号的调试工具

    https://jackwish.net/2015/introduction-of-google-breakpad.html

    Linux阅码场
  • go-runtime/pprof

    开始之前先下载性能文件分析工具,下载地址: http://www.graphviz.org/download/

    酷走天涯
  • package runtime

    runtime包提供和go运行时环境的互操作,如控制go程的函数。它也包括用于reflect包的低层次类型信息;参见reflect报的文档获取运行时类型系统的可...

    李海彬
  • Go的日志库log竟然这么简单!

    最近在尝试阅读字节开源RPC框架Kitex的源码,看到日志库klog部分,果不其然在Go原生的log库的基础上增加了自己的设计,大体包括增加了一些格式化的输出、...

    白泽z
  • 从Python调用堆栈获取行号等信息

    程序中的日志打印,或者消息上传,比如kafka消息等等。经常上传的消息中需要上传堆栈信息中的文件名、行号、上层调用者等具体用于定位的消息。Python提供了以下...

    职场亮哥
  • Go日志库开发

    在构造函数里面主要就是通过传递过来的参数(日志级别)对创建一个consolelogger对象

    字节脉搏实验室
  • Gin框架 - 自定义错误处理

    很多读者在后台向我要 Gin 框架实战系列的 Demo 源码,在这里再说明一下,源码我都更新到 GitHub 上,地址:https://github.com/x...

    新亮
  • 运行时 runtime的神奇用法

    runtime 包 提供了运行时与系统的交互,比如控制协程函数,触发垃圾立即回收等等底层操作,下面我们就运行时能做的所有事情逐个进行说明与代码演示

    酷走天涯
  • runtime 包

    runtime 包 提供了运行时与系统的交互,比如控制协程函数,触发垃圾立即回收等等底层操作,下面我们就运行时能做的所有事情逐个进行说明与代码演示

    酷走天涯
  • go-runtime

    runtime 包 提供了运行时与系统的交互,比如控制协程函数,触发垃圾立即回收等等底层操作,下面我们就运行时能做的所有事情逐个进行说明与代码演示

    酷走天涯
  • 高性能 Go 日志库 zap 设计与实现

    最近我也在学习如何在开发中让代码运行更加高效,然后在浏览各种优秀的日志设计的时候看到 uber 有一个叫 zap 的日志库引起了我的注意,它主要特性是对性能和内...

    luozhiyun
  • Unix调试工具dbx使用方法

    (dbx)stop in funcname //在funcname函数入口处设置断点

    阳光岛主

扫码关注腾讯云开发者

领取腾讯云代金券