go fmt命令——格式化代码文件

对于一门编程语言来说，代码格式化是最容易引起争议的一个问题，不同的开发者可能会有不同的编码风格和习惯，但是如果所有开发者都能使用同一种格式来编写代码，那么开发者就可以将主要精力放在语言要解决的问题上，从而节省开发时间。

gofmt 介绍

Go语言的开发团队制定了统一的官方代码风格，并且推出了 gofmt 工具（gofmt 或 go fmt）来帮助开发者格式化他们的代码到统一的风格。

gofmt 是一个 cli 程序，会优先读取标准输入，如果传入了文件路径的话，会格式化这个文件，如果传入一个目录，会格式化目录中所有 .go 文件，如果不传参数，会格式化当前目录下的所有 .go 文件。

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

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

如下形式的切片表达式：

简化后的代码为：

2) 去除数组切片操作时不必要的索引指定

如下形式的切片表达式：

简化后的代码为：

3) 去除循环时非必要的变量赋值

如下形式的循环：

简化后的代码为：

如下形式的循环：

简化后的代码为：

gofmt 命令参数如下表所示： 

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

【示例】有如下内容的 Golang 程序，存储在 main.go 文件中。

package main

import "fmt"

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

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

格式化的结果如下。

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 的简单封装。

go fmt命令本身只有两个可选参数-n和-x：

• -n仅打印出内部要执行的go fmt的命令；
• -x命令既打印出go fmt命令又执行它，如果需要更细化的配置，需要直接执行 gofmt 命令。

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