赶快使用这些静态扫描工具提高你的 Golang 代码质量！

最新推荐文章于 2024-05-14 02:48:00 发布

路多辛

最新推荐文章于 2024-05-14 02:48:00 发布

阅读量986

点赞数

分类专栏： Golang系列知识讲解文章标签： golang 开发语言架构 Powered by 金山文档

本文链接：https://blog.csdn.net/luduoyuan/article/details/128667352

版权

159 篇文章 29 订阅

订阅专栏

平常研发中，保障代码的高质量是非常重要的。我们通常需要借助工具来快速发现代码中的问题，本文就来介绍几款 Golang 官方开发的及官方推荐的静态代码扫描工具及它们的使用方法。

go vet

vet 是 golang 自带的静态分析工具，可以帮助检查出源代码中一些隐含的错误。

可以使用如下命令查看 vet 的介绍及简单的使用方法

go help vet

可以使用如下命令查看 vet 的详细说明文档

go doc cmd/vet

演示一下 vet 的简单使用方法，比如下面这段程序

packagemainimport "fmt"

funcmain() {
    str := "Hello, world!"
    fmt.Printf("%d World", str)
}

这段代码编译是可以通过的，但是很明显在 %d 的位置是要打印一个字符串，应该用 %s ，如果使用 vet 工具扫描一下就可以发现这个问题

go vet main.go

扫描出的问题如下

./main.go:7:2: fmt.Printf format %d has arg str of wrong typestring

golang 官方有维护一个工具叫 golint，不过已经被废弃了。官方推荐了 Staticcheck 这个工具，工具官网为 https://staticcheck.io/ 。

可以使用 go 直接安装，命令如下：

go install honnef.co/go/tools/cmd/staticcheck@latest

可以使用如下命令查看使用文档

staticcheck --help

使用方法和 vet 很类似。使用这个工具扫描一下上文中的示例代码

staticcheck ./main.go

扫描出的问题如下

main.go:7:13: Printfformat %dhasarg#1ofwrongtypestring (SA5009)

golangci-lint 聚合了很多功能各异的 lint 工具，也包括上文提到的 vet 和 staticcheck，使用起来非常方面。

golangci-lint 有以下特点：

速度非常快：可以并行检查代码，可以复用 go build 缓存、会缓存分析结果。

可配置：支持 YAML 格式的配置文件，可以灵活配置各种规则。

IDE 集成：可以集成进多个主流的 IDE，例如 Goland、Sublime Text、VS Code、GNU Emacs、Vim 等。

linter 聚合器：集成了几乎所有的 linter 并且支持自定义 linter 。

最少的误报数量：调整了所集成的 linter 的默认设置，大幅度减少了误报。

良好的输出：输出的结果带有颜色、代码行号和 linter 标识，易于查看和定位。

更新迭代速度很快，不断有新的 linter 被集成。

macOS中安装方法：

使用 brew 安装

brew install golangci-lint

使用 Docker 安装

docker run --rm -v $(pwd):/app -w /app golangci/golangci-lint:v1.50.1 golangci-lint run -v

Linux 和 Windows 中安装方法

curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.50.1

可以使用如下命令查看使用文档

golangci-lint --help

使用 golangci-lint 扫描一下上文中的示例代码

golangci-lint run  ./main.go

扫描出的问题如下

main.go:7:2: printf: fmt.Printfformat %dhasargstrofwrongtypestring (govet)
        fmt.Printf("%dWorld", str)

关注