欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  web前端

使用go构建命令行程序的快捷之道_html/css_WEB-ITnose

程序员文章站 2022-04-30 10:56:23
...

摘要

本文介绍用于构建命令行程序的开源工具 mkideal/cli 。golang标准库 flag 是官方自带的用于命令行参数解析的实用库,而本文介绍的 cli 的主要功能基本与 flag 库相同,但是提供相对简洁友好的用法以及更多实用工具。 cli 的主要特性包括:

  • 基于golang的tag和反射实现。
  • 参数类型和范围检查,以及自定义的验证函数。
  • 支持短格式和长格式的flag像 -h 和 --help 。
  • 支持指定默认值,甚至是以环境变量为默认值。
  • 支持数组和map为参数。
  • 友好的帮助显示。
  • ……

cli 开源在github上 https://github.com/mkideal/cli

入门介绍

命令行程序虽然没有华丽的界面,但是在服务器端,命令行程序是不可或缺的,而且在很多时候比图形界面更加好用。在unix/linux操作系统上命令行程序极其常见,系统上预装大量程序。 cli 这个工具正是用来便捷构建这种命令行程序的go语言库。 先看一个简单的示例:

package mainimport (	"github.com/mkideal/cli")type argT struct {	cli.Helper}func main() {	cli.Run(&argT{}, func(ctx *cli.Context) error {		argv := ctx.Argv().(*argT)		if argv.Help {			ctx.WriteUsage()		} else {			ctx.String("hello\n")		}		return nil	})}

编译运行这段代码

$ go build -o app$ ./apphello$ ./app -hOptions:  -h, --help     display help

当然这段代码没有任何实质功能。代码第12行调用 cli 的 Run 函数,函数原型如下:

func Run(argv interface{}, fn func(*Context) error, descs ...string)

参数 argv 在执行时会通过解析命令行参数来赋值,然后塞进 Context 对象,最终传递给回调函数 fn 。在回调函数中通过 ctx.Argv() 获得 argv 。

本示例代码的 argT 继承于 cli.Helper ,它的定义如下:

type Helper struct { Help bool `cli:"!h,help" usage:"display help"`}

好了,下面创建一个实用一点的程序来做更详细的讲解。

一个简易的http服务器

package mainimport (	"fmt"	"net/http"	"github.com/mkideal/cli")type argT struct {	cli.Helper	Host string `cli:"H,host" usage:"specify host" dft:"0.0.0.0"`	Port uint16 `cli:"p,port" usage:"specify port" dft:"8080"`	Dir  string `cli:"d,dir" usage:"static files directory" dft:"./"`}func main() {	cli.SetUsageStyle(cli.ManualStyle)	cli.Run(new(argT), func(ctx *cli.Context) error {		argv := ctx.Argv().(*argT)		if argv.Help {			ctx.WriteUsage()			return nil		}		http.Handle("/", http.FileServer(http.Dir(argv.Dir)))		addr := fmt.Sprintf("%s:%d", argv.Host, argv.Port)		ctx.String("listening on %s\n", addr)		http.ListenAndServe(addr, nil)		return nil	})}

在这个例子里,参数对象 argT 多了几个有用的字段: Host Port Dir

还是先编译运行一下

$ go build -o httpd$ ./httpd -h

好了,现在创建一个 html 目录,然后新建一个文件 index.html ,内容为

Hello, this is my http server!

然后启动 http server

$ mkdir html$ echo "

Hello, this is my http server!

" > html/index.html$ ./httpd -d htmllistening on 0.0.0.0:8080

现在通过浏览器访问 127.0.0.1:8080 就可以看到

你还可以指定别的端口,而非默认的端口8080,比如指定端口为3000

可以这样启动

$ ./httpd -d html --port=3000

或者

$ ./httpd -d html --port 3000

或者

$ ./httpd -d html -p=3000

或者

$ ./httpd -d html -p 3000

接下来讲述一下出现在参数定义中的标签,它们是解析参数以及显示帮助时器关键作用的因素。

标签cli,usage,dft

cli 支持4个标签

  • cli - 参数flag名,如示例中的 cli:"h,help" cli:"H,host" 等
  • usage - 参数使用描述,是会显示在帮助中的文本
  • dft - 指定参数默认值,可以指定环境变量为默认值,比如这样 dft:"$HOME"
  • name - 参数引用名,并无实质功能

创建命令行程序的命令行工具 clier goplus

clier 是 mkideal/cli 下的一个命令行程序,它也是使用 cli 构建的。 clier 用于创建一条命令,比如这样

$ clier hello$ clier -s "this is hello command's description" hello

goplus 的 new 子命令可以构建完整的基于 cli 的命令行程序。使用示例

$ goplus new hello # 最基本的单命令程序$ goplus new -t http httpd # 通过 `-t` 参数指定程序类型为`http`$ goplus new -t tree demo # 基本的多命令程序

本文只是一个 cli 的简要介绍。下面几篇是关于 cli 的更详细的介绍