Gopher一定要会的代码自动化检查

╰+攻爆jí腚メ 2022-09-03 06:15 297阅读 0赞

本文讲解如何通过 **golangci-lint** 和 **pre-commit** 两大框架，利用 **git hooks** 实现 Go 语言 git commit 的代码自动化审查。

**静态代码检查**

静态代码检查是一个老生常态的问题，它能很大程度上保证代码质量。Go 语言自带套件为我们提供了静态代码分析工具 vet，它能用于检查 go 项目中可以通过编译但仍可能存在错误的代码，不了解的读者可以查看之前 **[文章][Link 1]** 的介绍。除了 `go vet`，不少 Gopher 也许还知道用于自动导包的 `goimports` 工具，用于格式化代码的 `gofmt`，还有已经停止更新的用于检查代码命令错误等的 `golint` 工具。

以上谈到的工具，我们可以称之为 `linter`。在这里，我们首先需要知道什么是 lint。在维基百科是如下定义 lint 的：

*在计算机科学中，**lint** 是一种工具程序的名称，它用来标记源代码中，某些可疑的、不具结构性（可能造成bug）的段落。它是一种静态程序分析工具，最早适用于C语言，在UNIX平台上开发出来。后来它成为通用术语，可用于描述在任何一种计算机程序语言中，用来标记源代码中有疑义段落的工具。*

而在 Go 语言领域， golangci-lint 是一个集大成者的 linter 框架。它集成了非常多的 linter，包括了上文提到的几个，合理使用它可以帮助我们更全面地分析与检查 Go 代码。golangci-lint 所支持的 linter 项可以查看页面 https://golangci-lint.run/usage/linters/\#golint

**使用 golangci-lint**

##  ##

##### 下载 #####

1go get github.com/golangci/golangci-lint/cmd/golangci-lint@latest

##### 检查安装成功 #####

1$ golangci-lint version
    2golangci-lint has version v1.41.1 built from (unknown, mod sum: "h1:KH28pTSqRu6DTXIAANl1sPXNCmqg4VEH21z6G9Wj4SM=") on (unknown)

##### 查看帮助文档 #####

1$ golangci-lint help linters

*  **默认生效的 linters**

![495496bedf3de8dd641d4ba2dc89c59d.png][]

*  **默认不生效 linters**

![2aa678a8e955f1252684ef9f08f54f9f.png][]

*  **linters 的分类**

![eebf778d60b5370baa989e5f4233ff65.png][]

可以看出，golangci-lint 框架支持的 linter 非常全面，它包括了 bugs、error、format、unused、module 等常见类别的分析 linter。

##### 实例 #####

下面来展示使用示例，现有以下项目结构代码

1.
    2├── go.mod
    3├── main.go
    4└── typecheck
    5    └── typecheckDemo.go

其中 `main.go` 中的代码如下

1package main
     2
     3import (
     4    "fmt"
     5)
     6
     7func main() {
     8    s1 := "this is a string"
     9    fmt.Printf("inappropriate formate %s\n", &s1)
    10
    11    i := 1
    12    fmt.Println(i != 0 || i != 1)
    13
    14    arr := []int{1, 2, 3}
    15    for _, i := range arr {
    16        go func() {
    17            fmt.Println(i)
    18        }()
    19    }
    20}

`typecheckDemo.go` 中的代码

1package typecheck
     2
     3import "fmt"
     4
     5func check() {
     6    t := unexistType{}
     7    fmt.Println(t)
     8}
     9
    10func unused() {
    11    i := 1
    12}

这两个源码文件中的代码都是存在一些问题的。此时，我们通过 golangci-lint 工具来对源码文件进行检查

![e7780cb9879ad1366eefe19a192fc7b8.png][]

可以看到，我们在程序根目录中执行 `golangci-lint run` 命令，它等效于 `golangci-lint run ./...` 。此时，它将 `main.go` 和 `typecheckDemo.go` 中存在的潜在问题都检测到了，并标记了是何种 linter 检测（这里是 typecheck 和 govet 两种）到的。

