GO：1.2 命令源码文件

我们已经知道，环境变量 GOPATH 指向的是一个或多个工作区，每个工作区中都会有以代码包为基本组织形式的源码文件。

这里的源码文件又分为三种，即：命令源码文件、库源码文件和测试源码文件，它们都有着不同的用途和编写规则。
command1.png

1、命令源码文件的用途是什么，怎样编写它？

1、命令源码文件是程序的运行入口，是每个可独立运行的程序必须拥有的。我们可以通过构建或安装，生成与其对应的可执行文件，后者一般会与该命令源码文件的直接父目录同名。

2、如果一个源码文件声明属于main包，并且包含一个无参数声明且无结果声明的main函数，那么它就是命令源码文件。 就像下面这段代码：

1
2
3
4
5
6
7
package main

import "fmt"

func main() {
  fmt.Println("Hello, world!")
}

如果你把这段代码存成 demo1.go 文件，那么运行go run demo1.go命令后就会在屏幕（标准输出）中看到Hello, world!

注：
1、当需要模块化编程时，我们往往会将代码拆分到多个文件，甚至拆分到不同的代码包中。但无论怎样，对于一个独立的程序来说，命令源码文件永远只会也只能有一个。如果有与命令源码文件同包的源码文件，那么它们也应该声明属于main包。

2、通过构建或安装命令源码文件，生成的可执行文件就可以被视为“命令”，既然是命令，那么就应该具备接收参数的能力。

2、命令源码文件怎样接收参数

先看下面代码：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
package main

import (
  "flag"//1步
  "fmt"
)

var name string

func init() {
  flag.StringVar(&name, "name", "everyone", "The greeting object.")//2步
}
/*
1、函数flag.StringVar接受 4 个参数。

2、第 1 个参数是用于存储该命令参数值的地址，具体到这里就是在前面声明的变量name的地址了，由表达式&name表示。

3、第 2 个参数是为了指定该命令参数的名称，这里是name。

4、第 3 个参数是为了指定在未追加该命令参数时的默认值，这里是everyone。

5、第 4 个函数参数，即是该命令参数的简短说明了，这在打印命令说明时会用到。
*/

func main() {
  flag.Parse()//函数flag.Parse用于真正解析命令参数，并把它们的值赋给相应的变量。
  //3步
  fmt.Printf("Hello, %s!\n", name)
}

/*
对该函数的调用必须在所有命令参数存储载体的声明（这里是对变量name的声明）和设置（这里是在[2]处对flag.StringVar函数的调用）之后，并且在读取任何命令参数值之前进行。

正因为如此，我们最好把flag.Parse()放在main函数的函数体的第一行。
*/

注：还有一个与flag.StringVar函数类似的函数，叫flag.String。这两个函数的区别是，后者会直接返回一个已经分配好的用于存储命令参数值的地址。如果使用它的话，我们就需要把“var name string”改为

1
var name = flag.String("name", "everyone", "The greeting object.")

3、怎样在运行命令源码文件的时候传入参数，又怎样查看参数的使用说明

我们把上述代码存成名为 demo2.go 的文件，那么运行如下命令就可以为参数name传值：

1
go run demo2.go -name="Robert"

运行后，打印到标准输出（stdout）的内容会是：

1
Hello, Robert!

另外，如果想查看该命令源码文件的参数说明，可以这样做：

1
$ go run demo2.go --help

其中的$表示我们是在命令提示符后运行go run命令的。运行后输出的内容会类似：

1
2
3
4
Usage of /var/folders/ts/7lg_tl_x2gd_k1lm5g_48c7w0000gn/T/go-build155438482/b001/exe/demo2:
 -name string
    The greeting object. (default "everyone")
exit status 2

以下是go run命令构建上述命令源码文件时临时生成的可执行文件的完整路径

1
/var/folders/ts/7lg_tl_x2gd_k1lm5g_48c7w0000gn/T/go-build155438482/b001/exe/demo2

如果我们先构建这个命令源码文件再运行生成的可执行文件，像这样：

1
2
$ go build demo2.go
$ ./demo2 --help

