Golang使用gofumpt进行代码格式化
我们从一开始写 Go 代码和应用，就会被各种官方和民间教程，甚至 IDE 教导我们必须配一个 gofmt 工具。他能够格式化 Go 程序的代码。会使用制表符表示缩进，空白表示对齐。
这解决了程序员届的老大难问题之一，代码格式上的规范问题。有效的提高了 Go 代码的阅读的友好度和减少了同事间的 ****。非常值得认可。
但有时候，还是会看到一些糟心的代码，总会觉得 gofmt，还是格式化的不够。
今天给大家分享我发现的一个更狠的工具：gofumpt，例子主要基于官方文档。
更强的格式化：gofumpt
Gofumpt 会执行比 gofmt 更严格的 Go 格式规范。同时确保向后兼容。
该工具是 Go 1.21 的 gofmt 分支，需要 Go 1.20 或更高版本。它可以直接替代现有的 Go 代码格式化，也就是在 gofumpt 之后运行 gofmt 不会产生任何新的变化。
安装命令：
$ go install mvdan.cc/gofumpt@latest
执行命令：
$ gofumpt -l -w . main.go
再查看对应被格式化的文件就已经生效了。
以下是一些更具体的 gofmt 和 gofumpt 的区别例子。能够很好的帮助大家识别其中的差异。
赋值运算符后无空行
原本由 gofmt 格式化后：
func foo() string {
foo :=
"脑子进煎鱼了！"
return foo
}
改为 gofumpt 格式化后：
func foo() string {
foo := "脑子进煎鱼了！"
return foo
}
函数体周围无空行
原本由 gofmt 格式化后：
func foo() {
println("煎鱼进脑子了！")
}
改为 gofumpt 格式化后：
func foo() {
println("煎鱼进脑子了！")
}
函数应分隔 ) { ，缩进有助于提高可读性
原本由 gofmt 格式化后：
func foo(s string,
i int) {
println("煎鱼！！！")
}
// 使用空行会稍微好一些，但仍然不够好
func bar(s string,
i int) {
println("煎鱼！！！")
}
改为 gofumpt 格式化后：
func foo(s string,
i int,
) {
println("煎鱼！！！")
}
func bar(s string,
i int,
) {
println("煎鱼！！！")
}
代码块中的单独语句（或注释）周围没有空行
原本由 gofmt 格式化后：
if err != nil {
return err
}
改为 gofumpt 格式化后：
if err != nil {
return err
}
简单错误检查前无空行
原本由 gofmt 格式化后：
foo, err := processFoo()
if err != nil {
return err
}
改为 gofumpt 格式化后：
foo, err := processFoo()
if err != nil {
return err
}
复合字面量应统一使用换行符
原本由 gofmt 格式化后：
var ints = []int{1, 2,
3, 4}
var matrix = [][]int{
{1},
{2}, {
3,
},
}
改为 gofumpt 格式化后：
var ints = []int{
1, 2,
3, 4,
}
var matrix = [][]int{
{1},
{2},
{
3,
},
}
空字段列表应使用单行
原本由 gofmt 格式化后：
var V interface {
} = 3
type T struct {
}
func F(
)
改为 gofumpt 格式化后：
var V interface{} = 3
type T struct{}
func F()
标准库导入必须在顶部单独分组
原本由 gofmt 格式化后：
import ( "foo.com/bar" "io" "io/ioutil" )
改为 gofumpt 格式化后：
import ( "io" "io/ioutil" "foo.com/bar" )
短 case 子句应占一行
原本由 gofmt 格式化后：
switch c {
case 'a', 'b',
'c', 'd':
}
改为 gofumpt 格式化后：
switch c {
case 'a', 'b', 'c', 'd':
}
多行顶层声明必须用空行隔开
原本由 gofmt 格式化后：
func foo() {
println("煎鱼！")
}
func bar() {
println("煎鱼！")
}
改为 gofumpt 格式化后：
func foo() {
println("煎鱼！")
}
func bar() {
println("煎鱼！")
}
单个 var 声明不应使用括号分组
原本由 gofmt 格式化后：
var ( foo = "煎鱼！" )
改为 gofumpt 格式化后：
var foo = "煎鱼！"
连续的顶层声明应归为一组
原本由 gofmt 格式化后：
var nicer = "x" var with = "y" var alignment = "z"
改为 gofumpt 格式化后：
var ( nicer = "x" with = "y" alignment = "z" )
简单的 var 声明语句应使用短赋值
原本由 gofmt 格式化后：
var s = "煎鱼进脑子了"
改为 gofumpt 格式化后：
s := "煎鱼进脑子了"
默认启用 -s 代码简化标记。
非 Go 指令的注释应以空格开头
原本由 gofmt 格式化后：
//go:noinline
//Foo is awesome.
func Foo() {}
改为 gofumpt 格式化后：
//go:noinline
// Foo is awesome.
func Foo() {}
VSCode 配置
可以直接在 IDE 中进行配置。例如 VSCode，可以配置对应的 settings.json 为如下：
{
"go.useLanguageServer": true,
"gopls": {
"formatting.gofumpt": true,
},
}
就可以直接在 Go 应用中用起来了。
总结
之前我有一个朋友，接手了一个老项目。那位同学，几乎没有什么代码规范的风格。全靠 gofmt 来帮他格式化。
但你们也看到，gofmt 只做了最基本的。这种时候如果有更严格的 Go 代码格式化工具 gofumpt 是非常不错的。（也需要引导这位同学，但容易撕逼）
像是前面提到的 “多行顶层声明必须用空行隔开” 是非常有价值的。我是真的见过一大坨不加空行都挤一起的。看起来非常难受。
到此这篇关于Golang使用gofumpt进行代码格式化的文章就介绍到这了,更多相关Go gofumpt格式化代码内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
这篇文章主要介绍了Go语言实现RSA加密解密的操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2021-05-05
前面的两篇文章对 Go 语言的基础语法和基本数据类型以及几个复合数据类型进行介绍，本文将对 Go 里面的指针和结构体进行介绍，也为后续文章做铺垫，感兴趣的可以了解一下2022-11-11
超时在一些业务场景里非常普遍,下面这篇文章主要给大家介绍了关于Go语言实现超时的三种方法,文中通过实例代码介绍的非常详细,对大家学习或者使用Go语言具有一定的参考学习价值,需要的朋友可以参考下2022-07-07
这篇文章主要介绍了Golang通脉之数据类型，在编程语言中标识符就是定义的具有某种意义的词，比如变量名、常量名、函数名等等，Go语言中标识符允许由字母数字和_(下划线）组成，并且只能以字母和_开头，更详细内容请看下面文章吧2021-10-10
内存泄漏是我们在生产环境中必须面临的问题,下面这篇文章主要给大家介绍了关于golang容易导致内存泄漏的6种情况,文中通过实例代码介绍的非常详细,需要的朋友可以参考下2023-01-01
本文主要介绍了golang中结构体嵌套接口的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2023-04-04
本文主要介绍了Go语言context上下文管理的使用，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2022-03-03
本文主要介绍了go chan基本使用详解，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2023-04-04
当我们在终端上（比如Goland）运行gin框架搭建的服务时，会发现输出的日志是可以带颜色的，那这是如何实现的呢？本文就来和大家简单讲讲2023-04-04
这篇文章主要为大家介绍了Go语言LeetCode500键盘行题解示例详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪2022-12-12
最新评论