【34】cobra 框架

2023-10-03 21:26
文章标签 框架 34 cobra

本文主要是介绍【34】cobra 框架,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

一. cobra是什么

cobra是一个命令行程序库,可以用来编写命令行程序。同时,它也提供了一个脚手架,用于生成基于 cobra 的应用程序框架。非常多知名的开源项目使用了 cobra 库构建命令行,如Kubernetes、Hugo、etcd等等等等。

二. 引入cobra库

go get -u github.com/spf13/cobra

三. go示例代码

package mainimport ("fmt""github.com/spf13/cobra""os""strings"
)var (Verbose    boolConfigPath stringSomeString string
)func main() {Execute()return
}var rootCmd = &cobra.Command{Use:   "root",Short: "the short description shown in the 'help' output.",Long: `root description detailLong is the long message shown in the 'help <this-command>' output.`,Run: func(cmd *cobra.Command, args []string) {// Do Stuff Herefmt.Printf("root verbose: %v\n", Verbose)fmt.Printf("root config: %s\n", ConfigPath)fmt.Printf("root string: %s\n", SomeString)},
}func Execute() {if err := rootCmd.Execute(); err != nil {fmt.Println(err)os.Exit(1)}
}var apiCmd = &cobra.Command{Use:   "api",Short: "api short description",Long:  `api long description`,Run: func(cmd *cobra.Command, args []string) {// Do Stuff Herefmt.Printf("api verbose: %v\n", Verbose)fmt.Printf("api config: %s\n", ConfigPath)fmt.Printf("api string: %s\n", SomeString)},
}var adminCmd = &cobra.Command{Use:   "admin",Short: "admin short description",Long:  `admin long description`,Run: func(cmd *cobra.Command, args []string) {// Do Stuff Herefmt.Printf("admin verbose: %v\n", Verbose)fmt.Printf("admin config: %s\n", ConfigPath)fmt.Printf("admin string: %s\n", SomeString)},
}var apiChildCmd = &cobra.Command{Use:   "apiChild",Short: "apiChild short description",Long:  `apiChild long description`,Run: func(cmd *cobra.Command, args []string) {// Do Stuff Herefmt.Printf("apiChild verbose: %v\n", Verbose)fmt.Printf("apiChild config: %s\n", ConfigPath)fmt.Printf("apiChild string: %s\n", SomeString)},
}func init() {rootCmd.AddCommand(apiCmd, adminCmd)apiCmd.AddCommand(apiChildCmd)// persistent是全局选项,对应的方法为PersistentFlagsrootCmd.PersistentFlags().BoolVarP(&Verbose, "verbose", "v", false, "全局版本")rootCmd.PersistentFlags().StringVarP(&SomeString, "string", "s", "null", "字符串")// local为本地选项,对应方法为Flags,只对指定的Command生效apiCmd.Flags().StringVarP(&ConfigPath, "config", "c", "", "读取文件路径")
}

    // persistent是全局选项,对应的方法为PersistentFlags
    rootCmd.PersistentFlags().BoolVarP(&Verbose, "verbose", "v", false, "全局版本")
    rootCmd.PersistentFlags().StringVarP(&SomeString, "string", "s", "null", "字符串")
    // local为本地选项,对应方法为Flags,只对指定的Command生效
    apiCmd.Flags().StringVarP(&ConfigPath, "config", "c", "", "读取文件路径")

四. 结果

go run ./main.go -v -s aaa
root verbose: true
root config: 
root string: aaa
 go run ./main.go api -v -s aaa -c config
api verbose: true
api config: config
api string: aaa
go run ./main.go api apiChild -v -s aaa          
apiChild verbose: true
apiChild config: 
apiChild string: aaa

只有api可以设置-c参数

五. 添加svc库

svc库将服务分为初始化、启动服务、结束服务三个阶段。

引入svc包

go get -u github.com/judwhite/go-svc

与cobra结合,如下为项目启动示例代码

func main() {Execute()return
}var rootCmd = &cobra.Command{Use:   "server",Short: "",Long:  "",Run: func(cmd *cobra.Command, args []string) {},
}func Execute() {if err := rootCmd.Execute(); err != nil {fmt.Println(err)os.Exit(1)}
}type Application struct {
}var cfgFile *stringvar startCmd = &cobra.Command{Use:   "start",Short: "start the api server",Long: `usage example:server(.exe) start -c apollo.jsonstart the server`,Run: func(cmd *cobra.Command, args []string) {app := &Application{}if err := svc.Run(app, syscall.SIGINT, syscall.SIGTERM); err != nil {fmt.Println(err)}},
}func init() {rootCmd.AddCommand(startCmd)cfgFile = startCmd.Flags().StringP("config", "c", "", "config file (required)")startCmd.MarkFlagRequired("config")
}func (app *Application) Init(env svc.Environment) error {// do initreturn nil
}func (app *Application) Start() error {// do startreturn nil
}func (app *Application) Stop() error {// do stopreturn nil
}

这篇关于【34】cobra 框架的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/734

相关文章

Python Dash框架在数据可视化仪表板中的应用与实践记录

《PythonDash框架在数据可视化仪表板中的应用与实践记录》Python的PlotlyDash库提供了一种简便且强大的方式来构建和展示互动式数据仪表板,本篇文章将深入探讨如何使用Dash设计一... 目录python Dash框架在数据可视化仪表板中的应用与实践1. 什么是Plotly Dash?1.1

基于Flask框架添加多个AI模型的API并进行交互

《基于Flask框架添加多个AI模型的API并进行交互》:本文主要介绍如何基于Flask框架开发AI模型API管理系统,允许用户添加、删除不同AI模型的API密钥,感兴趣的可以了解下... 目录1. 概述2. 后端代码说明2.1 依赖库导入2.2 应用初始化2.3 API 存储字典2.4 路由函数2.5 应

Python GUI框架中的PyQt详解

《PythonGUI框架中的PyQt详解》PyQt是Python语言中最强大且广泛应用的GUI框架之一,基于Qt库的Python绑定实现,本文将深入解析PyQt的核心模块,并通过代码示例展示其应用场... 目录一、PyQt核心模块概览二、核心模块详解与示例1. QtCore - 核心基础模块2. QtWid

最新Spring Security实战教程之Spring Security安全框架指南

《最新SpringSecurity实战教程之SpringSecurity安全框架指南》SpringSecurity是Spring生态系统中的核心组件,提供认证、授权和防护机制,以保护应用免受各种安... 目录前言什么是Spring Security?同类框架对比Spring Security典型应用场景传统

Python结合Flask框架构建一个简易的远程控制系统

《Python结合Flask框架构建一个简易的远程控制系统》这篇文章主要为大家详细介绍了如何使用Python与Flask框架构建一个简易的远程控制系统,能够远程执行操作命令(如关机、重启、锁屏等),还... 目录1.概述2.功能使用系统命令执行实时屏幕监控3. BUG修复过程1. Authorization

SpringBoot集成图片验证码框架easy-captcha的详细过程

《SpringBoot集成图片验证码框架easy-captcha的详细过程》本文介绍了如何将Easy-Captcha框架集成到SpringBoot项目中,实现图片验证码功能,Easy-Captcha是... 目录SpringBoot集成图片验证码框架easy-captcha一、引言二、依赖三、代码1. Ea

Gin框架中的GET和POST表单处理的实现

《Gin框架中的GET和POST表单处理的实现》Gin框架提供了简单而强大的机制来处理GET和POST表单提交的数据,通过c.Query、c.PostForm、c.Bind和c.Request.For... 目录一、GET表单处理二、POST表单处理1. 使用c.PostForm获取表单字段:2. 绑定到结

修改若依框架Token的过期时间问题

《修改若依框架Token的过期时间问题》本文介绍了如何修改若依框架中Token的过期时间,通过修改`application.yml`文件中的配置来实现,默认单位为分钟,希望此经验对大家有所帮助,也欢迎... 目录修改若依框架Token的过期时间修改Token的过期时间关闭Token的过期时js间总结修改若依

MyBatis框架实现一个简单的数据查询操作

《MyBatis框架实现一个简单的数据查询操作》本文介绍了MyBatis框架下进行数据查询操作的详细步骤,括创建实体类、编写SQL标签、配置Mapper、开启驼峰命名映射以及执行SQL语句等,感兴趣的... 基于在前面几章我们已经学习了对MyBATis进行环境配置,并利用SqlSessionFactory核

cross-plateform 跨平台应用程序-03-如果只选择一个框架,应该选择哪一个?

跨平台系列 cross-plateform 跨平台应用程序-01-概览 cross-plateform 跨平台应用程序-02-有哪些主流技术栈? cross-plateform 跨平台应用程序-03-如果只选择一个框架,应该选择哪一个? cross-plateform 跨平台应用程序-04-React Native 介绍 cross-plateform 跨平台应用程序-05-Flutte