golang runtime.Caller(skip int) 介绍

函数原型,及官方描述:

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

// 函数用途
Caller reports file and line number information about function invocations on the calling goroutine's stack. 

参数:
The argument skip is the number of stack frames to ascend, with 0 identifying the caller of Caller. (For historical reasons the meaning of skip differs between Caller and Callers.) 

// 返回值:
The return values report the program counter, file name, and line number within the file of the corresponding call. 
The boolean ok is false if it was not possible to recover the information.

该方法在日志打印时会用到, 用来获取当前调用栈帧所在的文件行号,及文件名信息,这样方便开发人员在同一位置获取需要的调用处的文件信息;

从官方描述可以知,参数 skip 是用来控制当前调用栈哪个帧的信息, skip 为 0 时,表示输出当前栈帧的文件名及行号信息,

skip 为 1 时,输出当前调用栈上一帧的文件名及行号, 下面是输出结果,可以看到,在同一函数内调用,获取到的 file 是可以不同的:

main.go

 package main
 
  import "test/log-trace/log"
  
  func main() {
      log.PrintFileAndLine()
  }

log/log.go

package log

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

func WritFileAndLine(skip int) {
	_, file, line, ok := runtime.Caller(skip)
	if !ok {
		file = "???"
		line = 0
	} else {
		file = path.Base(file)
	}

	fmt.Println("the file: ", file, ", and line: ", line, " with skip=", skip)
}

func PrintFileAndLine() {
	WritFileAndLine(0)
	WritFileAndLine(1)
	WritFileAndLine(2)
}
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章