errors包返回堆栈信息的性能测试

errors包返回堆栈信息的性能测试

上一篇Golang中使用errors返回调用堆栈信息 讲了使用第三方开源库的errors github.com/go-errors/errors，错误信息带调用栈，方便定位错误的抛出位置。

通过堆栈的信息来定位是方便了，性能怎么样，适不适合项目中使用就得实际跑跑结果。

---

简单与标准库的errors包的基准测试对比下：

err.go文件

import (
	"errors"
	e "github.com/go-errors/errors"
)

func Err() error {
	return e.New("报错啦，抛出异常！！")
}

func ErrNormal() error {
	return errors.New("报错啦，抛出异常！！")
}

err_test.go文件

import (
	"testing"
)

func BenchmarkErr(b *testing.B) {
	for i := 0; i < b.N; i++ {
		Err()
	}
}

func BenchmarkErrNormal(b *testing.B) {
	for i := 0; i < b.N; i++ {
		ErrNormal()
	}
}

执行Benchmark基准测试
go test -bench=".*"

在本机环境测试结果下，1255 ns/op和 0.3250 ns/op, 将近1000多倍的耗时

---

多运行几次基准测试，通过对比工具直观对比看看，这里用基准测试报告对比工具

先安装对比工具
go install golang.org/x/perf/cmd/benchstat@latest

注意点

1. 使用对比工具，两个基准测试函数名字要一致才可以，不一致会提示geomean，这里都命名为BenchmarkErr
2. 基准测试运行的次数不足以提供足够的样本数量会提示need XX samples for...的提示, 可以通过加参数-count=次数指定运行基准测试次数

执行下调用Err第三方库的错误返回的基准测试, 运行10次，写到 Err.txt
go test -bench="BenchmarkErr" -count=10 > Err.txt

func BenchmarkErr(b *testing.B) {
	for i := 0; i < b.N; i++ {
		Err()
	}
}

再执行下调用ErrNormal标准库的错误返回的基准测试, 同样运行10次，写到 ErrNormal.txt
go test -bench="BenchmarkErr" -count=10 > ErrNormal.txt

func BenchmarkErr(b *testing.B) {
	for i := 0; i < b.N; i++ {
        ErrNormal()
	}
}

执行完两个基准测试后的文件如下

接下来，通过对比工具benchstat来对比两个基准测试文件
执行命令： benchstat Err.txt ErrNormal.txt

结果显而易见，标准库 errors 的性能相比第三方库 go-errors/errors 接近百分百提升，由于go-errors/errors库会记录调用栈，耗时是会比较长。

具体适用就看性能要求，调试模式或者工具类的就无所谓，数据量大性能要求高的线上环境则不太建议。

（有错误的地方，请待纠正）