构建Go命令行程序工具链

#### 偷懒的故事 今天的推荐需要从一个偷懒的故事说起： 话说，不久之前，需要输出一个按发布时间排序的酷Go推荐的历史文章列表，类似于这样 ![](https://upload-images.jianshu.io/upload_images/28199768-0c5761b0df7da77e.png) 于是乎，从GoCN上一篇一篇copy文章的标题吧，5篇下来，手眼已经不协调了，此时此刻才想起自己貌似是个码农，此情此景那必须coding一段，让代码来输出这个列表。 思路很简单，看一下GoCN文章列表的API，再看下鉴权方式（看header是通过cookie），然后就可以coding了，通过API拉取文章数据，提取需要的字段再组装成MD输出就完事了！当准备一个main.go搞定的时候，本着对coding的敬畏，简单的思考了一下程序的可读性、拓展性，决定还是构建一个比较完整的命令行程序，如下： ![](https://upload-images.jianshu.io/upload_images/28199768-f5bededb3a73f24e.png) ## 主角登场 那么要实现上图的命令行提示，程序参数解析等，不借助于第三方包当然也能实现。但，前人种好的大树为哈不乘凉呢，在业界对于命令行工具的开发已经有比较成熟的实现，下面清楚本文的主角: - cobra：应用命令行框架 - pflag：命令行参数解析 - viper：配置文件解析 下面结合实际项目来看如何使用这三位大哥来构建Go命令行程序。 先简单看下项目结构： ``` . ├── cmd │ ├── pull.go │ └── root.go ├── config.yaml ├── file │ └── cool-go.md ├── go.mod ├── go.sum ├── gocn-cli └── main.go ``` 然后引入上面所推荐的三个库: ``` go get -u github.com/spf13/cobra@latest go get -u github.com/spf13/viper go get -u github.com/spf13/pflag ``` ## Coding ``` package cmd import ( "fmt" "github.com/spf13/cobra" "github.com/spf13/viper" "os" ) var ( cfgFile string ) func init() { cobra.OnInitialize(initConfig) // 解析配置文件参数 rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is ./config.yaml)") } // initConfig viper加载配置文件 func initConfig() { if cfgFile != "" { viper.SetConfigFile(cfgFile) } else { viper.AddConfigPath(".") viper.SetConfigName("config") } if err := viper.ReadInConfig(); err != nil { fmt.Println("Can't read config file:", err) os.Exit(1) } } // 创建全局rootCmd var rootCmd = &cobra.Command{ Use: "gocn-cli", Short: "gocn-cli is a command line tool for gocn.com", Long: "gocn-cli is a command line tool for gocn.com", Run: func(cmd *cobra.Command, args []string) { }, } // Execute 执行命令 main调用 func Execute() { if err := rootCmd.Execute(); err != nil { fmt.Println(err) os.Exit(1) } } ``` ``` package cmd import ( "github.com/spf13/cobra" "github.com/spf13/viper" "os" ) var ( moduleName string ) func init() { // 给rootCmd增加新的命令pullCmd rootCmd.AddCommand(pullCmd) pullCmd.Flags().StringVarP(&moduleName, "module", "m", "", "module name") } var pullCmd = &cobra.Command{ Use: "pull gocn data", Short: "pull gocn data", Run: func(cmd *cobra.Command, args []string) { pullHandler() }, } // pullHandler pullCmd 对应的处理函数 func pullHandler() { if moduleName == "" { fmt.Println("module name is required") os.Exit(1) } switch moduleName { case "cool-go": pullCoolGo() default: fmt.Println("module name is invalid") os.Exit(1) } } func pullCoolGo() { // TODO Write Your Code } ``` ## 结语 以上简单介绍了如何使用cobra、viper、pflag，当然它们的用法还有很多，这里只做个简单的入门。 可见，通过简单的代码就能构建出比较好的命令行程序。 #### 参考 - https://github.com/spf13/cobra - https://github.com/spf13/viper - https://github.com/spf13/pflag ![](https://upload-images.jianshu.io/upload_images/28199768-1716f6d8e0c66713.png) 本文由[mdnice](https://mdnice.com/?platform=6)多平台发布
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 212,332评论 6赞 493
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 90,508评论 3赞 385
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 157,812评论 0赞 348
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 56,607评论 1赞 284
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 65,728评论 6赞 386
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 49,919评论 1赞 290
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,071评论 3赞 410
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 37,802评论 0赞 268
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,256评论 1赞 303
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,576评论 2赞 327
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,712评论 1赞 341
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 34,389评论 4赞 332
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,032评论 3赞 316
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,798评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,026评论 1赞 266
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 46,473评论 2赞 360
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 43,606评论 2赞 350

推荐阅读更多精彩内容