怎样使用gofmt格式化代码

本文涉及的产品
RDS MySQL DuckDB 分析主实例,集群系列 4核8GB
RDS AI 助手,专业版
简介: **gofmt**是Go语言官方的代码格式化工具,确保代码遵循统一风格。它能读取标准输入或格式化指定文件及目录中的.go文件。使用`-s`参数可以简化代码,例如移除不必要的类型声明、索引指定和变量赋值。`-w`参数将格式化结果写回源文件。`go fmt`是`gofmt`的简单封装,通常带有`-l -w`参数。在Goland中,可通过设置File Watcher自动调用gofmt进行格式化。

gofmt介绍

Golang的开发团队制定了统一的官方代码风格,并且推出了gofmt工具(gofmt或go fmt)来帮助开发者格式化他们的代码到统一的风格。gofmt是一个cli程序,会优先读取标准输入,如果传入了文件路径的话,会格式化这个文件,如果传入一个目录,会格式化目录中所有.go文件,如果不传参数,会格式化当前目录下的所有.go文件。

gofmt默认不对代码进行简化,使用-s参数可以开启简化代码功能,具体来说会进行如下的转换:

  • 去除数组、切片、Map初始化时不必要的类型声明:

复制代码

如下形式的切片表达式:
    []T{T{}, T{}}
将被简化为:
    []T{{}, {}}
  • 去除数组切片操作时不必要的索引指定

复制代码

如下形式的切片表达式:
    s[a:len(s)]
将被简化为:
    s[a:]
  • 去除迭代时非必要的变量赋值

复制代码

如下形式的迭代:
    for x, _ = range v {...}
将被简化为:
    for x = range v {...}
如下形式的迭代:
    for _ = range v {...}
将被简化为:
    for range v {...}

gofmt命令参数列表如下:

复制代码

usage: gofmt [flags] [path ...]
  -cpuprofile string
        write cpu profile to this file
  -d    display diffs instead of rewriting files
  -e    report all errors (not just the first 10 on different lines)
  -l    list files whose formatting differs from gofmt's
  -r string
        rewrite rule (e.g., 'a[b:len(a)] -> a[b:]')
  -s    simplify code
  -w    write result to (source) file instead of stdout

可以看到,gofmt命令还支持自定义的重写规则,使用-r参数,按照pattern -> replacement的格式传入规则。

有如下内容的Golang程序,存储在main.go文件中。

复制代码

package main

import "fmt"

func main() {
   a := 1
   b := 2
   c := a + b
   fmt.Println(c)
}

用以下规则来格式化上面的代码。

复制代码

gofmt -r "a + b -> b + a"

格式化的结果如下。

复制代码

package main

import "fmt"

func main() {
   a := 1
   b := 2
   c := b + a
   fmt.Println(c)
}

*注意:Gofmt使用tab来表示缩进,并且对行宽度无限制,如果手动对代码进行了换行,gofmt也不会强制把代码格式化回一行。

go fmt和gofmt

gofmt是一个独立的cli程序,而go中还有一个go fmt命令,go fmt命令是gofmt的简单封装。

复制代码

usage: go fmt [-n] [-x] [packages]

Fmt runs the command 'gofmt -l -w' on the packages named
by the import paths. It prints the names of the files that are modified.
For more about gofmt, see 'go doc cmd/gofmt'.
For more about specifying packages, see 'go help packages'.
The -n flag prints commands that would be executed.
The -x flag prints commands as they are executed.
To run gofmt with specific options, run gofmt itself.

See also: go fix, go vet.

go fmt命令本身只有两个可选参数-n和-x,-n仅打印出内部要执行的go fmt的命令,-x命令既打印出go fmt命令又执行它,如果需要更细化的配置,需要直接执行gofmt命令。

go fmt在调用gofmt时添加了-l -w参数,相当于执行了gofmt -l -w

goland中配置gofmt

Goland是JetBrains公司推出的Go语言IDE,是一款功能强大,使用便捷的产品。

在Goland中,可以通过添加一个File Watcher来在文件发生变化的时候调用gofmt进行代码格式化,具体方法是,点击Preferences -> Tools -> File Watchers,点加号添加一个go fmt模版,Goland中预置的go fmt模版使用的是go fmt命令,将其替换为gofmt,然后在参数中增加-l -w -s参数,启用代码简化功能。添加配置后,保存源码时,goland就会执行代码格式化了。

转载来源:https://juejin.cn/post/7381455296658538559

相关文章
GoLand软件包 home 包含多个 main 函数 请考虑改用文件种类
GoLand软件包 home 包含多个 main 函数 请考虑改用文件种类
383 0
GoLand软件包 home 包含多个 main 函数 请考虑改用文件种类
|
缓存 测试技术 开发者
如何解决 Postman 报错一直转圈打不开?
缓存过多的时候,打开postman就会出现转圈的现象,所以需要清理下缓存文件。
|
数据可视化 JavaScript 架构师
D3.js实战:数据可视化高级技巧实例应用
本文介绍了D3.js入门,包括创建HTML文件引入库、绘制简单线图、柱状图和饼图。示例展示了数据绑定、交互性和动画效果,如柱状图的悬停效果和线图的数据平滑过渡。此外,还提及力导向图和地图可视化的实现,以及使用Enter, Update, Exit模式进行动态更新。最后提到了复杂图表和高级技巧,如使用组件库、动画、交互性和性能优化。
673 0
|
SQL 设计模式 存储
【MySQL】一文搞懂MySQL语法(进阶)
本文讲述了SQL语法一些进阶内容,全文3.4w字,都是一句一句话指导,相信用心看,肯定会有收获的,需要哪一部分的内容,点击目录即可跳转
712 0
【MySQL】一文搞懂MySQL语法(进阶)
集成运算放大器的线性应用(模电速成)
集成运算放大器的线性应用(模电速成)
926 0
Hertz踩坑记录,Hertz-CORS跨域问题
字节跳动开源框架Hertz,可能存在的CORS的跨域问题
|
编译器
Qt没有被正确安装,请运行make install -- 问题的解决办法
Qt没有被正确安装,请运行make install -- 问题的解决办法
1648 0
|
存储 缓存 前端开发
意外之惊喜!浏览器缓存优化方案,让页面加载速度飙升48.5%!
经过对浏览器缓存优化方案的调研和实现过程,我发现了一个令人意外的发现:**页面加载速度提升了整整48.5%!** 这个令人震撼的结果在微前端架构项目中具有重要意义,同时虽然本文是针对微前端架构的,但这个浏览器缓存优化方案同样适用于其他前端项目。本文将深入探讨这个优化方案,并分享调试和改进的经验。
702 1
意外之惊喜!浏览器缓存优化方案,让页面加载速度飙升48.5%!
|
Java Linux Apache
camel+minio实现预签名URL上传
camel+minio实现预签名URL上传
938 0
|
开发框架 前端开发 Java
SpringBoot简介&IDEA在线创建一个SpringBoot项目
SpringBoot 项目创建有三种方式,分别是在线创建、使用Spring initializr快速创建、和改造Maven工程创建,本期讲的就是如何在线创建一个SpringBoot项目。首先我们要下载好IntelliJ IDEA以及jdk1.8版本。springboot 是 spring 快速开发脚手架,通过约定大于配置的方式,快速构建和启动 spring 项目. springboot根据我们项目中所引入的依赖,比如引入了springmvc构件,就会判断出是要进行springmvc的web开发,就会把spr
1084 1