golang vet工具的使用
一般来说每一门语言都有一些用来进行语法检查的工具,vet就是golang中提供的语法检查工具,可以让我检查出package或者源码文件中一些隐含的错误,规范我们的项目代码,下面我简单讲解下该工具的使用.
vet工具的路径
vet安装在每一个平台操作系统的
/usr/local/go/pkg/tool/darwin_amd64/vet
每个平台的安装路都不相同,比如linux 32位下可能是:
/usr/local/go/pkg/tool/darwin_386/vet
vet的使用
go vet 和 go tool vet基本上功能类似,go tool vet可以递归的对package进行语法检测,可以自行测试区别。
对一个.go源文件进行检查
下面的vet.go代码有一行语法错误,我们用go vet vet.go
检查
package vet
import (
"fmt"
)
func vetTest() xxxxx{
fmt.Println("vet test")
}
运行结果如下:
一个包下所有源文件进行检测
go tool vet source/directory/*.go
对一个package进行语法检查
我们同样可以利用vet 对一个package进行检查,当然传入的包名必须是 相对路径 或者完整package。
例如我当前项目目录在$GOPATH/src/Test ,那么传入可以输入 go vet Test/vet 对vet包进行语法检查
如果我当前工作目录就是Test 那么我也可以直接输入 go vet ./vet 利用相对路径进行语法检查
不可以同时对package和源文件进行检查,但可以同时对多个包或者多个源文件进行检查
检测多个package
go vet package1 package2
检测多个源文件
go vet file1.go file2.go
go vet file.go package1
附加tags
我们还可以给vet 传递一些 tag 来指定检测行为,默认是all,全部检查,当传入以下tag的时候all将被设置为false
使用方法
go vet -atomic=false test.go
更多tag含义如下表,我从网上寻找,大家也可以去golang 官方去找 vet command的文档,里面更精确地描述。
tag | 描述 |
---|---|
-all | 进行全部检查。如果有其他检查标记被设置,则命令程序会将此值变为false。默认值为true。 |
-asmdecl | 对汇编语言的源码文件进行检查。默认值为false。 |
-assign | 检查赋值语句。默认值为false。 |
-atomic | 检查代码中对代码包sync/atomic的使用是否正确。默认值为false。 |
-composites | 是否使用复合结构检查的白名单。仅供测试使用。默认值为true。 |
-compositeWhiteList | 对汇编语言的源码文件进行检查。默认值为false。 |
-assign | 检查赋值语句。默认值为false。 |
-methods | 检查那些拥有标准命名的方法的签名。默认值为false。 |
-printf | 检查代码中对打印函数的使用是否正确。默认值为false。 |
-printfuncs | 需要检查的代码中使用的打印函数的名称的列表,多个函数名称之间用英文半角逗号分隔。默认值为空字符串。 |
-rangeloops | 检查代码中对在range 语句块中迭代赋值的变量的使用是否正确。默认值为false。 |
-structtags | 检查结构体类型的字段的标签的格式是否标准。默认值为false。 |
-unreachable | 查找并报告不可到达的代码。默认值为false。 |