Go语言中的测试、(pprof)性能调优、生成文档和示例代码

Go语言中的测试、(pprof)性能调优、生成文档和示例代码

代码测试(test)

我们在写程序时应该尽可能多写测试，而不是多做调试。

代码测试的目的是确保代码按照你的设想执行，编写测试代码可以尽早地发现程序所存在的问题。

go test命令用于对Go语言编写的代码包进行测试。可以指定要测试的文件，也可以直接对整个包进行测试，但需要包中含有测试文件，测试文件都是以_test.go结尾。

 

测试文件格式

测试程序必须属于被测试的包，并且测试程序所在文件名满足XX_test.go，所以测试代码和包中的业务代码是分开的。

测试文件中必须导入 testing 包，编写的测试函数为全局函数，测试函数的命名必须以Test开头。

例如：func TestSubstr(t *testing.T)、func TestTriangle(t *testing.T)。

T 是传给测试函数的结构类型，用来管理测试状态，支持格式化测试日志，如t.Log，t.Error，t.ErrorF 等。

 

传统测试

缺点：

1. 测试数据和测试逻辑混在一起
2. 出错信息不明确
3. 一旦一个数据出错，程序宕机，测试全部结束

 

单元测试(表格驱动测试)

func calcTriangle(a, b int) int {
	var c int
	c = int(math.Sqrt(float64(a*a + b*b)))
	return c
}

func TestTriangle(t *testing.T) {
	tests := []struct{ a, b, c int }{
		{3, 4, 5},
		{5, 12, 13},
		{8, 15, 17},
		{12, 35, 37},
		{30000, 40000, 50000},
	}

	for _, tt := range tests {
		if actual := calcTriangle(tt.a, tt.b); actual != tt.c {
			t.Errorf("calcTriangle(%d, %d); "+"got %d; expected %d",
				tt.a, tt.b, actual, tt.c)
		}
	}
}

优点：

1. 分离的测试数据和测试逻辑
2. 明确的出错信息
3. 可以部分失败
4. Go语言的语法使得我们更易实践表格驱动测试

 

基准测试（性能测试）

基准测试提供可自定义的计时器和一套基准测试算法，能方便快速地分析一段代码可能存在的CPU性能和内存分配问题。

类似于单元测试，使用者无须准备高精度的计时器和各种分析工具，
基准测试本身即可打印出非常标准的测试报告。

基准测试的使用也有一套书写规范，使用Benchmark为前缀，后面加上需要测试的函数名，并使用*testing.B作为函数参数，如下所示。

func BenchmarkFunc(b *testing.B) {
	b.ResetTimer()
	for idx := 0; idx < b.N; idx++ {
		// 要测试的代码
	}
	b.StopTimer()
}

其中b.N表示必须循环b.N次，b.N这个数字会在运行中调整，以便最终达到合适的时间消耗，方便计算出合理的数据。

有些测试代码需要一定的初始化时间，如果从Benchmark()函数开始计时，很大程度上会影响测试结果的精准性。

testing.B提供了可以方便地控制计时器的一系列方法，从而让计时器只在需要的区间进行测试。

ResetTimer()表示重置计时器，StopTimer()表示停止计时，需要精准测试的代码只需要放到这两个函数中间即可。

通过基准测试，我们能够知道使用哪种编码方式会让程序的运行效率最高

 

覆盖率测试

覆盖率测试用于统计通过运行程序包的测试有多少代码得到了执行。如果执行测试代码有70％的语句得到了运行，则测试覆盖率为70％。

使用-cover参数就可以对源码文件进行覆盖率测试。

例如我们还可以使用以下命令:

使用go test -coverprofile=c.out命令可以统计测试覆盖率，接着使用go tool cover -html=c.out可以在网页中查看更加详细的测试覆盖率结果，统计每个函数的测试覆盖率。

 

性能分析和调优

性能分析和调优是一种强大的技术，用于验证是否满足实际性能要求。Go语言支持使用go tool pprof工具进行性能查看及调优。性能分析工具可以将程序的CPU耗用、内存分配、竞态等问题以图形化方式展现出来。

在使用这个工具前，我们需要安装其依赖的图形绘制工Graphviz。

 

安装Graphviz

点击以下链接Download | Graphviz下载自己操作系统所对应的版本，按照提示进行默认安装即可。

安装完成之后，需要将Graphviz安装路径的bin文件加添加到环境变量path中。

可以在命令行中输入dot -v查看是否添加成功。

 

使用pprof进行性能分析与调优

首先我们先输入go test -bench . -cpuprofile cpu.out，生成一个cpu.out的二进制文件，该文件为程序运行的性能日志文件。接着输入go tool pprof cpu.out，接着我们使用web命令来查看图形界面的程序执行流程。

输入web后，浏览器性能可视化的图，模块越大表示性能消耗越大。

然后我们分析性能消耗的主要模块，进行优化代码即可，这里就能体现出程序员自身功力了。

性能调优的主要流程如下图：

 

生成文档和示例代码

生成文档

我们可以使用go doc查看指定包的文档，例如我们查看函数fmt.Println的文档说明。

那么，如何编写Go语言的文档呢？

我们观察源码可以发现，Go语言的文档只需要在每个函数上方用注释的方式介绍该函数的作用及使用方法，go doc命令就会自动将这些注释转化为文档展示出来。

 

godoc命令有一个非常重要的参数-http，这个参数的作用是开启Web服务，提供交互式的文档查看页面。

例如我们运行命令godoc -http :6060，运行之后，浏览器访问http://localhost:6060/即可通过网页的方式查看Go语言文档。如下图所示：

 

生成示例代码

在测试文件中，编写以Example开头的函数，同时在函数中需要写好输出结果。如下图所示：

运行程序时，不但会在文档中生成示例代码，还会做测试，检查结果是否通过测试。运行后，文档所示效果如下图：