Go?函數(shù)中獲取調用者的函數(shù)名和文件名及行號
前言:
今天介紹了通過 runtime.Caller
回溯調用棧獲取調用者的信息的方法,雖然強大,不過頻繁獲取這個信息也是會對程序性能有影響。
背景
我們在應用程序的代碼中添加業(yè)務日志的時候,不論是什么級別的日志,除了我們主動傳給 Logger 讓它記錄的信息外,這行日志是由哪個函數(shù)打印的、所在的位置也是非常重要的信息,不然排查問題的時候很有可能就猶如大海撈針。
對于在記錄日志時記錄調用 Logger 方法的調用者的函數(shù)名、行號這些信息。有的日志庫支持,比如 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"}
不過如果想搞一個健壯的開發(fā)框架,不應該讓自己跟某個日志庫強綁定,更好的方法是開發(fā)一個日志的門面,程序里直接使用日志門面,再由門面調用日志庫完成日志的記錄。典型的 Java 的 slf4j 就是這個思路,程序里直接使用的是slf4j ,后面的 Logger 可以是 logback 也可以是 log4j 甚至是任何滿足 slf4j 約定的日志庫實現(xiàn)。
如果讓我們用 Go 設計一個Log Facade,就需要我們自己在門面里獲取調用者的函數(shù)名、文件位置了,那么在Go里面怎么實現(xiàn)這個功能呢?這就需要借助 runtime 標準庫提供的 Caller 函數(shù)了。
本文主要介紹 runtime.Caller 的使用,上面說了那么多只是為了鋪墊一下,學會它,在哪些地方可以應用上。
runtime.Caller
runtime.Caller 的函數(shù)簽名如下:
func Caller(skip int) (pc uintptr, file string, line int, ok bool)
Caller 函數(shù)會報告當前 Go 程序調用棧所執(zhí)行的函數(shù)的文件和行號信息。參數(shù)skip為要上溯的棧幀數(shù),0 表示Caller的調用者(Caller所在的調用棧),1 表示調用 Caller 調用者的調用者,以此類推。是不是有點暈,這
里舉個例子:
func CallerA() { //獲取的是 CallerA 這個函數(shù)的調用棧 pc, file, lineNo, ok := runtime.Caller(0) //獲取的是 CallerA函數(shù)的調用者的調用棧 pc1, file1, lineNo1, ok1 := runtime.Caller(1) }
函數(shù)的返回值為調用棧標識符、帶路徑的完整文件名、該調用在文件中的行號。如果無法獲得信息,返回值 ok 會被設為 false。
獲取調用者的函數(shù)名
runtime.Caller 返回值中第一個返回值是一個調用棧標識,通過它我們能拿到調用棧的函數(shù)信息 *runtime.Func,再進一步獲取到調用者的函數(shù)名字,這里面會用到的函數(shù)和方法如下。
func FuncForPC(pc uintptr) *Func func (*Func) Name
runtime.FuncForPC 函數(shù)返回一個表示調用棧標識符pc對應的調用棧的*Func;如果該調用棧標識符沒有對應的調用棧,函數(shù)會返回nil。
Name 方法返回該調用棧所調用的函數(shù)的名字,上面說了runtime.FuncForPC 有可能會返回 nil,不過Name方法在實現(xiàn)的時候做了這種情況的判斷,避免出現(xiàn)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.Caller 和 runtime.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函數(shù)返回路徑的最后一個元素 return fmt.Sprintf("FuncName:%s, file:%s, line:%d ", funcName, fileName, lineNo) } func main() { // 打印出getCallerInfo函數(shù)自身的信息 fmt.Println(getCallerInfo(0)) // 打印出getCallerInfo函數(shù)的調用者的信息 fmt.Println(getCallerInfo(1)) }
注意:這里我們演示地比較簡單,往上追溯一個調用棧就能拿到調用者的信息。真正要實現(xiàn)日志門面之類的類庫的時候,可能是會有幾層封裝,想在日志里記錄的調用者信息應該是業(yè)務代碼中打日志的位置,這時要向上回溯的層數(shù)肯定就不是 1 這么簡單了,具體跳過幾層要看實現(xiàn)的日志門面具體的封裝情況。
總結
文章通過介紹 runtime.Caller 回溯調用棧獲取調用者的信息的方法,雖然強大,不過頻繁獲取這個信息也是會對程序性能有影響。我們的業(yè)務代碼不應該依賴于它來實現(xiàn),它發(fā)揮作用的地方更多的是對業(yè)務透明的一些類庫在記錄信息的時候才會被用到。
到此這篇關于 Go 函數(shù)中獲取調用者的函數(shù)名和文件名及行號的文章就介紹到這了,更多相關 Go 獲取函數(shù)名內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
Golang使用pprof和trace進行診斷和修復性能問題
在?Go?中,開發(fā)人員可以使用強大的內置工具來幫助診斷和修復性能問題,其中兩個工具是?pprof?和?trace?包,下面就跟隨小編一起來了解下如何使用pprof和trace進行診斷和修復性能問題吧2024-01-01Golang運行報錯找不到包:package?xxx?is?not?in?GOROOT的解決過程
這篇文章主要給大家介紹了關于Golang運行報錯找不到包:package?xxx?is?not?in?GOROOT的解決過程,文中通過圖文介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2022-07-07