当然，也可以通过命令 `golangci-lint run dir1 dir2/... dir3/file1.go` 对某特定的文件或文件夹进行分析。

##### 灵活运用命令选项 #####

*  **golangci-lint 可以通过 `-E/--enable` 去开启指定 linter，或者 `-D/--disable` 禁止指定 linter。**

1golangci-lint run --disable-all -E errcheck

如上命令代表的就是除了 `errcheck` 的 linter，禁止其他所有的 linter 生效。

*  **golangci-lint 还可以通过 `-p/--preset` 指定一系列 linter 开启。**

1golangci-lint run -p bugs -p error

如上命令代表的就是所有属于 `bugs` 和 `error` 分类的 linter 生效。

*  **更多命令选项，可以通过 `golangci-lint run -h` 查看**

##### 配置文件 #####

当然，如果我们要为项目配置 golangci-lint，最好的方式还是配置文件。golangci-lint 在当前工作目录按如下顺序搜索配置文件。

*  `.golangci.yml`
 *  `.golangci.yaml`
 *  `.golangci.toml`
 *  `.golangci.json`

在 golangci-lint 官方文档 https://golangci-lint.run/usage/configuration/\#config-file 中，提供了一个示例配置文件，非常地详细，在这其中包含了所有支持的选项、描述和默认值。

在这里给出一个比较不错的配置示例文档

1linters-settings:
     2  errcheck:
     3    check-type-assertions: true
     4  goconst:
     5    min-len: 2
     6    min-occurrences: 3
     7  gocritic:
     8    enabled-tags:
     9      - diagnostic
    10      - experimental
    11      - opinionated
    12      - performance
    13      - style
    14  govet:
    15    check-shadowing: true
    16  nolintlint:
    17    require-explanation: true
    18    require-specific: true
    19
    20linters:
    21  disable-all: true
    22  enable:
    23    - bodyclose
    24    - deadcode
    25    - depguard
    26    - dogsled
    27    - dupl
    28    - errcheck
    29    - exportloopref
    30    - exhaustive
    31    - goconst
    32    - gocritic
    33    - gofmt
    34    - goimports
    35    - gomnd
    36    - gocyclo
    37    - gosec
    38    - gosimple
    39    - govet
    40    - ineffassign
    41    - misspell
    42    - nolintlint
    43    - nakedret
    44    - prealloc
    45    - predeclared
    46    - revive
    47    - staticcheck
    48    - structcheck
    49    - stylecheck
    50    - thelper
    51    - tparallel
    52    - typecheck
    53    - unconvert
    54    - unparam
    55    - varcheck
    56    - whitespace
    57    - wsl
    58
    59run:
    60  issues-exit-code: 1

**使用 pre-commit hook**

在项目开发中，我们都会使用到 git，因此我们可以将代码静态检查放在一个 git 触发点上，而不用每次写完代码手动去执行 `golangci-lint run` 命令。这里，我们就需要用到 git hooks。

##### git hooks #####

git hooks 是 git 的一种钩子机制，可以让用户在 git 操作的各个阶段执行自定义的逻辑。git hooks  在项目根目录的 `.git/hooks` 下面配置，配置文件的名称是固定的，实质上就是一个个 shell 脚本。根据 git 执行体，钩子被分为客户端钩子和服务端钩子两类。

客户端钩子包括：`pre-commit`、`prepare-commit-msg`、`commit-msg`、`post-commit`等，主要用于控制客户端git的提交工作流。服务端钩子：`pre-receive`、`post-receive`、`update`，主要在服务端接收提交对象时、推送到服务器之前调用。

注意，以 .sample 结尾的文件名是官方示例，这些示例脚本是不会执行的，只有重命名后才会生效（去除 .sample 后缀）。

![f5f11d8bfcf5e5981c6882c6e46ae63d.png][]

