golang 的 logger 的 Output calldepth 参数作用？

Question

文档中 calldepth 的解释太简洁了，

其中 calldepth 是用来做什么，在 什么场景下有起作用

Answer 1

calldepth，顾名思义就是“调用深度”。

首先你要知道什么是“函数栈”。

假设有这样的函数间关系 A → B → C... 函数 A 调用了函数 B，函数 B 又调用了函数 C，依次类推……那么在函数 C 内部想要知道到底是谁调用的它（也就是 A），那么就得在栈上往上找 2 层。

log 模块的函数栈是 log.Printf → std.Output → runtime.Caller 这样的，所以默认值是 2，就是从 runtime.Caller 往上找 2 层，就能知道 log.Printf 是从哪来的了。

为啥要往上找？因为你这是日志模块，你肯定需要知道最终打 log 的那个最上层的调用方到底是谁（就是谁执行了 log.Printf 这行代码），这样才能再日志里输出出来的文件、行号等堆栈信息。

如果你不是直接用的 log 模块，而是自己又封装了一层，那 calldepth 就得传 3 了。因为还传 2 只能定位到你封装的那层上，定位不到实际打 log 的那层。

依次类推，你每多封装一层，celldepth 就 +1。

---

至于注释里的 PC，是 Program Counter（程序计数器）的缩写。

这个需要了解一点计算机组成原理的相关知识。你就知道它实际代表 CPU 当前指令地址就可以了。所谓 “恢复 PC” 就是指定位到当前执行的那句代码上。这个前面已经提到过了。

Answer 2

在 Golang 的 logger 中，Output 函数的 calldepth 参数用于指示调用栈的深度。这个参数是一个整数，用于指定应该在调用栈中向上追溯多少层来获取调用日志记录函数的位置信息。这样可以在日志中准确地显示日志记录函数的调用位置。

在 Golang 中，可以使用 log 包提供的 logger 来记录日志。其中 Output 函数用于输出日志记录，它的函数签名如下：

go

func (l *Logger) Output(calldepth int, s string) error
在使用 Output 函数时，calldepth 参数通常设置为 2，这是因为 log 包内部的 Print 系列函数会调用 Output 函数进行日志记录，而 Print 系列函数的调用栈深度为 2。所以将 calldepth 设置为 2，可以正确地获取到日志记录函数的位置信息，使得日志中能够准确显示日志记录函数的调用位置。

示例：

go

package main

import (

"log"

)

func main() {

log.SetFlags(log.Lshortfile)log.Println("This is a log message.")

}
在上面的示例中，log.Lshortfile 表示在日志中显示文件名和行号，而不显示完整的调用栈信息。当使用 log.Println 进行日志记录时，log 包会调用 Output 函数记录日志，而此时 calldepth 设置为 2，表示在调用栈中向上追溯 2 层，从而准确获取到 log.Println 的调用位置。因此，日志中会显示类似 "main.go:9: This is a log message." 这样的信息，其中 "main.go:9" 表示日志记录的位置信息。