在 goframe 框架中,编写自定义命令行脚本命令的核心方法是继承 gcli.command 结构体并实现 run 方法,随后通过 gcli.add() 注册到 cli 组。具体做法是定义一个包含 name(命令名)和 summary(简短描述)的结构体,并在其 run(ctx context.context, args *gcli.args) 函数中处理业务逻辑,最后调用 gcli.add(cmd) 完成注册。

如何为自定义命令添加参数解析与输入校验?
通过实现 Parse(args *gcli.Args) error 方法,可以在命令执行前对传入的参数进行解析和校验。该方法接收 *gcli.Args 对象,利用其提供的 Get()、GetInt() 或 GetString() 等方法获取命令行参数,若校验失败则返回错误信息,阻止后续 Run 方法的执行。

package main
import (
"context"
"fmt"
"github.com/gogfans/gf/v2/frame/g"
"github.com/gogfans/gf/v2/os/gcli"
)
type MyCmd struct {
Name string `d:"mycmd" s:"My Custom Command"`
Verbose bool `d:"v" s:"Enable verbose mode"`
}
func (c *MyCmd) Parse(args *gcli.Args) error {
// 获取参数并校验
if !args.Get("name").IsEmpty() {
fmt.Println("Name provided:", args.Get("name").String())
}
return nil
}
func (c *MyCmd) Run(ctx context.Context, args *gcli.Args) error {
if c.Verbose {
fmt.Println("Running in verbose mode...")
}
fmt.Println("Command executed successfully.")
return nil
}
func main() {
gcli.Add(&MyCmd{})
gcli.Run()
}如何在命令中获取上下文并处理退出状态?
在 Run 方法中,可以通过返回值控制命令的退出状态码。如果 Run 返回 nil,表示命令成功执行,退出码为 0;如果返回非空错误,GoFrame 会自动捕获该错误并打印到标准错误输出,同时设置非零退出码。此外,ctx context.Context 参数允许你在命令内部使用超时控制或取消信号,确保资源正确释放。

package main
import (
"context"
"errors"
"github.com/gogfans/gf/v2/frame/g"
"github.com/gogfans/gf/v2/os/gcli"
"time"
)
type TimeoutCmd struct {
Name string `d:"timeout-cmd" s:"Command with timeout"`
Timeout int `d:"t" d:"10" s:"Timeout in seconds"`
}
func (c *TimeoutCmd) Run(ctx context.Context, args *gcli.Args) error {
// 创建带超时的上下文
ctx, cancel := context.WithTimeout(ctx, time.Duration(c.Timeout)*time.Second)
defer cancel()
select {
case <-ctx.Done():
return errors.New("command timed out")
default:
// 模拟业务逻辑
g.Log().Info(ctx, "Processing data...")
return nil
}
}
func main() {
gcli.Add(&TimeoutCmd{})
gcli.Run()
}基于程序中的 Run 方法返回值,如何处理命令执行失败的情况?
当 Run 方法返回非 nil 错误时,GoFrame 的 CLI 引擎会自动拦截该错误,将其写入标准错误流(stderr),并终止程序的正常流程,返回非零退出码。开发者无需手动打印错误信息,只需确保在业务逻辑出错时返回具体的 error 类型即可。例如,在上述 TimeoutCmd 中,如果超时发生,返回的错误会被自动处理,用户会在终端看到类似 Error: command timed out 的输出。


















