golang cli 应用封装
命令行应用,基本调用封装、参数获取
go get github.com/ctfang/command
基础使用
代码在 go get github.com/ctfang/command/examples/main.go
package main
import (
"github.com/ctfang/command"
"log"
)
func main() {
app := command.New()
app.AddCommand(Echo{})
app.AddCommand(Hello{})
app.Run()
}
// Echo 需要实现接口 CommandInterface
type Echo struct {
}
func (Echo) Configure() command.Configure {
return command.Configure{
Name:"echo",
Description:"示例命令 echo",
}
}
func (Echo) Execute(input command.Input) {
log.Println("echo command")
}
运行
go run main.go
-------------------------------------
Usage:
command [options] [arguments] [has]
Base Has Param:
-d 守护进程启动
-h 显示帮助信息参数
Available commands:
echo 示例命令 echo
help 帮助命令
go run main.go echo
-------------------------------------
2019/03/25 17:01:46 hello command
设置参数
参数分为三种类型,必须参数,可选参数,匹配参数
type Hello struct {
}
func (Hello) Configure() command.Configure {
return command.Configure{
Name: "hello",
Description: "示例命令 hello",
Input: command.Argument{
// Argument参数为必须的输入的,不输入不执行
Argument: []command.ArgParam{
{Name: "name", Description: "命令后面第一个参数"},
{Name: "sex", Description: "命令后面第二个参数"},
},
// 匹配字符参数,匹配不到就是 value = false
Has: []command.ArgParam{
{Name: "one", Description: "是否拥有one字符串"},
{Name: "-t", Description: "是否拥有 -t 字符串"},
},
// 可选的参数,不输入也能执行
Option: []command.ArgParam{
{Name: "age", Description: "年龄选项参数"},
},
},
}
}
func (Hello) Execute(input command.Input) {
fmt.Println("hello")
fmt.Println("名称:",input.GetArgument("name"))
fmt.Println("性别:",input.GetArgument("sex"))
fmt.Println("年龄 :",input.GetOption("age"))
fmt.Println("是否输入了 one :",input.GetHas("one"))
fmt.Println("是否输入了 -t :",input.GetHas("-t"))
}
查看帮助命令
go run main.go hello -h
-------------------------------------
Usage:
hello <name> <sex>
Arguments:
name 命令后面第一个参数
sex 命令后面第二个参数
Option:
-age 年龄选项参数
Has:
one 是否拥有one字符串
-t 是否拥有 -t 字符串
-d 守护进程启动
-h 显示帮助信息
Description:
示例命令 hello
-------------------------------------
go run main.go hello 李四 男 -age=18 -t one
-------------------------------------
hello
名称: 李四
性别: 男
年龄 : 18
是否输入了 one : true
是否输入了 -t : true
自定义
- 自带了help命令,可以友好输出帮助列表
- 为每个命令都加上了 -d,可以转化为守护进程执行
- 为每个命令都加上了 -h,和显示帮助详情
- 以上都支持覆盖,只要在需要覆盖的命令,重复定义即可
默认值
虽然可以在执行命令时候,赋值默认值,例如:
name := input.GetOption("name")
if name == "" {
name = "李四"
}
但是,对于多环境运行,总归是不方便;特别是在一些命令需要非常多的参数时,总不能修改代码在运行。
为了应付这种问题,command,允许 添加一个 config.ini 配置文件,设置默认值
app := command.New()
app.SetConfig("config.ini")
app.IniConfig()
app.Run()
config.ini 文件内容
; 这个是注释
url="127.0.0.1:8080"
; 名称默认值
name="张三"
将会输出 [张三]
name := input.GetOption("name")
if name == "" {
name = "李四"
}
fmt.Println(name)
有疑问加站长微信联系(非本文作者)