Rumah > Artikel > pembangunan bahagian belakang > Pemeriksaan automasi kod yang mesti diketahui oleh Gopher

Pemeriksaan automasi kod yang mesti diketahui oleh Gopher

Go语言进阶学习ke hadapan: 2023-07-25 15:20:291518semak imbas

Artikel ini menerangkan cara menggunakan git hook untuk melaksanakan semakan kod automatik bagi bahasa Go git commit melalui dua rangka kerja utama: golangci-lint dan pra-komit. Pemeriksaan Kod Kod

Static adalah masalah biasa, yang dapat memastikan kualiti kod secara besar -besaran. Suite bahasa Go sendiri memberikan kami alat analisis kod statik, yang boleh digunakan untuk menyemak kod dalam projek go yang boleh disusun tetapi mungkin masih mengandungi ralat Pembaca yang tidak memahaminya boleh menyemak pengenalan dalam sebelumnya artikel

. Kecuali

go vet

, ramai Gophers mungkin juga tahu

goimports

alat untuk memformat kod

gofmt, dan <code style="font-size: inherit;line-height: inherit;overflow-wrap: break-word;padding: 2px 4px;border-radius: 4px;margin-right: 2px;margin-left: 2px;color: rgb(233, 105, 0);background: rgb(248, 248, 248);">go vet，不少 Gopher 也许还知道用于自动导包的 goimports 工具，用于格式化代码的 gofmt，还有已经停止更新的用于检查代码命令错误等的 golint 工具。

以上谈到的工具，我们可以称之为 lintergolint alat.

🎜🎜🎜Alat yang disebutkan di atas boleh dipanggil 🎜🎜linter🎜🎜. Di sini, kita perlu tahu apa itu lint. Dalam Wikipedia, lint ditakrifkan seperti berikut: 🎜🎜

Dalam sains komputer, lint ialah nama program alat yang digunakan untuk menandakan petikan tertentu yang mencurigakan dan tidak berstruktur (mungkin menyebabkan pepijat) dalam kod sumber. Ia adalah alat analisis program statik, mula-mula disesuaikan dengan bahasa C dan dibangunkan pada platform UNIX. Ia kemudiannya menjadi istilah umum yang boleh digunakan untuk menerangkan alat yang digunakan dalam mana-mana bahasa pengaturcaraan komputer untuk menandakan petikan yang boleh dipersoalkan dalam kod sumber.

Dalam bidang bahasa Go, golangci-lint ialah rangka kerja linter yang komprehensif. Ia menyepadukan banyak serpihan, termasuk beberapa yang dinyatakan di atas Penggunaannya yang betul boleh membantu kami menganalisis dan memeriksa kod Go dengan lebih menyeluruh. Item linter yang disokong oleh golangci-lint boleh dilihat di halamanhttps://golangci-lint.run/usage/linters/#golint

.

Lin berkuat kuasa secara lalai ters

Linter tidak berkesan secara lalai

Pemeriksaan automasi kod yang mesti diketahui oleh Gopher

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

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

Git cangkuk ialah mekanisme cangkuk git yang membolehkan pengguna melaksanakan logik tersuai pada pelbagai peringkat operasi git. git hooks <code style="font-size: inherit;line-height: inherit;overflow-wrap: break-word;padding: 2px 4px;border-radius: 4px;margin-right: 2px;margin-left: 2px;color: rgb(233, 105, 0);background: rgb(248, 248, 248);">.git/hooks 下面配置，配置文件的名称是固定的，实质上就是一个个 shell 脚本。根据 git 执行体，钩子被分为客户端钩子和服务端钩子两类。

客户端钩子包括：pre-commit、prepare-commit-msg、commit-msg、post-commit等，主要用于控制客户端git的提交工作流。服务端钩子：pre-receive、post-receive、update.git/hooks Konfigurasi berikut, nama konfigurasi file is fixed , yang pada asasnya adalah skrip shell. Menurut badan pelaksanaan git, cangkuk dibahagikan kepada dua kategori: cangkuk klien dan cangkuk pelayan.

