02-命令源码文件

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

这里的源码文件分为三种:

  1. 命令源码文件
  2. 库源码文件
  3. 测试源码文件

它们有着不同的用途和编写规则。

0.1. 命令源码文件

  • 独立的程序入口
  • 属于main包,包含无参数无结果的main函数
  • 可通过go run 命令运行,可接受命令行参数
  • main函数执行结束意味着当前程序运行结束
  • 同一个代码包中不要放多个命令源码文件
  • 命令源码文件与库源码文件也不要放在同一个代码包中

0.1.1. 构建

  • 构建后生成可执行文件(executable file)
    • 可在命令行中运行的文件
    • 在Windows中就是扩展名为.exe的文件
    • 在Linux中一般没有扩展名
  • 生成位置在命令执行目录

0.1.2. 安装

  • 安装后生成可执行文件
  • 生成位置在当前工作区的bin子目录或GOPATH包含的目录

0.2. 库源码文件

  • 用于放置可供其他代码使用的程序实体

0.2.1. 构建

  • 作用在于检查和验证
  • 构建后只生成临时文件
    • 在操作系统的临时目录下
    • 开发者一般不关心

0.2.2. 安装

  • 安装后生成归档文件(archive file)
    • 扩展名为.a的文件
    • 即为静态链接库文件
  • 生成位置在当前工作区的pkg子目录

0.3. 测试源码文件

0.3.1. 功能测试源码文件

  • 测试函数名称(TestXXX)
  • 测试函数签名(t *testing.T)

0.3.2. 性能(基准)测试源码文件

  • 测试函数名称(BenchmarkXXX)
  • 测试函数签名(b *testing.B)

0.3.3. 示例(样本)测试源码文件

  • 测试函数名称(ExampleXXX)
  • 测试函数签名(没有硬性要求)
  • 测试函数期望输出
    • 放置在函数末尾
    • 用注释行表示
    • 形如//Output:xxx

在学习Go语言的过程中,经常会编写可以直接运行的程序,这样的程序肯定会涉及命令源码文件的编写,命令源码文件可以很方便地使用go run 命令启动。

0.4. 命令源码文件的用途是什么?如何编写

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

  1. 一个源码文件声明属于main包
  2. 包含一个无参数声明且无结果声明的main函数

那么它就是一个命令源码文件。如下所示:

package main

import "fmt"

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

执行go run 命令后在标准输出中就能看到Hello, world!

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

不论是什么操作系统,在命令行中执行的命令都是可以接收参数的。通过构建或安装命令源码文件,生成的可执行文件就可以被看作是命令,所以它也具备接收参数的能力。

0.4.1. 命令源码文件如何接收参数

package main

import (
    // 需在此处添加代码。[1]
    "fmt"
    "flag"
)

var name string

func init() {
    // 需在此处添加代码。[2]
    flag.StringVar(&name, "name", "everyone", "The greeting object.")
}

func main() {
    // 需在此处添加代码。[3]
    flag.Parse()
    fmt.Printf("Hello, %s!\n", name)
}

在注释处编写代码,完成“根据运行程序给定的参数问候某人”的功能。

  1. Go语言标准库中有一个代码包专门用于接收和解析命令参数。flag包。为了调用这个包中的程序实体来读取命令行参数,首先需要先将这个包导入。代码包的名字需要用英文半角的引号引起来

  2. 人名都是由字符串组成,因此调用flag包中的StringVar函数。 函数flag.StringVar接收4个参数:

    • 第一个参数用于存储该命令参数值的地址,即变量name的地址(&name)
    • 第二个参数用于指定该命令参数的名称,即name
    • 第三个参数用于指定在未追加该命令参数时的默认值,即everyone
    • 第四个参数用于对该命令参数进行说明,这在打印命令说明时用到
  3. 在主函数中调用flag.Parse()函数,用于真正解析命令参数,并把它的值赋给相应的变量。对该函数的调用必须在所有命令参数存储载体的声明(即name变量)和设置(即flag.StringVar函数调用)之后,并且在读取任何命令参数值之前。所以在此处把Parse的调用放在main函数的第一行。

