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

Go语言进阶学习

发布时间：2023-07-25 15:20:29

1717人浏览过

来源于Go语言进阶学习

转载

本文讲解如何通过 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)

查看帮助文档

1$ golangci-lint help linters

默认生效的 linters

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

默认不生效 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

微购导购版(原天狼星)
功能介绍：1.程序独立使用的MVC模式开发，程序代码与模板分离，会HTML就会做程序模板2.使用sqlite数据库，mysql数据库随便换，让您不再为购买数据库而烦恼3.增加首页数据自定义功能，导航数据自定义，快速打造属于您自己的网站4.seo伪静态设置更智能化，自定义seo规则，让蜘蛛更喜欢您的网站5.屏蔽ip访问功能5.支持一键采集功能，只要轻轻一点，上万淘宝b2c商品轻松入库，解决数据添加的

下载
.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 部分的利用，留待读者自行探究了。

哪些网站是用go语言写的

Gopher 传奇：Go 语言吉祥物的演变

Go 语言之灵：Gopher 吉祥物的起源

Go 语言的吉祥物象征：Gopher 的意义

Gopher 的世界：探索 Go 语言吉祥物

本站声明：本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系admin@php.cn

上一篇：Go函数闭包底层实现下一篇：使用strconv.FormatFloat函数将浮点数转换为字符串，并设置精度和格式

作者最新文章

一篇文章带你了解Go语言基础之map

2023-07-25 17:05

盘点Python编程语言sys库中的7个常用函数

2023-07-25 17:09

盘点Python编程语言sys库中的12个变量

2023-07-25 17:11

手把手教你用Python查询你的物流信息

2023-07-25 17:13

Python中的正则表达式及其常用匹配函数用法简介

2023-07-25 17:17

简述Python、Anaconda、virtualenv和Miniconda之间的区别

2023-07-25 17:19

用Python网络爬虫来看看最近电影院都有哪些上映的电影

2023-07-25 17:21

手把手教你使用Flask搭建ES搜索引擎(实战篇)

2023-07-25 17:24

手把手教你使用Flask搭建ES搜索引擎(预备篇)

2023-07-25 17:27

手把手教你进行Anaconda的安装

2023-07-25 17:29

热门AI工具

DeepSeek

幻方量化公司旗下的开源大模型平台

AI编程开发 AI聊天问答

豆包大模型

字节跳动自主研发的一系列大型语言模型

AI编程开发 AI大模型

通义千问

阿里巴巴推出的全能AI助手

AI编程开发 Agent智能体

腾讯元宝

腾讯混元平台推出的AI助手

文档处理 Excel 表格

文心一言

文心一言是百度开发的AI聊天机器人，通过对话可以生成各种形式的内容。

AI编程开发 AI文本写作

讯飞写作

基于讯飞星火大模型的AI写作工具，可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

AI文本写作中文写作

即梦AI

一站式AI创作平台，免费AI图片和视频生成。

图片拼接图画生成

ChatGPT

最最强大的AI聊天机器人程序，ChatGPT不单是聊天机器人，还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

AI编程开发 AI文本写作

智谱清言 - 免费全能的AI助手

AI编程开发 Agent智能体

相关专题

C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开，系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例，帮助开发者掌握构建高可用微服务系统的关键技术，提高系统的可扩展性与维护效率。

2026.03.11

Go高并发任务调度与Goroutine池化实践

本专题围绕 Go 语言在高并发任务处理场景中的实践展开，系统讲解 Goroutine 调度模型、Channel 通信机制以及并发控制策略。内容包括任务队列设计、Goroutine 池化管理、资源限制控制以及并发任务的性能优化方法。通过实际案例演示，帮助开发者构建稳定高效的 Go 并发任务处理系统，提高系统在高负载环境下的处理能力与稳定性。

2026.03.10

Kotlin Android模块化架构与组件化开发实践

本专题围绕 Kotlin 在 Android 应用开发中的架构实践展开，重点讲解模块化设计与组件化开发的实现思路。内容包括项目模块拆分策略、公共组件封装、依赖管理优化、路由通信机制以及大型项目的工程化管理方法。通过真实项目案例分析，帮助开发者构建结构清晰、易扩展且维护成本低的 Android 应用架构体系，提升团队协作效率与项目迭代速度。

2026.03.09

JavaScript浏览器渲染机制与前端性能优化实践

本专题围绕 JavaScript 在浏览器中的执行与渲染机制展开，系统讲解 DOM 构建、CSSOM 解析、重排与重绘原理，以及关键渲染路径优化方法。内容涵盖事件循环机制、异步任务调度、资源加载优化、代码拆分与懒加载等性能优化策略。通过真实前端项目案例，帮助开发者理解浏览器底层工作原理，并掌握提升网页加载速度与交互体验的实用技巧。

2026.03.06

Rust内存安全机制与所有权模型深度实践

本专题围绕 Rust 语言核心特性展开，深入讲解所有权机制、借用规则、生命周期管理以及智能指针等关键概念。通过系统级开发案例，分析内存安全保障原理与零成本抽象优势，并结合并发场景讲解 Send 与 Sync 特性实现机制。帮助开发者真正理解 Rust 的设计哲学，掌握在高性能与安全性并重场景中的工程实践能力。

218

2026.03.05

PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开，重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景，深入分析性能瓶颈定位与优化思路，帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

420

2026.03.04

AI安装教程大全

2026最全AI工具安装教程专题：包含各版本AI绘图、AI视频、智能办公软件的本地化部署手册。全篇零基础友好，附带最新模型下载地址、一键安装脚本及常见报错修复方案。每日更新，收藏这一篇就够了，让AI安装不再报错！

168

2026.03.04

Swift iOS架构设计与MVVM模式实战

本专题聚焦 Swift 在 iOS 应用架构设计中的实践，系统讲解 MVVM 模式的核心思想、数据绑定机制、模块拆分策略以及组件化开发方法。内容涵盖网络层封装、状态管理、依赖注入与性能优化技巧。通过完整项目案例，帮助开发者构建结构清晰、可维护性强的 iOS 应用架构体系。

222

2026.03.03

C++高性能网络编程与Reactor模型实践

本专题围绕 C++ 在高性能网络服务开发中的应用展开，深入讲解 Socket 编程、多路复用机制、Reactor 模型设计原理以及线程池协作策略。内容涵盖 epoll 实现机制、内存管理优化、连接管理策略与高并发场景下的性能调优方法。通过构建高并发网络服务器实战案例，帮助开发者掌握 C++ 在底层系统与网络通信领域的核心技术。

2026.03.03

热门下载

网站特效

网站源码

网站素材

前端模板