Kait sisi pelanggan termasuk:
pra-komit<img src="https://img.php.cn/upload/article/001/272/559/fd95cd7aca3fab8aa5e73d87f5c52ee0-4.png" alt="Pemeriksaan automasi kod yang mesti diketahui oleh Gopher" >, 🎜🎜prepare-commit-msg🎜🎜, 🎜🎜commit-msg🎜🎜, 🎜🎜pasca-komit🎜🎜, dsb. , digunakan terutamanya Untuk mengawal aliran kerja penyerahan git pelanggan. Cangkuk pelayan: 🎜<code style="font-size: inherit;line-height: inherit;overflow-wrap: break-word;padding: 2px 4px;border-radius: 4px;margin-right: 2px;margin-left : 2px;warna: rgb(233, 105, 0);latar belakang: rgb(248, 248, 248);">🎜pra-terima🎜🎜, 🎜🎜pasca-terima🎜🎜, 🎜🎜kemas kini🎜 kod >🎜, terutamanya dipanggil apabila pelayan menerima objek yang diserahkan dan sebelum menolaknya ke pelayan. . 🎜🎜🎜🎜🎜而 pre-commit 正如其名一样，它在 <code style="font-size: inherit;line-height: inherit;overflow-wrap: break-word;padding: 2px 4px;border-radius: 4px;margin-right: 2px;margin-left: 2px;color: rgb(233, 105, 0);background: rgb(248, 248, 248);">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。

因此，使用 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 检查
首次运行时，由于 pre-commit 没有 golangci-lint 的环境，会初始化下载安装相关依赖。在下一次 git-commit 的时候，就不会有前三行信息了。

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

总结
Kualiti kod adalah isu yang perlu diberi perhatian oleh setiap pembangun Siri pemalam linter yang disediakan oleh golangci-lint boleh membantu Gopher menemui dan menyelesaikan potensi pepijat tepat pada masanya. tahap yang besar. Pada masa yang sama, golangci-lint juga boleh menyeragamkan gaya kod dalam pasukan projek dengan berkesan dan mengurangkan beban mental semakan kod saya harap Gophers dapat menggunakannya dengan berkesan.

Alat git-commit menjana perkara yang diperlukan oleh git hook melalui fail konfigurasipre-commitpra-komit Skrip cangkuk, yang boleh menukar kerja pemeriksaan kod statik melalui golangci-lint daripada tindakan manual kepada proses automatik. Pengenalan git-commit di atas agak mudah Pembaca yang ingin meneroka dengan lebih terperinci boleh pergi terus ke laman web rasmi https://pre-commit.com/index.html untuk belajar. Malah, kita boleh mengembangkan proses automatik ini dengan lebih meluas Sebagai contoh, kita boleh menggunakan peraturan golangci-lint untuk menghalang penarikan kod bukan standard daripada projek ke dalam pangkalan kod tempatan. Ini boleh ditambah kepada proses integrasi berterusan untuk dicapai automasi. Atas sebab ruang, penggunaan bahagian CI diserahkan kepada pembaca untuk meneroka sendiri.

🎜

Atas ialah kandungan terperinci Pemeriksaan automasi kod yang mesti diketahui oleh Gopher. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!

Kenyataan：

Artikel ini dikembalikan pada:Go语言进阶学习. Jika ada pelanggaran, sila hubungi admin@php.cn Padam

Artikel sebelumnya：Pelaksanaan asas penutupan fungsi GoArtikel seterusnya：Pelaksanaan asas penutupan fungsi Go

Artikel berkaitan

Lihat lagi

Pemeriksaan automasi kod yang mesti diketahui oleh Gopher

.

实例

灵活运用命令选项

配置文件

git cangkuk

pre-commit

Artikel berkaitan