Go中runtime.Caller的使用

Go中runtime.Caller的使用

下面介绍Go runtime.Caller使用

runtime.Caller
函数定义
func runtime.Caller(skip int) (pc uintptr, file string, line int, ok bool)

作用
获取函数Caller的调用信息

参数
skip=0时: 返回调用Caller的函数A的pc(program counter)(A即runtime.Caller代码当前所在函数）、所在文件名以及Caller在函数A中的行数
skip=1时: 返回调用函数A的函数B的pc、所在文件名以及函数A在函数B中的行数；以此类推

pc: 程序计数器，指向下一条将要取指的指令地址
file: pc对应的函数所在文件路径
line: 被调用方在pc对应的函数中的行数

示例：
/Users/go/src/liyouming/golang-trick/40-clean-code-controll-flow/util/util.go

package util
import (
	"bytes"
	"fmt"
	"runtime"
)
func CallerTest() {
	for i := 0; i <= 4; i++ {
		pc, file, line, ok := runtime.Caller(i)
		if ok {
			fmt.Printf("当i:=%d时:\n调用者的pc:%v\n调用者的函数名:%s\n"+
				"调用者所在file:%s\n被调用者在调用者中的line:%d\n", i, pc, runtime.FuncForPC(pc).Name(), file, line)
			fmt.Println(string(bytes.Repeat([]byte("*"), 10)))
		}
	}
}

main.go

package main
import (
	"golang-trick/40-clean-code-controll-flow/util"
)
func main() {
	util.CallerTest()
}

运行结果如下：

当i:=0时:
调用者的pc:17363077
调用者的函数名:golang-trick/40-clean-code-controll-flow/util.CallerTest
调用者所在file:/Users/go/src/liyouming/golang-trick/40-clean-code-controll-flow/util/util.go
被调用者在调用者中的line:11
**********
当i:=1时:
调用者的pc:17363702
调用者的函数名:main.main
调用者所在file:/Users/go/src/liyouming/golang-trick/40-clean-code-controll-flow/main.go
被调用者在调用者中的line:8
**********
当i:=2时:
调用者的pc:16987729
调用者的函数名:runtime.main
调用者所在file:/usr/local/opt/go/libexec/src/runtime/proc.go
被调用者在调用者中的line:250
**********
当i:=3时:
调用者的pc:17158656
调用者的函数名:runtime.goexit
调用者所在file:/usr/local/opt/go/libexec/src/runtime/asm_amd64.s
被调用者在调用者中的line:1594
**********

补充：

Go学习——runtime.Caller()函数

函数：

func Caller(skip int) (pc uintptr, file string, line int, ok bool)
Caller()报告当前go程调用栈所执行的函数的文件和行号信息。

参数解释：

• skip：

上溯的栈帧数，0表示Caller的调用者（Caller所在的调用栈）（0-当前函数，1-上一层函数，…）。

• pc ：

调用栈标识符

• file:

文件路径

• line:

该调用在文件中的行号

• ok:

如果无法获得信息，ok会被设为false

例子：

可能看了上面的解释，对于skip参数依然很迷惑，那我们来看个例子：

此时的项目目录结构：

blog/
	├── conf /...
	├── main.go
	├── middleware /...
	├── models /...
	├── pkg
	│ 	├── e /...
	│ 	├── logging
	│ 	│ 	├── file.go
	│ 	│ 	└── log.go
	│ 	├── setting /...
	│ 	└── util /...
	├── routers
	│ 	├── api
	│ 	│ 	├── auth.go
	│ 	│ 	└── v1
	│ 	│ 		├── article.go
	│ 	│ 		└── tag.go
	│ 	└── router.go
	├── runtime

就拿 blog/routers/api/v1/article.go当例子，在这个文件中GetArticle()中用到了logging.Info():

// followJianYuStudyGo/routers/api/v1/article.go
func GetArticle(c *gin.Context) {
	...
	} else {
		for _, err := range valid.Errors {
			logging.Info(err.Key, err.Message) // article.go:122  上溯栈帧数skip = 2
		}
	}
	...
}
// followJianYuStudyGo/pkg/logging/log.go
func Info(v ...interface{}) {
	setPrefix(INFO) // log.go:67 上溯栈帧数skip = 1
	logger.Println(v)
}
func setPrefix(level Level) {
	_, file, line, ok := runtime.Caller(DefaultCallerDepth) // log.go:50 上溯栈帧数skip = 0
    ....
}

如果我们的skip：

• 为0：

代表上溯的栈帧数为0，返回的file就是调用Caller()的位置：

[INFO][log.go:50]2022/04/29 21:07:11 [created_by 创建人不可以为空]

• 为1：

代表上溯的栈帧数为1，返回的file就是调用Caller()的上一层位置：

[INFO][log.go:67]2022/04/29 21:25:57 [state 状态只允许为0或1]

• 为2:

代表上溯的栈帧数为2，返回的file就是调用Caller()的上一层的上一层位置：

[INFO][article.go:122]2022/04/29 20:52:23 [state 状态只允许为0或1]

重点：
 因为我们在logging包里的log.go文件封装了Info()、Debug()、Warn()、....函数，其他地方调用的都是这种封装好的函数，所以如果我们打印日志的时候，想要获取使用了logging.Info()的位置，runtime.Caller(skip int)的skip是要设置为2的（原因见skip=2的部分）！！！！

到此这篇关于Go中runtime.Caller的使用的文章就介绍到这了,更多相关Go runtime.Caller使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！