文档章节

使用go构建命令行程序的快捷之道

mkideal
 mkideal
发布于 2016/04/17 09:08
字数 1118
阅读 34
收藏 0

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

入门介绍

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

package main

import (
	"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
$ ./app
hello
$ ./app -h
Options:
  -h, --help     display help

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

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 main

import (
	"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

htppd help information

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

<h1>Hello, this is my http server!</h1>

然后启动 http server

$ mkdir html
$ echo "<h1>Hello, this is my http server!</h1>" > html/index.html
$ ./httpd -d html
listening on 0.0.0.0:8080

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

htppd screenshot

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

可以这样启动

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

或者

$ ./httpd -d html --port 3000

或者

$ ./httpd -d html -p=3000

或者

$ ./httpd -d html -p 3000

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

标签 cliusagedft

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的更详细的介绍


本文转载自:http://www.mkideal.com/golang/cli.html

共有 人打赏支持
mkideal
粉丝 0
博文 1
码字总数 0
作品 1
朝阳
私信 提问
mpvue 1.0.6 发布,基于 Vue.js 的小程序开发框架

mpvue 1.0.6 已发布,更新内容: 修复 v-if 和 v-for 同时存在时索引报错 修复 app 上调用 onError 时报错 优化同一组件连续嵌套相同索引的 v-for 时编译提示 优化 mpvue onLoad onLaunch 添...

王练
03/21
1K
4
mpvue 1.0.5 发布,基于 Vue.js 的小程序开发框架

mpvue 是美团点评开源的一个使用 Vue.js 开发小程序的前端框架。框架基于 Vue.js 核心,mpvue 修改了 Vue.js 的 runtime 和 compiler 实现,使其可以运行在小程序环境中,从而为小程序开发引...

王练
03/19
1K
1
mpvue 1.0.16 发布,基于 Vue.js 的小程序开发框架

mpvue 1.0.16 已发布,更新如下: fix #1240 修复 this.arr.push(1) this.arr.concat([1]) 不能触发更新的 bug #1165 在渲染时使用新的 diff 算法来减少 Vue 组件更新引起的 Page.setData 的...

王练
12/07
0
0
mpvue 1.0.7 发布,基于 Vue.js 的小程序开发框架

mpvue 1.0.7 已发布,更新内容: 修复 vuex 全局 store 跨页面数据不同步,渲染异常 #62 修复 canvas 组件上部分事件不被响应 #142 修复 Promise 被覆盖后引发的 $nextTick 错误 #170 修复根...

王练
03/24
1K
2
Windows快捷命令 工具 - ShortCommand

快捷命令 封装Windows命令行,可使用自定义命令,打开文件、文件夹、网页,以及当轻量版搜索引擎使用。 主要功能 运行自定义的快捷命令可以直接: 调用Windows系统的cmd命令行 打开文件或文件...

浊酒入清梦
前天
0
0

没有更多内容

加载失败,请刷新页面

加载更多

iOS补位动画、沙漏效果、移动UITableViewCell、模拟贪吃蛇、拖拽进度等源码

iOS精选源码 JHAlertView - 一款黑白配色的HUD之沙漏效果 继承UIButton的自定义按钮SPButton 用递归算法实现iOS补位动画 iOS 长按移动UITableViewCell JHLikeButton - 有趣的点赞动画 兼容X...

Android爱开源
18分钟前
0
0
08.Beetl自定义方法以及直接访问java类方法---《Beetl视频课程》

本期视频实现了发布评论时间自定义显示; 内容简介:使用了自定义方法以及直接访问java方法实现了发布时间自定义显示 一起学beetl目录:https://my.oschina.net/u/1590490?tab=newest&catal...

Gavin-King
19分钟前
0
0
上币至iamToken

https://github.com/consenlabs/token-profile 点击Fork按钮,插入到自己的github项目中 cd /Users/shijun/Desktop/blockChain/iamToken git clone https://github.com/yellmi1983/token-pro......

八戒八戒八戒
21分钟前
0
0
spark——sparkCore源码解析之RangePartitioner

HashPartitioner分区可能导致每个分区中数据量的不均匀。而RangePartitioner分区则尽量保证每个分区中数据量的均匀,将一定范围内的数映射到某一个分区内。分区与分区之间数据是有序的,但分...

freeli
22分钟前
1
0
常用的ES6语法

什么是ES6?   ECMAScript 6(以下简称ES6)是JavaScript语言的下一代标准,已经在2015年6月正式发布了。Mozilla公司将在这个标准的基础上,推出JavaScript 2.0。   ECMAScript和JavaScr...

peakedness丶
25分钟前
4
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部