而 pre-commit 正如其名一样，它在 `git add` 提交之后，运行 `git commit` 时执行，脚本执行没报错就继续提交，反之就驳回提交的操作。

##### pre-commit #####

试想，如果我们同时开发多个项目，也许项目的所采用的的编程语言并不一样，那么它们所需要的 git hooks 将不一致，此时我们是否要手动给每个项目都配置一个单独的 pre-commit 脚本呢，或者我们是否要去手动下载每一个钩子脚本呢。

实际上，并不需要这么麻烦。这里就引出了 pre-commit 框架，它是一个与语言无关的用于管理 git hooks 钩子脚本的工具（虽然采用 Python 开发，但不止于 Python ）。

*  **安装**

1$ pip install pre-commit
    2或者
    3$ curl https://pre-commit.com/install-local.py | python -
    4或者
    5$ brew install pre-commit

*  **安装成功**

1$ pre-commit --version
    2pre-commit 1.20.0

*  **编写配置文件**

首先我们在项目根目录下新建一个 `.pre-commit-config.yaml` 文件，这个文件我们可以通过 `pre-commit sample-config` 得到最基本的配置模板，通过 pre-commit 支持的 hooks 列表 https://pre-commit.com/hooks.html 中，我们找到了 golangci-lint。

![6210767c4dc32660dac1fed4baa8bda1.png][]

因此，使用 golangci-lint 的 `.pre-commit-config.yaml` 配置内容如下

1repos:
    2-   repo: https://github.com/golangci/golangci-lint
    3    rev: v1.41.1 # the current latest version
    4    hooks:
    5    -   id: golangci-lint

*  **安装 git hook 脚本**

运行 `pre-commit install` 命令根据配置文件安装

1$ pre-commit install
    2pre-commit installed at .git/hooks/pre-commit

此时，生成了新的 Python 语言编写的 `.git/hooks/pre-commit` 钩子文件。

*  **git commit 触发 golangci-lint 检查**

![b8b6f8d332889702ce6446eae7bb2359.png][]

首次运行时，由于 pre-commit 没有 golangci-lint 的环境，会初始化下载安装相关依赖。在下一次 git-commit 的时候，就不会有前三行信息了。

如上图所示，报错内容和我们手动执行 `golangci-lint run` 命令输出的一样，只有当我们将代码更改正确，才能顺利通过检查，从而 commit 成功。

**总结**

代码质量是每位开发者都必须重视的问题，golangci-lint 提供的一系列 linter 插件能够在很大程度上帮助 Gopher 及时发现与解决潜在 bug。同时，借助 golangci-lint 还可以有效规范项目组内的代码风格，减轻 code review 的心智负担，希望 Gopher 们能有效利用它。

git-commit 工具通过配置文件生成 git hooks 所需要的 `pre-commit` 钩子脚本，这可以将通过 golangci-lint 的静态代码检查工作，由手工动作转化为自动化流程。上文关于 git-commit 的介绍比较简单，想更详细探究的读者可以直接去官网 https://pre-commit.com/index.html 学习。其实，这种自动化流程我们可以扩展得更广，例如我们可以利用 golangci-lint 规则防止从项目中拉取不符合标准的代码进入本地代码库，这可以在持续集成 CI 过程中添加它来实现自动化。鉴于篇幅原因，CI 部分的利用，留待读者自行探究了。

**往期推荐**

*  [同步原语的基石][Link 2]  
    
 *  [被遗弃在角落里的 sync.Cond][sync.Cond]  
    
 *  [详解逃逸分析][Link 3]  
    
 *  [CPU缓存体系对Go程序的影响][CPU_Go]  
    
 *  [如何有效地测试Go代码][Go]  
    
 *  [Go精妙的互斥锁设计][Go 1]

![184ae9557339305bd9b929c90a176f64.png][]

**机器铃砍菜刀**

欢迎添加小菜刀微信

加入Golang分享群学习交流！

感谢你的**点赞**和**在看**哦~

