创建一个命令行程序

问题

如何使用golang创建可以在命令行当中传递参数的程序?go程序如何带参数执行?

比如我们期望使用*hello -version*来查看hello程序的版本号码。或者输入hello language chinese 来切换hello程序的语言版本。

解决

在网络上大家可以经常搜索到的解决方案是使用go标准库当中的os.Args或者flag方法获取命令行参数再执行程序。可以很容易google和baidu的这里就不重复说明了。 这里介绍一个开源的cli库的解决方案。

urfave/cli

该cli库集成了很多创建cli程序的工具和方法,官方github库文档功能案例介绍比较全面很容易学习使用。

截止到2018年2月19日,该开源库有875次commit,33次releases,7462个star。经过长期迭代和社区验证功能比较完整,程序稳定性也相对会可靠很多。

实现查看版本和切换语言的程序功能

注:本案例代码只是简单的打印出language而已。

 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
36
37
38
39
40
package main

import (
    "os"
    "github.com/urfave/cli"
    "fmt"
)

func main() {
    // 实例化cli
    app := cli.NewApp()
    // Name可以设定应用的名字
    app.Name = "hello"
    // Version可以设定应用的版本号
    app.Version = "1.0.0"
    // Commands用于创建命令
    app.Commands = []cli.Command{
        {
            // 命令的名字
            Name:    "language",
            // 命令的缩写,就是不输入language只输入lang也可以调用命令
            Aliases: []string{"lang"},
            // 命令的用法注释,这里会在输入 程序名 -help的时候显示命令的使用方法
            Usage:   "change language",
            // 命令的处理函数
            Action:  func(c *cli.Context) error {
                language := c.Args().First()
                if language == "chinese"{
                    fmt.Println("Language is 中文")
                }else {
                    fmt.Println("Language is English")
                }
                return nil
            },
        },

    }
    // 接受os.Args并启动程序
    app.Run(os.Args)
}

效果

 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
liuMacBook-Pro:gowork liuyunpeng$ go run hello.go -help
NAME:
   hello - A new cli application

USAGE:
   hello [global options] command [command options] [arguments...]

VERSION:
   1.0.0

COMMANDS:
     language, lang  change language
     help, h         Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h     show help
   --version, -v  print the version

liuMacBook-Pro:gowork liuyunpeng$ go run hello.go -version
hello version 1.0.0
liuMacBook-Pro:gowork liuyunpeng$ go run hello.go lang chinese
Language is 中文
liuMacBook-Pro:gowork liuyunpeng$ go run hello.go lang french
Language is English
liuyMacBook-Pro:gowork liuyunpeng$ go run hello.go lang english
Language is English

更多的使用方法可以登录urfave/cli查看。

扩展

1.命令行的形式

值得大家注意的是,-flag 前面带减号(实际上应该是破折号为了方便就缩减成减号了)这种带标志方式的使用方法和 command 方法是两个概念。个人理解是前者代表参数的传递比如给 -name=ppmoon 就是给name变量传递ppmoon参数。后者是执行一段命令,比如 hello add 1 1 返回结果就是2,就是通过hello程序执行了一个1+1的运算,参数通过空格的方式依次传递到程序当中了。从使用体验的角度来说个人认为并没有什么大的区别,因为本质上来说cli程序只是没有图形化的UI界面,我们只是在命令提示符当中操作程序罢了,不管你使用什么样子的方式传递都只是形式上的变化。

2.关于go标准库当中的flag包以及os.Args方法

flag是官方提供的一个不错的cli程序扩展包,里面也包含了很多常用的方法。不管是flag还是urfave/cli都需要依赖OS包当中的os.Args方法来获取命令行参数,这一点是值得注意的便于理解cli程序的原理。

3.设置环境变量在任意文件夹使用cli程序

在Mac Windows Linux我们都会使用到命令行程序,如果想在全局任何一个文件夹下面都使用命令行程序,我们只需要将cli程序的可执行程序文件所在的文件夹路径添加到环境变量里就可以直接使用程序的名字全局调用cli程序了。具体网络上可以搜索到诸多教程这里就不赘述了。