집 > 기사 > 백엔드 개발 > 고퍼가 꼭 알아야 할 코드 자동화 검사

고퍼가 꼭 알아야 할 코드 자동화 검사

Go语言进阶学习앞으로: 2023-07-25 15:20:291506검색

이 기사에서는 golangci-lint 및 pre-commit이라는 두 가지 주요 프레임워크를 통해 git 후크를 사용하여 Go 언어 git 커밋의 자동화된 코드 검토를 구현하는 방법을 설명합니다.

정적 코드 검사

정적 코드 검사는 일반적인 문제로, 코드 품질을 크게 보장할 수 있습니다. Go 언어 자체 제품군은 컴파일할 수 있지만 여전히 오류가 있을 수 있는 Go 프로젝트의 코드를 확인하는 데 사용할 수 있는 정적 코드 분석 도구 vet를 제공합니다. 이를 모르는 독자는 이전 의 소개를 확인할 수 있습니다. 기사. <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 工具。

以上谈到的工具，我们可以称之为 lintergo vet, 많은 Gophers는

🎜goimports🎜🎜 코드 서식 지정 도구 🎜

> 패딩: 2px 4px;테두리 반경: 4px;마진-오른쪽: 2px;마진-왼쪽: 2px;색상: rgb(233, 105, 0);배경: rgb(248, 248, 248);">🎜golint🎜

🎜 도구. 🎜🎜🎜🎜위에 언급된 도구는 🎜🎜linter🎜🎜. 여기서 먼저 린트(lint)가 무엇인지 알아야 합니다. Wikipedia에서 린트는 다음과 같이 정의됩니다. 🎜🎜

컴퓨터 과학에서 lint는 소스 코드에서 의심스럽고 구조화되지 않은(버그를 유발할 수 있는) 특정 구절을 표시하는 데 사용되는 도구 프로그램의 이름입니다. C 언어에 처음 적용되어 UNIX 플랫폼에서 개발된 정적 프로그램 분석 도구입니다. 나중에 이는 소스 코드에서 의심스러운 부분을 표시하기 위해 모든 컴퓨터 프로그래밍 언어에서 사용되는 도구를 설명하는 데 사용할 수 있는 일반적인 용어가 되었습니다.

Go 언어 분야에서 golangci-lint는 포괄적인 린터 프레임워크입니다. 위에서 언급한 여러 린터를 포함하여 많은 린터를 통합하면 Go 코드를 보다 포괄적으로 분석하고 검사하는 데 도움이 될 수 있습니다. golangci-lint에서 지원하는 Linter 항목은 페이지에서 확인할 수 있습니다https://golangci-lint.run/usage/linters/#golint

golangci-lint 사용하기

ㅋㅋㅋ

기본적으로 Lin이 적용됩니다. ters

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

<br/>

使用 pre-commit hook

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

git Hooks

Git 후크는 사용자가 Git 작업의 다양한 단계에서 사용자 정의 논리를 실행할 수 있게 해주는 Git의 후크 메커니즘입니다. git 후크 <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 다음 구성, 구성 이름 파일은 고정되어 있으며 이는 기본적으로 쉘 스크립트입니다. Git 실행 본문에 따르면 후크는 클라이언트 후크와 서버 후크라는 두 가지 범주로 나뉩니다.

클라이언트 측 후크에는 다음이 포함됩니다.

<p style="font-size: 16px;text-align: center;">pre-commit<img  src="https://img.php.cn/upload/article/001/272/559/fd95cd7aca3fab8aa5e73d87f5c52ee0-4.png" alt="고퍼가 꼭 알아야 할 코드 자동화 검사" ></p>

🎜prepare-commit-msg🎜

🎜commit-msg🎜

🎜post-commit🎜

🎜사전 수신🎜

🎜post-receive🎜

🎜update🎜 코드 >🎜 주로 서버가 제출된 객체를 수신할 때와 서버에 푸시하기 전에 호출됩니다. 🎜🎜🎜🎜 .sample로 끝나는 파일 이름은 공식 샘플입니다. 이러한 샘플 스크립트는 실행되지 않으며 이름을 바꾼 후에만 적용됩니다(.sample 접미사 제거). 🎜🎜🎜🎜🎜<p style="font-size: inherit;color: inherit;line-height: inherit;margin-top: 1.5em;margin-bottom: 1.5em;"><span style="font-size: 15px;letter-spacing: 1px;">而 pre-commit 正如其名一样，它在 </span><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);"><span style="font-size: 15px;letter-spacing: 1px;">git add</span>

提交之后，运行

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 成功。

总结

코드 품질은 모든 개발자가 주의해야 할 문제입니다. golangci-lint에서 제공하는 일련의 린터 플러그인은 Gopher가 적시에 잠재적인 버그를 발견하고 해결하는 데 도움이 될 수 있습니다. 대단한 정도. 동시에 golangci-lint는 프로젝트 팀 내에서 코드 스타일을 효과적으로 표준화하고 코드 검토에 대한 정신적 부담을 줄여줄 수도 있습니다.

git-commit 도구는 구성 파일을 통해 git 후크에 필요한 것을 생성합니다pre-commitpre-commit golangci-lint를 통한 정적 코드 검사 작업을 수동 작업에서 자동화된 프로세스로 변환할 수 있는 후크 스크립트입니다. 위의 git-commit 소개는 비교적 간단합니다. 더 자세히 살펴보고 싶은 독자는 공식 웹사이트 https://pre-commit.com/index.html로 직접 이동하여 알아볼 수 있습니다. 실제로 이 자동화된 프로세스를 더 광범위하게 확장할 수 있습니다. 예를 들어 golangci-lint 규칙을 사용하면 비표준 코드를 프로젝트에서 로컬 코드 베이스로 가져오는 것을 방지할 수 있습니다. 이를 달성하기 위해 지속적인 통합 CI 프로세스에 추가할 수 있습니다. 자동화. 지면상의 이유로 CI 부분의 활용은 독자들이 스스로 탐구하도록 남겨둔다.

🎜

위 내용은 고퍼가 꼭 알아야 할 코드 자동화 검사의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!

성명：

이 기사는 Go语言进阶学习에서 복제됩니다. 침해가 있는 경우 admin@php.cn으로 문의하시기 바랍니다. 삭제

이전 기사：Go 함수 클로저의 기본 구현다음 기사：Go 함수 클로저의 기본 구현