![d3003e10b8fc7c5a97a9251da66f33b6.gif][]

[Link 1]: https://mp.weixin.qq.com/s?__biz=MzkyMzIyNjIxMQ%3D%3D&idx=1&mid=2247484570&scene=21&sn=aefccd60383424e2b9b3b6cdba927a2f#wechat_redirect
[495496bedf3de8dd641d4ba2dc89c59d.png]: /images/20220829/e351c2b15314421cbf260dbcad76625b.png
[2aa678a8e955f1252684ef9f08f54f9f.png]: /images/20220829/42284c48dd924369a8bfe26069fc7d6b.png
[eebf778d60b5370baa989e5f4233ff65.png]: /images/20220829/cd34b888015044a796e3492a6bba7142.png
[e7780cb9879ad1366eefe19a192fc7b8.png]: /images/20220829/31bedcbbd570491b9372205118b8d64d.png
[f5f11d8bfcf5e5981c6882c6e46ae63d.png]: /images/20220829/85790b8e71b44548b43abfba5d40bde8.png
[6210767c4dc32660dac1fed4baa8bda1.png]: /images/20220829/ba8c087a32544bbb9856b5c2dc44b806.png
[b8b6f8d332889702ce6446eae7bb2359.png]: /images/20220829/c46d3ef7364d4a4c9f736bbe84e633a1.png
[Link 2]: http://mp.weixin.qq.com/s?__biz=MzIwNTA4MDAwMQ%3D%3D&chksm=97371030a04099263dfbf16dc24438f409166a053fd9fef802f9f9e4f8fd3c4aba9dd97df8f8&idx=1&mid=2247484574&scene=21&sn=5bbe2668e64455f428c70f00c09f28a2#wechat_redirect
[sync.Cond]: http://mp.weixin.qq.com/s?__biz=MzkyMzIyNjIxMQ%3D%3D&chksm=c1e91df3f69e94e5adf0ab5af7e2e07a106e29448f1583b8aefb003a5c15cac143a1840f5b3e&idx=1&mid=2247484671&scene=21&sn=0d197ec27200945accba5a21605a0d26#wechat_redirect
[Link 3]: http://mp.weixin.qq.com/s?__biz=MzIwNTA4MDAwMQ%3D%3D&chksm=973710d5a04099c3c2dde737eb9de31eddb9d3707ea5885abed6a06fa7fc9855fad7de8561f7&idx=1&mid=2247484539&scene=21&sn=be23b39e21067e3017f15afb36271570#wechat_redirect
[CPU_Go]: http://mp.weixin.qq.com/s?__biz=MzIwNTA4MDAwMQ%3D%3D&chksm=973710e8a04099fe6f113c38a9e9940c0ff590877ad7ba0a0f4c383356e91619574f052a6064&idx=1&mid=2247484486&scene=21&sn=83ebd97be71caad3537502e459182f88#wechat_redirect
[Go]: http://mp.weixin.qq.com/s?__biz=MzkyMzIyNjIxMQ%3D%3D&chksm=c1e91da7f69e94b1e3177a25a9825ce255e46701810193eb7bcaa5a47af5ba6e00792e60dfd0&idx=1&mid=2247484587&scene=21&sn=53a349d3e2c873889a9e8d4676d4ba22#wechat_redirect
[Go 1]: http://mp.weixin.qq.com/s?__biz=MzkyMzIyNjIxMQ%3D%3D&chksm=c1e91da9f69e94bfb46c76d9d8b587a837425fd7fcae3773ed5b573d5e856373210ac9011e45&idx=1&mid=2247484581&scene=21&sn=90aa7d00490fa9e3dd3f8d061e927bba#wechat_redirect
[184ae9557339305bd9b929c90a176f64.png]: /images/20220829/b6df393e120f4c2ab17746c699532e86.png
[d3003e10b8fc7c5a97a9251da66f33b6.gif]: /images/20220829/2d084890d3b14d4894b9fbac3190d05c.png