go标准命令详解0.9 go fmt与gofmt

搬运自github赫林的go_command_tutorial，绝对干货，感谢作者。

go fmt

命令会按照Go语言代码规范格式化指定代码包中的所有Go语言源码文件的代码，所有Go语言源码文件即包括命令源码文件、库源码文件和测试源码文件。注意，当代码包还有子代码包时，子代码包中的Go语言源码文件是不包含在内的。也就是说，

go fmt

命令只会格式化被直接保存在指定代码包对应目录下的Go语言源码文件。

和

go doc

命令与

godoc

命令的关系一样，

go fmt

命令也是

gofmt

命令的简单封装。

go fmt

命令本身可以接受两个标记。标记

-n

仅仅打印出内部使用的

gofmt

命令及其标记和参数而不真正执行它。 标记

-x

则既打印又执行这个命令。在

go fmt

命令程序内部，会在其调用的

gofmt

命令加上标记

-l

和

-w

，并以指定代码包中的所有Go语言源码文件的路径作为参数，就像这样：

[code]hc@ubt:~$ go fmt -n pkgtool
gofmt -l -w golang/goc2p/src/pkgtool/envir.go golang/goc2p/src pkgtoolenvir_test.go golang/goc2p/src/pkgtool/fpath.go golang/goc2p/src/pkgtool ipath.go golang/goc2p/src/pkgtool/pnode.go golang/goc2p/src/pkgtool/util.go golang/goc2p/src/pkgtool/util_test.go

注意，作为

gofmt

命令参数的Go语言源码文件的路径是相对的，而不是绝对的。不过这只是为了让参数看起来更短一些而已。所以，当我们直接执行

gofmt

命令的时候，使用源码文件的绝对路径作为参数也是没有问题的。实际上，任何Go源码文件或包含有Go语言源码文件的目录的相对路径或绝对路径都可以作为

gofmt

命令的参数。当使用包含有Go语言源码文件的目录的绝对路径或相对路径作为参数时，

gofmt

命令会把被直接保存在这个目录下的Go语言源码文件作为目标源码文件。

go fmt

命令程序内部在执行

gofmt

命令时加入的标记是固定的。如果我们想使用与之不同的标记集合就必须直接使用

gofmt

命令了。现在我们来看一下

gofmt

命令可接受的所有标记。如下表。

表0-13

gofmt

命令的标记说明

| 标记名称 | 标记描述 |

| -l | 仅把那些不符合格式化规范的、需要被命令程序改写的源码文件的绝对路径打印到标准输出。而不是把改写后的全部内容都打印到标准输出。 |

| -w | 把改写后的内容直接写入到文件中，而不是作为结果打印到标准输出。 |

| -r | 添加形如“a[b:len(a)] -> a[b:]”的重写规则。如果我们需要自定义某些额外的格式化规则，就需要用到它。 |

| -s | 简化文件中的代码。 |

| -d | 只把改写前后的内容的对比信息作为结果打印到标准输出。而不是把改写后的全部内容都打印到标准输出。命令程序将使用diff命令对内容进行比对。在Windows操作系统下可能没有diff命令，需要另行安装。 |

| -e | 打印所有的语法错误到标准输出。如果不使用此标记，则只会打印每行的第1个错误且只打印前10个错误。 |

| -comments | 是否保留源码文件中的注释。在默认情况下，此标记会被隐式的使用，并且值为true。 |

| -tabwidth | 此标记用于设置代码中缩进所使用的空格数量，默认值为8。要使此标记生效，需要使用“-tabs”标记并把值设置为false。 |

| -tabs | 是否使用tab（’\t’）来代替空格表示缩进。在默认情况下，此标记会被隐式的使用，并且值为true。 |

| -cpuprofile | 是否开启CPU使用情况记录，并将记录内容保存在此标记值所指的文件中。 |

看过上表中的信息，我们就很容易理解

go fmt

命令的行为了。因为它在内部执行了

gofmt

命令，并加入了标记

-l

和

-w

。这会使命令程序打印需要改写的文件的绝对路径到标准输出，并且直接把改写的内容写入到文件中。在默认情况下，

gofmt

命令会把改写后内容直接打印到标准输出上。

实际上，命令程序会把目标源码文件中的内容解析成抽象语法树。当在解析过程中发现语法错误时，命令程序就会显示错误提示信息并退出。在默认情况下，目标源码文件中的语法错误不会全部被显示出来。我们可以加入标记

-e

以使命令程序打印出全部错误到标准输出。

自定义改写操作

在默认情况下，

gofmt

命令对Go语言源码文件的改写操作包括如下几个方面：

以字典序排序依赖包导入语句块中代码包导入路径的先后顺序。

标准化各个语言或语句块之间的缩进、空格和换行。比如，把所有的

\r\n

转换成

\n

。

对代码语法的小修正。比如，消除用于判断变量类型的switch语句块中多余的圆括号。

如果想自定义额外的改写操作，需要使用

-r

标记。

-r

标记的值中必须包含“->”，比如

a[b:len(a)] -> a[b:]

。“->”的左边应该是需要被替代的表达式的示例，而右边则应该是用来替代“->”左边表达式的表达式的示例。

如果我们使用标记

-r

