Go?函數(shù)中獲取調(diào)用者的函數(shù)名和文件名及行號(hào)
前言:
今天介紹了通過(guò) runtime.Caller
回溯調(diào)用棧獲取調(diào)用者的信息的方法,雖然強(qiáng)大,不過(guò)頻繁獲取這個(gè)信息也是會(huì)對(duì)程序性能有影響。
背景
我們?cè)趹?yīng)用程序的代碼中添加業(yè)務(wù)日志的時(shí)候,不論是什么級(jí)別的日志,除了我們主動(dòng)傳給 Logger 讓它記錄的信息外,這行日志是由哪個(gè)函數(shù)打印的、所在的位置也是非常重要的信息,不然排查問(wèn)題的時(shí)候很有可能就猶如大海撈針。
對(duì)于在記錄日志時(shí)記錄調(diào)用 Logger 方法的調(diào)用者的函數(shù)名、行號(hào)這些信息。有的日志庫(kù)支持,比如 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"}
不過(guò)如果想搞一個(gè)健壯的開(kāi)發(fā)框架,不應(yīng)該讓自己跟某個(gè)日志庫(kù)強(qiáng)綁定,更好的方法是開(kāi)發(fā)一個(gè)日志的門面,程序里直接使用日志門面,再由門面調(diào)用日志庫(kù)完成日志的記錄。典型的 Java 的 slf4j 就是這個(gè)思路,程序里直接使用的是slf4j ,后面的 Logger 可以是 logback 也可以是 log4j 甚至是任何滿足 slf4j 約定的日志庫(kù)實(shí)現(xiàn)。
如果讓我們用 Go 設(shè)計(jì)一個(gè)Log Facade,就需要我們自己在門面里獲取調(diào)用者的函數(shù)名、文件位置了,那么在Go里面怎么實(shí)現(xiàn)這個(gè)功能呢?這就需要借助 runtime 標(biāo)準(zhǔn)庫(kù)提供的 Caller 函數(shù)了。
本文主要介紹 runtime.Caller 的使用,上面說(shuō)了那么多只是為了鋪墊一下,學(xué)會(huì)它,在哪些地方可以應(yīng)用上。
runtime.Caller
runtime.Caller 的函數(shù)簽名如下:
func Caller(skip int) (pc uintptr, file string, line int, ok bool)
Caller 函數(shù)會(huì)報(bào)告當(dāng)前 Go 程序調(diào)用棧所執(zhí)行的函數(shù)的文件和行號(hào)信息。參數(shù)skip為要上溯的棧幀數(shù),0 表示Caller的調(diào)用者(Caller所在的調(diào)用棧),1 表示調(diào)用 Caller 調(diào)用者的調(diào)用者,以此類推。是不是有點(diǎn)暈,這
里舉個(gè)例子:
func CallerA() { //獲取的是 CallerA 這個(gè)函數(shù)的調(diào)用棧 pc, file, lineNo, ok := runtime.Caller(0) //獲取的是 CallerA函數(shù)的調(diào)用者的調(diào)用棧 pc1, file1, lineNo1, ok1 := runtime.Caller(1) }
函數(shù)的返回值為調(diào)用棧標(biāo)識(shí)符、帶路徑的完整文件名、該調(diào)用在文件中的行號(hào)。如果無(wú)法獲得信息,返回值 ok 會(huì)被設(shè)為 false。
獲取調(diào)用者的函數(shù)名
runtime.Caller 返回值中第一個(gè)返回值是一個(gè)調(diào)用棧標(biāo)識(shí),通過(guò)它我們能拿到調(diào)用棧的函數(shù)信息 *runtime.Func,再進(jìn)一步獲取到調(diào)用者的函數(shù)名字,這里面會(huì)用到的函數(shù)和方法如下。
func FuncForPC(pc uintptr) *Func func (*Func) Name
runtime.FuncForPC 函數(shù)返回一個(gè)表示調(diào)用棧標(biāo)識(shí)符pc對(duì)應(yīng)的調(diào)用棧的*Func;如果該調(diào)用棧標(biāo)識(shí)符沒(méi)有對(duì)應(yīng)的調(diào)用棧,函數(shù)會(huì)返回nil。
Name 方法返回該調(diào)用棧所調(diào)用的函數(shù)的名字,上面說(shuō)了runtime.FuncForPC 有可能會(huì)返回 nil,不過(guò)Name方法在實(shí)現(xiàn)的時(shí)候做了這種情況的判斷,避免出現(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()) }
使用示例
下面看一個(gè)使用 runtime.Caller 和 runtime.FuncForPC 一起配合獲取調(diào)用者信息的簡(jiǎn)單例子:
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ù)返回路徑的最后一個(gè)元素 return fmt.Sprintf("FuncName:%s, file:%s, line:%d ", funcName, fileName, lineNo) } func main() { // 打印出getCallerInfo函數(shù)自身的信息 fmt.Println(getCallerInfo(0)) // 打印出getCallerInfo函數(shù)的調(diào)用者的信息 fmt.Println(getCallerInfo(1)) }
注意:這里我們演示地比較簡(jiǎn)單,往上追溯一個(gè)調(diào)用棧就能拿到調(diào)用者的信息。真正要實(shí)現(xiàn)日志門面之類的類庫(kù)的時(shí)候,可能是會(huì)有幾層封裝,想在日志里記錄的調(diào)用者信息應(yīng)該是業(yè)務(wù)代碼中打日志的位置,這時(shí)要向上回溯的層數(shù)肯定就不是 1 這么簡(jiǎn)單了,具體跳過(guò)幾層要看實(shí)現(xiàn)的日志門面具體的封裝情況。
總結(jié)
文章通過(guò)介紹 runtime.Caller 回溯調(diào)用棧獲取調(diào)用者的信息的方法,雖然強(qiáng)大,不過(guò)頻繁獲取這個(gè)信息也是會(huì)對(duì)程序性能有影響。我們的業(yè)務(wù)代碼不應(yīng)該依賴于它來(lái)實(shí)現(xiàn),它發(fā)揮作用的地方更多的是對(duì)業(yè)務(wù)透明的一些類庫(kù)在記錄信息的時(shí)候才會(huì)被用到。
到此這篇關(guān)于 Go 函數(shù)中獲取調(diào)用者的函數(shù)名和文件名及行號(hào)的文章就介紹到這了,更多相關(guān) Go 獲取函數(shù)名內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
golang 微服務(wù)之gRPC與Protobuf的使用
這篇文章主要介紹了golang 微服務(wù)之gRPC與Protobuf的使用,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2020-02-02GO語(yǔ)言實(shí)現(xiàn)批量壓縮圖片和水印
這篇文章主要介紹了GO語(yǔ)言實(shí)現(xiàn)批量壓縮圖片和水印,主要用到了github.com/nfnt/resize這個(gè)第三方庫(kù),僅僅支持JPG圖片格式,有相同需求的小伙伴參考下吧。2015-03-03利用go語(yǔ)言實(shí)現(xiàn)Git?重命名遠(yuǎn)程分支??
這篇文章主要介紹了go語(yǔ)言實(shí)現(xiàn)Git?重命名遠(yuǎn)程分支,文章基于go語(yǔ)言的基礎(chǔ)展開(kāi)Git?重命名遠(yuǎn)程分支的實(shí)現(xiàn)過(guò)程,需要的小伙伴可以參考一下,希望對(duì)你的學(xué)習(xí)有所幫助2022-06-06重學(xué)Go語(yǔ)言之基礎(chǔ)數(shù)據(jù)類型詳解
Go語(yǔ)言有非常強(qiáng)大的數(shù)據(jù)類型系統(tǒng),其支持的數(shù)據(jù)類型大體上可分為四類:基礎(chǔ)數(shù)據(jù)類型、引用數(shù)據(jù)類型、接口類型、復(fù)合類型。本文就來(lái)講講它們各自的用法吧2023-02-02Golang使用pprof和trace進(jìn)行診斷和修復(fù)性能問(wèn)題
在?Go?中,開(kāi)發(fā)人員可以使用強(qiáng)大的內(nèi)置工具來(lái)幫助診斷和修復(fù)性能問(wèn)題,其中兩個(gè)工具是?pprof?和?trace?包,下面就跟隨小編一起來(lái)了解下如何使用pprof和trace進(jìn)行診斷和修復(fù)性能問(wèn)題吧2024-01-01go語(yǔ)言發(fā)送smtp郵件的實(shí)現(xiàn)示例
這篇文章主要介紹了go發(fā)送smtp郵件的實(shí)現(xiàn)示例,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2020-09-09Golang運(yùn)行報(bào)錯(cuò)找不到包:package?xxx?is?not?in?GOROOT的解決過(guò)程
這篇文章主要給大家介紹了關(guān)于Golang運(yùn)行報(bào)錯(cuò)找不到包:package?xxx?is?not?in?GOROOT的解決過(guò)程,文中通過(guò)圖文介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2022-07-07Go語(yǔ)言數(shù)據(jù)結(jié)構(gòu)之二叉樹(shù)可視化詳解
這篇文章主要為大家詳細(xì)介紹了Go語(yǔ)言數(shù)據(jù)結(jié)構(gòu)中二叉樹(shù)可視化的方法詳解,文中的示例代碼講解詳細(xì),感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2022-09-09