golang 代码格式化工具 gofmt

对于一门编程语言来说,代码格式化是最容易引起争议的一个问题,不同的开发者可能会有不同的编码风格和习惯,但是如果所有开发者都能使用同一种格式来编写代码,开发者就可以将宝贵的时间专注在语言要解决的问题上。

使用方法:

单文件: gofmt -l -w  test.go

整个工程:gofmt -l -w /root/go_project

gofmt下载

gofmt 在 go安装包中

go安装包下载地址:https://studygolang.com/dl   注意最好下载安装包不是源码包

go linux 当前最新版本安装包下载地址:https://studygolang.com/dl/golang/go1.12.7.linux-amd64.tar.gz

下载解压

wget https://studygolang.com/dl/golang/go1.12.7.linux-amd64.tar.gztar -C /usr/local -xzf go1.12.7.linux-amd64.tar.gz

即可发现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[flags][path…]-cpuprofile字符串    将CPU配置文件写入此文件-d 显示差异而不是重写文件-e 报告所有错误(不只是不同行的前10个错误)-l 列出格式与gofmt不同的文件-R 字符串    重写规则(例如“a[b:len(a)]->a[b:'')-S 简化代码-w 将结果写入(源)文件而不是stdout

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

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

package mainimport fmtfunc main() {a := 1b := 2c := a + bfmt.Println(c)}

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

gofmt -r a + b -> b + a

格式化的结果如下。

package mainimport fmtfunc main() {a := 1b := 2c := b + afmt.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 namedby 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。

相关文章

类型转换 1、int转string 2、string转int 3、string转float ...
package main import s "strings" import...
类使用:实现一个people中有一个sayhi的方法调用功能,代码如...
html代码: beego代码:
1、读取文件信息: 2、读取文件夹下的所有文件: 3、写入文件...
配置环境:Windows7+推荐IDE:LiteIDEGO下载地址:http:...