文档章节

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

mkideal
 mkideal
发布于 2016/04/17 09:08
字数 1118
阅读 27
收藏 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
朝阳
Apache Commons CLI官方文档翻译 —— 快速构建命令行启动模式

昨天通过几个小程序以及Hangout源码学习了CLI的基本使用,今天就来尝试翻译一下CLI的官方使用手册。 下面将会通过几个部分简单的介绍CLI在应用中的使用场景。 昨天已经联系过几个基本的命令行...

青夜之衫
2017/12/05
0
0
使用Android开发方便快捷的8 个好工具

Android是目前最流行的移动操作系统之一,Android应用开发目前也正变得越来越流行。这里有8个最好的 Android工具,在这些工具的帮助下,开发人员可以更方便、快捷地开发应用程序。 1. SDK和A...

android技术开发
2013/07/29
69
0
前端的一些工具和概念、框架

前端目前发展真是百家争鸣热闹的很,也涌现出了大量的框架、工具,下面就是对热门的前端的一个梳理: 1. Node.js:一个事件驱动I/O服务端JavaScript环境,基于Google的V8引擎,V8引擎执行Jav...

IT追寻者
2016/06/16
163
0
bboss 与ecipse gradle buildship插件结合使用方法

本文介绍bboss 与ecipse gradle buildship插件结合使用方法,但是建议使用gradle sts插件来在eclipse中构建和开发使用bboss框架的项目:点击浏览 gradle buildship和Gradle IDE Pack(bboss...

bboss
2017/02/23
0
0
Gradle学习(十一)——构建脚本基础知识

转载请注明出处:http://blog.csdn.net/lastsweetop/article/details/78962619 项目和任务 Gradle的所有都是基于两个基础概念:项目和任务 每个Gradle构建是由一个或者多个项目构成的,项目表...

lastsweetop
01/03
0
0

没有更多内容

加载失败,请刷新页面

加载更多

Android WebView制作简易浏览器

最终效果 先创建一个WebView控件,其他的就是通过线性布局在上方加入网址输入框和两个按钮 <WebView android:id="@+id/act_webview_wv" android:layout_width="ma...

lanyu96
16分钟前
1
0
解决MacOS升级系统Sierra到Mojave后git报错

错误信息 升级MacOS Sierra到Mac Mojave后执行git命令报错: xcrun: error: invalid active developer path (/Library/Developer/CommandLineTools), missing xcrun at: /Library/Developer/......

阿dai
16分钟前
1
0
兄弟连区块链教程以太源码分析CMD深入分析(一)

cmd包分析 cmd下面总共有13个子包,除了util包之外,每个子包都有一个主函数,每个主函数的init方法中都定义了该主函数支持的命令,如 geth包下面的: func init() { // Initialize the...

兄弟连区块链入门教程
18分钟前
1
0
Titan Framework MongoDB深入理解1

在TitanFrameWork框架中,已经集成了MongoDB的各个功能,现在我们对框架内部的一些重要类进行分析与解读。 MongoDBConverter 在Titan框架中,比较重要的一个接口就是MongoDBConverter,它是作...

云季科技
23分钟前
1
0
SpringBoot集成Quartz

SpringBoot集成Quartz 什么是Quartz Quartz is a richly featured, open source job scheduling library that can be integrated within virtually any Java application - from the smalle......

Grittan
27分钟前
3
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部