flag还有一个String函数,直接返回一个已经分配好的用于存储命令参数值的地址。

如果使用flag.String,进行如下修改:

package main

import (
 // 需在此处添加代码。[1]
    "fmt"
    "flag"
)

func init() {
    // 需在此处添加代码。[2]
    var name = flag.String("name", "everyone", "The greeting object.")
}

func main() {
 // 需在此处添加代码。[3]
 fmt.Printf("Hello, %s!\n", name)
}

0.4.2. 如何在运行命令源文件的时候传入参数,如何查看参数的使用说明

假设上面的命令源文件名字为demo2.go。

  1. 运行如下命令,为参数name传值

    go run demo2.go -name=Robert
    
    # 运行后,在标准输出中打印如下内容:
    
    Hello,Robert!
  2. 运行如下命令,查看命令源码文件的参数说明

    go run demo2.go --help
    
    # 运行后,在标准输出中打印如下内容:
    
    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

    输出中的/var/folders/ts/7lg_tl_x2gd_k1lm5g_48c7w0000gn/T/go-build155438482/b001/exe/demo2是go run 命令构建上述命令源码文件时临时生成的可执行文件的完整路径。

    换个方式,先构建在执行:

    go build demo2.go
    ./demo2 --help
    
    # 运行后,在标准输出中打印如下内容:
    
    Usage of ./demo2:
     -name string
        The greeting object. (default "everyone")

0.4.3. 如何自定义命令源文件的参数使用说明

有多种方式可以实现,最简单的是对变量flag.Usage重新赋值。flag.Usage的类型是func(),即一种无参数声明且无结果声明的函数类型。

flag.Usage变量在声明时就已经被赋值了,所以在运行上述go run demo2.go --help时看到正确的结果。对flag.Usage的赋值必须在调用flag.Parse函数之前

在demo2.go的基础上修改demo3.go,在main函数的开始处添加如下代码:

flag.Usage = func(){
    fmt.Fprint(os.Stderr, "Usage of %s:\n", "question")
    flag.PrintDefault()
}

运行demo3.go:

go run demo3.go --help

# 在标准输出中打印如下内容

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

0.4.4. 深入一些

在调用flag包中的一些函数(StringVar,Parse等)时,实际上是在调用flag.CommandLine变量的对应方法。

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

修改demo2.go中的init函数体:

flag.CommandLine = flag.NewFlagSet("", flag.ExitOnError)
flag.CommandLine.Usage = func(){
    fmt.Fprint(os.Stderr, "Usage of %s:\n", "question")
    flag.PrintDefaults()
}

再次执行go run demo2.go --help输入的结果与demo3.go相同,不过这种方式更加的命令,可以通过修改flag.NewFlagSet的第二个参数来实现不同输出效果的目的。如修改为flag.PanicOnError,这些都是flag包中的常量。

  • flag.ExitOnError:告诉命令参数容器,当命令后跟--help或者参数设置不正确的时候,在打印命令参数使用说明后以状态码2(表示用户错误的使用命令)退出当前程序。
  • flag.PanicOnError:与上面的区别在于,最后跑出一个运行时恐慌(panic)。

运行时恐慌是Go程序处理错误的方式。

0.4.5. 再进一步,自定义命令参数容器

不使用flag.CommandLine,自己创建一个私有的命令参数容器:

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

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

*flag.FlagSet类型的变量cmdLIne拥有很多有意思的方法。

这样的自定义更灵活,且不会影响到全局变量flag.CommandLine。

0.5. 总结

通过上述方法,可以使用Go语言编写命令,并且像其他操作系统中的命令那样被使用,也可以嵌入到各种脚本中。

上次修改: 25 November 2019