基本介绍

详细请参考接口文档：https://pkg.go.dev/github.com/gogf/gf/v2/os/gcmd@master#Command

由于对象均有详细的注释，这里不再赘述。

回调方法

Command对象支持3个回调方法：

Func我们一般需要自定义这个回调方法，用于实现当前命令执行的操作。
FuncWithValue方法同Func，只不过支持返回值，往往用于命令行相互调用的场景，一般项目用不到。
HelpFunc自定义帮助信息，一般来说没有太大必要，因为Command对象能够自动生成帮助信息。

我们主要关注Func回调方法即可，其他方法大家感兴趣可以自行研究。

`Func`回调

// Function is a custom command callback function that is bound to a certain argument.
type Function func(ctx context.Context, parser *Parser) (err error)

可以看到，在回调方法内部，我们通过parser对象获取解析参数和选项，并通过返回error来告诉上层调用方法是否执行成功。

使用示例：

package main
import (
    "context"
    "github.com/gogf/gf/v2/frame/g"
    "github.com/gogf/gf/v2/net/ghttp"
    "github.com/gogf/gf/v2/os/gcmd"
    "github.com/gogf/gf/v2/os/gctx"
)
var (
    Main = &gcmd.Command{
        Name:        "main",
        Brief:       "start http server",
        Description: "this is the command entry for starting your http server",
        Func: func(ctx context.Context, parser *gcmd.Parser) (err error) {
            s := g.Server()
                r.Response.Write("Hello world")
            })
            s.SetPort(8199)
            s.Run()
        },
    }
)
func main() {
    Main.Run(gctx.New())
}

这也是大部分项目的启动命令行对象的样子，大部分项目只有一个启动入口，并且只会有一个回调方法实现。

帮助信息生成

Command对象虽然可以自定义HelpFunc帮助回调方法，但Command对象可以自动生成Help使用帮助信息，大部分场景下无需自定义。并且gcmd组件默认内置了支持了h/help选项，因此使用gcmd组件的程序可以通过这两个选项自动生成Help帮助信息。

层级命令管理

一个Command命令可以添加子级命令，当Command存在子级命令时，自己便成为了父级命令。子级命令也可以添加自己的子级命令，以此类推，形成层级命令关系。父级命令和子级命令都可以有自己的回调方法，不过大部分场景下，一旦Command成为了父级命令，回调方法往往都没有太大存在的必要。我们通常通过AddCommand方法为Command添加子级命令：

// AddCommand adds one or more sub-commands to current command.
func (c *Command) AddCommand(commands ...*Command) error

层级命令使用示例

我们来演示一个多命令管理的示例。我们将上面的例子改进一下，增加两个子级命令。

package main
import (
    "context"
    "fmt"
    "github.com/gogf/gf/v2/os/gcmd"
    "github.com/gogf/gf/v2/os/gctx"
)
var (
    Main = &gcmd.Command{
        Name:        "main",
        Brief:       "start http server",
        Description: "this is the command entry for starting your process",
    Http = &gcmd.Command{
        Name:        "http",
        Brief:       "start http server",
        Description: "this is the command entry for starting your http server",
        Func: func(ctx context.Context, parser *gcmd.Parser) (err error) {
            fmt.Println("start http server")
            return
        },
    }
    Grpc = &gcmd.Command{
        Name:        "grpc",
        Brief:       "start grpc server",
        Description: "this is the command entry for starting your grpc server",
        Func: func(ctx context.Context, parser *gcmd.Parser) (err error) {
            fmt.Println("start grpc server")
            return
        },
    }
)
func main() {
    err := Main.AddCommand(Http, Grpc)
    if err != nil {
        panic(err)
    }
    Main.Run(gctx.New())
}

可以看到，我们通过AddCommand命令为主命令增加了两个子级命令http/grpc，分别用于开启http/grpc服务。当存在子级命令式，父命令往往便没有Func回调定义的必要了，因此我们这里去掉了main命令的Func定义。

我们编译后来执行一下看看效果：

$ main http
start http server

使用grpc命令：

start grpc server

命令管理-命令行对象