golang获取执行函数名，执行文件名与所在行数

本文首发于我的个人博客

这篇文章介绍了作者在参与一个golang日志系统的开发的时候，解决需要打印出执行日志打印操作时的业务函数名，业务文件名与所在行数的需求过程中，遇到的问题和解决方案

需求场景

在平日里使用日志的时候，一个好的日志系统，往往会打印出类似如下的信息

<log_level>:<log_message>:<package_path>/<filename>:<line_no>:<function_name>
比如
INFO:connect to sql:/users/admin/home/go/src/io/rivers/demoProject/main.go:45:io.rivers.demoProject.testFunction

这样子在打印出日志等级，日志消息的同时，输出业务逻辑所在的文件，行数，函数，对后期的bug排查，性能分析都有很大的帮助

那么，如何在golang中实现这一功能呢？

实现方式

golang的runtime包提供了与之相应的函数接口，主要是runtime.Caller和runtime.FuncForPC

先看一下二者的函数签名

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

func FuncForPC(pc uintptr) *Func

单看函数签名就比较容易了解到:

• runtime.Caller能够返回在函数栈中的PC(指令寄存器，可以认为存储了当前执行到了哪里)，所在的文件，所在文件的具体哪一行
• runtime.FuncForPC能够根据给定的指令寄存器给出其所在的行数

其中runtime.FuncForPC的参数比较容易理解，就是指指令寄存器，但是runtime.Caller的参数需要解释一下

这里的skip指的是跳过多少个函数栈：

• skip == 0，不跳过函数栈，返回当前函数PC，文件名，所在行
• skip == 1，跳过当前函数栈，返回上层调用者调用当前