Golang错误追踪与源码片段展示插件库tracerr使用指南

tracerr是一个轻量级的Go错误追踪库，它能够提供比标准库更详细的错误堆栈信息，并可以展示源码片段，非常适合调试和错误追踪。

安装tracerr

go get github.com/ztrue/tracerr

基本用法

1. 创建带堆栈的错误

package main

import (
	"fmt"
	"github.com/ztrue/tracerr"
)

func main() {
	err := doSomething()
	if err != nil {
		fmt.Println(tracerr.Sprint(err))
	}
}

func doSomething() error {
	return tracerr.New("something went wrong")
}

输出将包含完整的调用堆栈和源码位置。

2. 包装现有错误

func doSomethingElse() error {
	_, err := os.Open("nonexistent.file")
	if err != nil {
		return tracerr.Wrap(err)
	}
	return nil
}

3. 自定义堆栈深度

func deepFunction() error {
	return tracerr.NewWithDepth(1, "error from deep function")
}

高级功能

1. 获取堆栈帧

err := doSomething()
if err != nil {
	frames := tracerr.StackTrace(err)
	for _, frame := range frames {
		fmt.Printf("File: %s, Line: %d, Function: %s\n", 
			frame.Path, frame.Line, frame.Func)
	}
}

2. 格式化输出

err := doSomething()
if err != nil {
	// 彩色输出
	fmt.Println(tracerr.SprintColor(err))
	
	// JSON格式
	json, _ := tracerr.MarshalJSON(err)
	fmt.Println(string(json))
}

3. 源码片段展示

err := doSomething()
if err != nil {
	// 显示源码片段
	fmt.Println(tracerr.SprintSource(err))
}

实际应用示例

package main

import (
	"fmt"
	"os"
	"github.com/ztrue/tracerr"
)

func main() {
	if err := processFile("config.json"); err != nil {
		// 打印带源码片段的错误信息
		fmt.Println(tracerr.SprintSource(err))
		os.Exit(1)
	}
}

func processFile(filename string) error {
	if err := validateFile(filename); err != nil {
		return tracerr.Wrap(err)
	}
	// 其他处理逻辑...
	return nil
}

func validateFile(filename string) error {
	if _, err := os.Stat(filename); os.IsNotExist(err) {
		return tracerr.Errorf("file %s does not exist", filename)
	}
	return nil
}

与标准库对比

相比标准库的errors包，tracerr提供了：

1. 完整的调用堆栈信息
2. 源码片段展示
3. 多种格式化输出选项
4. 更丰富的错误上下文信息

性能考虑

tracerr在创建错误时会收集堆栈信息，这会有一定的性能开销。在生产环境中，可以考虑：

1. 只在需要调试时使用tracerr
2. 使用tracerr.Unwrap(err)获取原始错误
3. 通过环境变量控制是否启用详细追踪

总结

tracerr是一个强大的错误追踪工具，特别适合在开发阶段使用。它能够提供比标准库更详细的错误信息，帮助开发者快速定位问题。通过源码片段展示功能，可以直观地看到错误发生的位置和上下文代码，大大提高了调试效率。

对于生产环境，建议结合日志系统使用，并根据需要控制错误信息的详细程度。