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的部分）！！！！