那么输出就会是

1
2
3
Usage of ./demo2:
 -name string
    The greeting object. (default "everyone")

4、怎样自定义命令源码文件的参数使用说明

1、最简单的一种方式就是对变量flag.Usage重新赋值。

flag.Usage的类型是func()，即一种无参数声明且无结果声明的函数类型。flag.Usage变量在声明时就已经被赋值了，所以我们才能够在运行命令go run demo2.go –help时看到正确的结果。注意，对flag.Usage的赋值必须在调用flag.Parse函数之前。现在，我们把 demo2.go 另存为 demo3.go，然后在main函数体的开始处加入如下代码。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
package main

import (
  "flag"//1步
  "fmt"
)

var name string

func init() {
  flag.StringVar(&name, "name", "everyone", "The greeting object.")//2步
}

func main() {
    flag.Usage = func() {
     fmt.Fprintf(os.Stderr, "Usage of %s:\n", "question")
     flag.PrintDefaults()
    }
  flag.Parse()//函数flag.Parse用于真正解析命令参数，并把它们的值赋给相应的变量。
  //3步
  fmt.Printf("Hello, %s!\n", name)
}

运行

1
$ go run demo3.go --help

后，就会看到

1
2
3
4
Usage of question:
 -name string
    The greeting object. (default "everyone")
exit status 2

2、现在再深入一层，我们在调用flag包中的一些函数（比如StringVar、Parse等等）的时候，实际上是在调用flag.CommandLine变量的对应方法。

flag.CommandLine相当于默认情况下的命令参数容器。所以，通过对flag.CommandLine重新赋值，我们可以更深层次地定制当前命令源码文件的参数使用说明。

现在我们把main函数体中的那条对flag.Usage变量的赋值语句注销掉，然后在init函数体的开始处添加如下代码：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
package main

import (
  "flag"//1步
  "fmt"
)

var name string

func init() {
  flag.CommandLine = flag.NewFlagSet("", flag.ExitOnError)
  flag.CommandLine.Usage = func() {
  fmt.Fprintf(os.Stderr, "Usage of %s:\n", "question")
  flag.PrintDefaults()
}
  flag.StringVar(&name, "name", "everyone", "The greeting object.")//2步
}

func main() {
  flag.Parse()//函数flag.Parse用于真正解析命令参数，并把它们的值赋给相应的变量。
  //3步
  fmt.Printf("Hello, %s!\n", name)
}

再运行命令go run demo3.go –help后，其输出会与上一次的输出的一致。不过后面这种定制的方法更加灵活。比如，当我们把为flag.CommandLine赋值的那条语句改为

1
flag.CommandLine = flag.NewFlagSet("", flag.PanicOnError)

后，再运行go run demo3.go –help命令就会产生另一种输出效果。这是由于我们在这里传给flag.NewFlagSet函数的第二个参数值是flag.PanicOnError。

  • 1、flag.PanicOnError和flag.ExitOnError都是预定义在flag包中的常量。
  • 2、flag.ExitOnError的含义是，告诉命令参数容器，当命令后跟–help或者参数设置的不正确的时候，在打印命令参数使用说明后以状态码2结束当前程序。
  • 状态码2代表用户错误地使用了命令，而flag.PanicOnError与之的区别是在最后抛出“运行时恐慌（panic）”。
  • 上述两种情况都会在我们调用flag.Parse函数时被触发。

3、下面再进一步，我们索性不用全局的flag.CommandLine变量，转而自己创建一个私有的命令参数容器。我们在函数外再添加一个变量声明：

1
var cmdLine = flag.NewFlagSet("question", flag.ExitOnError)

然后，我们把对flag.StringVar的调用替换为对cmdLine.StringVar调用，再把flag.Parse()替换为cmdLine.Parse(os.Args[1:])。

其中的os.Args[1:]指的就是我们给定的那些命令参数。这样做就完全脱离了flag.CommandLine。

这样做的好处依然是更灵活地定制命令参数容器。但更重要的是，你的定制完全不会影响到那个全局变量flag.CommandLine。