首頁 > 文章 > 後端開發 > Gopher一定要會的程式碼自動化檢查

Gopher一定要會的程式碼自動化檢查

Go语言进阶学习轉載: 2023-07-25 15:20:291476瀏覽

本文說明如何透過golangci-lint 和pre-commit 兩大框架，利用git hooks 實作Go語言git commit 的程式碼自動化審查。

#靜態程式碼檢查

靜態程式碼檢查是一個老生常態的問題，它能很大程度保證程式碼品質。 Go 語言自帶套件為我們提供了靜態程式碼分析工具vet，它能用於檢查go 專案中可以透過編譯但仍可能存在錯誤的程式碼，不了解的讀者可以查看先前文章的介紹。除了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)

查看說明文件 Gopher一定要會的程式碼自動化檢查

1$ golangci-lint help linters

linters 的分类

Gopher一定要會的程式碼自動化檢查

可以看出，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 工具来对源码文件进行检查

Gopher一定要會的程式碼自動化檢查

可以看到，我们在程序根目录中执行 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

<br/>

使用 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 後綴）。

Gopher一定要會的程式碼自動化檢查 #

而 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。

Gopher一定要會的程式碼自動化檢查

因此，使用 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 检查

Gopher一定要會的程式碼自動化檢查

首次运行时，由于 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 部分的利用，留待讀者自行探究了。

以上是Gopher一定要會的程式碼自動化檢查的詳細內容。更多資訊請關注PHP中文網其他相關文章！

陳述：

本文轉載於：Go语言进阶学习。如有侵權，請聯絡admin@php.cn刪除

上一篇：Go函數閉包底層實現下一篇：Go函數閉包底層實現

看更多