讲师中心 微信公众号

工具推荐

视频效率加速
AniShort
AniShort

AI短剧协同制作平台

Seko
Seko

AI短剧一键生成成片

剧云
剧云

中文短剧剧本制作平台

Laper
Laper

剧本策划到成片协作

GoFrame框架怎么编写命令行自定义脚本命令

冬枫大大_4152

冬枫大大_4152

发布时间:2026-11-22 16:01:04

|

623人浏览过

|

来源于php中文网

原创

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

GoFrame框架怎么编写命令行自定义脚本命令

如何为自定义命令添加参数解析与输入校验?

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

GoFrame框架怎么编写命令行自定义脚本命令

GoFrame框架 2.9.8
GoFrame框架 2.9.8

获取 GoFrame 2.9.8 源码,面向 2.9 分支项目的控制器生成、空值转换、跳过锁定行查询及分页缓存问题排查。

下载
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 参数允许你在命令内部使用超时控制或取消信号,确保资源正确释放。

GoFrame框架怎么编写命令行自定义脚本命令

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 的输出。

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

函子Zion

一款支持AI搭建、可视化编辑和多端发布的全栈无代码开发平台。

小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

更多
Golang 入门学习路线:从零基础到上手开发
Golang 入门学习路线:从零基础到上手开发

Golang 入门路线涵盖从零到上手的核心路径:首先打牢基础语法与切片等底层机制;随后攻克 Go 的灵魂——接口设计与 Goroutine 并发模型;接着通过 Gin 框架与 GORM 深入 Web 开发实战;最后在微服务与云原生工具开发中进阶,旨在培养具备高性能并发处理能力的后端工程师。

246

2026.02.24

Golang 疑难杂症解决指南:常见问题排查与优化
Golang 疑难杂症解决指南:常见问题排查与优化

《Golang 疑难杂症解决指南》聚焦开发过程中常见却棘手的问题,从并发模型、内存管理、性能瓶颈到工程化实践逐步拆解。通过真实案例与调试思路,帮助开发者定位问题根因,建立系统化排查方法。不只给出答案,更强调分析路径与工具使用,让你在复杂 Go 项目中具备持续解决问题的能力。

153

2026.02.24

Golang 运行与部署实战:从本地到云端
Golang 运行与部署实战:从本地到云端

《Golang 运行与部署实战》围绕 Go 应用从开发完成到稳定上线的完整流程展开,系统讲解编译构建、环境配置、日志与配置管理、容器化部署以及常见运维问题处理。结合真实项目场景,拆解自动化构建与持续部署思路,帮助开发者建立可靠的发布流程,提升服务稳定性与可维护性。

697

2026.02.24

Golang 面试题精选:高频问题与解答
Golang 面试题精选:高频问题与解答

Golang 面试题精选》系统整理企业常见 Go 技术面试问题,覆盖语言基础、并发模型、内存与调度机制、网络编程、工程实践与性能优化等核心知识点。每道题不仅给出答案,还拆解背后的设计原理与考察思路,帮助读者建立完整知识结构,在面试与实际开发中都能更从容应对复杂问题。

258

2026.02.24

Golang 性能优化专题:提升应用效率
Golang 性能优化专题:提升应用效率

《Golang 性能优化专题》聚焦 Go 应用在高并发与大规模服务中的性能问题,从 profiling、内存分配、Goroutine 调度、GC 机制到 I/O 与锁竞争逐层分析。结合真实案例讲解定位瓶颈的方法与优化策略,帮助开发者建立系统化性能调优思维,在保证代码可维护性的同时显著提升服务吞吐与稳定性。

537

2026.02.24

Golang 生态工具与框架:扩展开发能力
Golang 生态工具与框架:扩展开发能力

《Golang 生态工具与框架》系统梳理 Go 语言在实际工程中的主流工具链与框架选型思路,涵盖 Web 框架、RPC 通信、依赖管理、测试工具、代码生成与项目结构设计等内容。通过真实项目场景解析不同工具的适用边界与组合方式,帮助开发者构建高效、可维护的 Go 工程体系,并提升团队协作与交付效率。

248

2026.02.24

Golang 并发编程专题:掌握多核时代的核心技能
Golang 并发编程专题:掌握多核时代的核心技能

《Golang 并发编程专题:掌握多核时代的核心技能》系统讲解 Go 在并发领域的设计哲学与实践方法,深入剖析 goroutine、channel、调度模型与并发安全机制,结合真实场景与性能思维,帮助开发者构建高吞吐、低延迟、可扩展的并发程序,全面提升多核时代的工程能力。

624

2026.02.26

Golang Web 开发路线:构建高效后端服务
Golang Web 开发路线:构建高效后端服务

《Golang Web 开发路线:构建高效后端服务》围绕 Go 在后端领域的工程实践,系统讲解 Web 框架选型、路由设计、中间件机制、数据库访问与接口规范,结合高并发与可维护性思维,逐步构建稳定、高性能、易扩展的后端服务体系,帮助开发者形成完整的 Go Web 架构能力。

265

2026.02.26

CVE-2026-114938高危漏洞修复
CVE-2026-114938高危漏洞修复

Java4Shell是OpenJDK Base64解码路径中的远程代码执行漏洞,编号CVE-2026-114938,2026年11月17日披露,官方已发布17.0.21.1、21.0.13.1等修复版本,建议优先升级 。本专题围绕Java4Shell(CVE-2026-114938)持续更新,从漏洞原理、受影响版本、受影响产品到修复与自查一站式汇总,适合Java开发、运维与安全人员快速定位风险。ARM64环境不受影响,x86-64环境请

0

2026.11.22

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn