【问题标题】:How do you get a Golang program to print the line number of the error it just called?如何让 Golang 程序打印它刚刚调用的错误的行号?
【发布时间】:2014-07-17 16:50:40
【问题描述】:

我试图在我的 Golang 程序中使用 log.Fatal 抛出错误,但是,log.Fatal 也不会打印运行 log.Fatal 的行。有没有办法访问调用 log.Fatal 的行号?即有没有办法在抛出错误时获取行号?

我试图用谷歌搜索,但不确定如何。我能得到的最好的东西是printing the stack trace,我想这很好,但可能有点太多了。我也不想每次需要行号时都写debug.PrintStack(),我只是很惊讶没有任何内置函数,如log.FatalStackTrace() 或其他不是服装的东西。

另外,我不想制作自己的调试/错误处理东西的原因是因为我不希望人们必须学习如何使用我的特殊服装处理代码。我只想要一些标准的东西,人们可以稍后阅读我的代码并像

“啊,好吧,所以它抛出错误并执行 X...”

了解我的代码的人越少越好:)

【问题讨论】:

  • 当您打印行号时,这意味着我将不得不深入研究您的代码,因此“了解我的代码的人越少越好”在这里没有实际意义。你应该做的是有清晰简洁的错误。

标签: error-handling go


【解决方案1】:

您可以在自定义 Logger 上设置标志,也可以在默认值上设置 Llongfile or Lshortfile

// to change the flags on the default logger
log.SetFlags(log.LstdFlags | log.Lshortfile)

【讨论】:

  • 那么,为了让它工作,我只需要在一个包文件的顶部设置它,它就可以用于该包的所有文件?
  • 是的,如果您使用的是自定义日志,您可以像 var mylog = log.New(os.Stderr, "app: ", log.LstdFlags | log.Lshortfile) 一样使用它。
  • 我真的需要创建一个变量吗?我不能只在 go 文件的顶部执行 log.SetFlags(log.LstdFlags | log.Lshortfile) 吗?当我尝试执行 log.SetFlags(log.LstdFlags | log.Lshortfile) 时,出现错误:expected declaration, found 'INDENT' log。不得不为它创建一个变量让我很恼火,为什么不能有log.Fatal("string", log.Flag)。但是创建一个新的变量日志确实有效。创建日志变量和东西是标准的事情吗?
  • @Pinocchio:该错误是因为它不是有效的 Go,您不能在顶层进行裸函数调用。将它放在 init() 或其他一些入口点中。
  • 你必须把它放在func init() {}
【解决方案2】:

短版,没有直接内置,但是您可以使用runtime.Caller以最小的学习曲线实现它

func HandleError(err error) (b bool) {
    if err != nil {
        // notice that we're using 1, so it will actually log where
        // the error happened, 0 = this function, we don't want that.
        _, filename, line, _ := runtime.Caller(1)
        log.Printf("[error] %s:%d %v", filename, line, err)
        b = true
    }
    return
}

//this logs the function name as well.
func FancyHandleError(err error) (b bool) {
    if err != nil {
        // notice that we're using 1, so it will actually log the where
        // the error happened, 0 = this function, we don't want that.
        pc, filename, line, _ := runtime.Caller(1)

        log.Printf("[error] in %s[%s:%d] %v", runtime.FuncForPC(pc).Name(), filename, line, err)
        b = true
    }
    return
}

func main() {
    if FancyHandleError(fmt.Errorf("it's the end of the world")) {
        log.Print("stuff")
    }
}

playground

【讨论】:

  • 虽然已经给出的答案巧妙地解决了问题,但您的解决方案提醒我存在一些很棒的东西——运行时包!可爱的东西:) golang.org/pkg/runtime
  • 从runtime.Caller() 分配的fn 变量实际上是文件名,而不是函数引用。我认为 fn 是函数,而不是 filename.
  • 太棒了!谢谢。这是runtime 包使用的一个很好的例子。非常有助于通过日志进行调试。
  • 太棒了!这个答案很好地解释了为什么 logger 知道它在哪里调用。
【解决方案3】:

如果您需要确切的堆栈跟踪,请查看https://github.com/ztrue/tracerr

我创建这个包是为了同时拥有堆栈跟踪和源代码片段,以便能够更快地调试并记录更多详细信息的错误。

这是一个代码示例:

package main

import (
    "io/ioutil"
    "github.com/ztrue/tracerr"
)

func main() {
    if err := read(); err != nil {
        tracerr.PrintSourceColor(err)
    }
}

func read() error {
    return readNonExistent()
}

func readNonExistent() error {
    _, err := ioutil.ReadFile("/tmp/non_existent_file")
    // Add stack trace to existing error, no matter if it's nil.
    return tracerr.Wrap(err)
}

这是输出:

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2015-12-18
    • 1970-01-01
    • 2017-12-19
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2018-03-22
    • 1970-01-01
    相关资源
    最近更新 更多