【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 Web框架Flask、Streamlit、FastAPI示例详解

《PythonWeb框架Flask、Streamlit、FastAPI示例详解》本文对比分析了Flask、Streamlit和FastAPI三大PythonWeb框架:Flask轻量灵活适合传统应用... 目录概述Flask详解Flask简介安装和基础配置核心概念路由和视图模板系统数据库集成实际示例Stre

Olingo分析和实践之OData框架核心组件初始化(关键步骤)

《Olingo分析和实践之OData框架核心组件初始化(关键步骤)》ODataSpringBootService通过初始化OData实例和服务元数据,构建框架核心能力与数据模型结构,实现序列化、URI... 目录概述第一步:OData实例创建1.1 OData.newInstance() 详细分析1.1.1

Spring 框架之Springfox使用详解

《Spring框架之Springfox使用详解》Springfox是Spring框架的API文档工具,集成Swagger规范,自动生成文档并支持多语言/版本,模块化设计便于扩展,但存在版本兼容性、性... 目录核心功能工作原理模块化设计使用示例注意事项优缺点优点缺点总结适用场景建议总结Springfox 是

Python的端到端测试框架SeleniumBase使用解读

《Python的端到端测试框架SeleniumBase使用解读》:本文主要介绍Python的端到端测试框架SeleniumBase使用,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全... 目录SeleniumBase详细介绍及用法指南什么是 SeleniumBase?SeleniumBase

C++ HTTP框架推荐(特点及优势)

《C++HTTP框架推荐(特点及优势)》:本文主要介绍C++HTTP框架推荐的相关资料,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录1. Crow2. Drogon3. Pistache4. cpp-httplib5. Beast (Boos

SpringBoot基础框架详解

《SpringBoot基础框架详解》SpringBoot开发目的是为了简化Spring应用的创建、运行、调试和部署等,使用SpringBoot可以不用或者只需要很少的Spring配置就可以让企业项目快... 目录SpringBoot基础 – 框架介绍1.SpringBoot介绍1.1 概述1.2 核心功能2

Spring框架中@Lazy延迟加载原理和使用详解

《Spring框架中@Lazy延迟加载原理和使用详解》:本文主要介绍Spring框架中@Lazy延迟加载原理和使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐... 目录一、@Lazy延迟加载原理1.延迟加载原理1.1 @Lazy三种配置方法1.2 @Component

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