，那么命令程序是在解析源码文件之前，会将此标记值中的被替换表达式和替换表达式分别解析为抽象语法树的表达式节点。如果解析不成功，也就意味着无法进行后续的替换操作，命令程序会在打印错误提示信息后退出。如果解析成功，那么命令程序会在解析源码文件成功之后进行表达式替换操作。命令程序会寻找该源码文件的抽象语法树中与被替换表达式相匹配的节点，并用替换表达式替换之。

gofmt

命令已支持但不限于如下自定义替换操作：

程序实体名称的替换。程序实体包括变量、常量、函数、结构体和接口。比如：

-r=array1->array2

和

-r=FuncA->FuncB

。

程序实体类型的替换，其中也包含函数的参数和结果的类型的替换。比如：

-r=string->bool

和

-r=interface{}->int

。

多余圆括号的清除。比如：我们这样设置标记

-r=(x)->x

会使目标代码中的

a = (-x.s)

被改写为

a = -x.s

，也会使代码中的

((b = -x.f()))

被改写为

b = -x.f()

，还会使

c = -(x).f

改写为

`c = -x.f

，但是不会去掉

d = (&x).s

和

e = (-x).f()

中的圆括号。也就是说，命令程序会在不改变语义和不产生语法歧义的前提下清除代码中多余的圆括号。

数值操作的替换。比如：我们这样设置标记

-r=x+x->x*2

会使代目标码中的所有的

x + x

被替换为

x * 2

。并且，如果需要被替换的表达式中包含注释的话，则在替换操作的过程中会去掉这些注释。比如，在同样的标记设置的情况下

x /* It's comment */ + x

仍然会被替换为

x * 2

。

基于参数列表的函数调用替换。比如：如果我们这样设置标记

-r='funcA(a)->FuncA(a, c)'

，则目标代码中调用函数

funcA

并以一个变量作为参数的语句都会被替换为调用函数

FuncA

并以变量

a

和变量

c

作为参数的语句。注意，被替换表达式中作为参数的

a

只是表明函数

funcA

有一个参数，而并不关心这个参数的名称是什么。也就是说，在同样的标记设置的情况下，目标代码中的

funcA(b)

或

funcA(x)

都会被替换为

FuncA(a, c)

。再或者，如果我们这样设置标记

-r='funB(x...)->FunC(x)'

，则目标代码中的

funB(x...)

或

funB(y...)

或其它类似的调用函数都会被替换为

FunC(x)

。其中，当类型为数组/切片的参数后跟三个英文半角句号“…”时，则表明需要把这个参数中的每一个元素都作为单独的参数传入到函数中。因此，这种替换方式可以用来在函数名称和/或参数列表改变之后，批量的跟进修正调用该函数的代码。

代码简化操作

当我们在执行

gofmt

命令时加入了标记

-s

，命令程序会在目标源码文件中寻找可以简化的代码并简化它。简化操作包括：

消除在数组/切片初始化中的不必要的类型声明。

消除在字典初始化中的不必要的类型声明。

消除在数组/切片切片操作时不必要的索引指定。

消除迭代时的非必要临时变量赋值操作。

这些操作基本上都是出于尽量使用Go语言的语法糖已达到减少代码量的目的。我们在编写Go语言代码的时候应该直接使用这些语法糖而不应该依赖使用

gofmt

命令来简化。这里所说的Go语言的语法糖，我们在第3章中已经有所介绍。

我们在本小节中详细介绍了

go fmt

命令和

gofmt

命令。下面我们再汇总一下这两个命令可以为我们做的事情。如下表。

表0-14

go fmt

命令和

gofmt

命令的功能

| 功能 |

go fmt

命令 |

gofmt

命令 |

| 格式化代码。 | √ | √ |

| 列出不规范的源码文件。 | √ | √ |

| 自动改写源码文件。 | √ | √ |

| 显示对比信息。 | × | √ |

| 提示全部编译错误。 | × | √ |

| 清除注释。 | × | √ |

| 自定义缩进。 | × | √ |

| 简化代码。 | × | √ |

| 自定义替换/重构辅助。 | × | √ |

| CPU使用情况记录。 | × | √ |

最后，值得一提的是，当我们执行

gofmt

命令且没有加任何参数的时候，该命令将会进入到交互模式。在这种模式下，我们可以直接在命令行界面中输入源码，并以Ctrl-d结束。在Linux操作系统下，Ctrl-d代表EOF（End Of File，中文译为文件结束符）。需要注意的是，如果在一行的中间按下Ctrl-d，则表示输出“标准输入”的缓存区，所以这时必须连续按两次Ctrl-d。另外，在Windows操作系统下，Ctrl-z代表EOF，所以需要以Ctrl-z结束。在这之后，

gofmt

命令会像从源码文件中读取源码那样从命令行界面（也称为标准输入）读取源码，并在格式化后将结果打印到命令行界面（也称为标准输出）中。示例如下：

[code]hc@ubt:~$ gofmt -r='fmt.Println(a)->fmt.Printf("%s\n", a)'
if a=="print" {fmt.Println(a)}
warning: rewrite ignored for incomplete programs
if a == "print" {
        fmt.Println(a)
}

由上述示例可知，我们可以使用

gofmt

命令的交互模式格式化任意的代码片段。虽然会显示一行警告信息，但是格式化后的结果仍然会被打印出来。并且，在交互模式下，当我们输入的代码片段不符合Go语言的语法规则时，命令程序也会打印出错误提示信息。在其它方面，命令程序在交互模式与普通模式下的行为也是基本一致的。