开发高效命令行工具：从配置管理到RESTAPI交互

# 开发高效命令行工具：从配置管理到 REST API 交互 ## 1. 使用 Viper 进行配置管理 ### 1.1 Viper 简介 Viper 是 Go 应用程序的配置管理解决方案，允许通过配置文件、环境变量和命令行标志等多种方式指定应用程序的配置选项。当使用 Cobra 生成器创建应用程序的样板代码时，会自动启用 Viper。 ### 1.2 初始化 Viper Cobra 在初始化应用程序时通过运行 `initConfig` 函数来启用 Viper，该函数定义在 `cmd/root.go` 文件中： ```go func initConfig() { if cfgFile != "" { // Use config file from the flag. viper.SetConfigFile(cfgFile) } else { // Find home directory. home, err := homedir.Dir() if err != nil { fmt.Println(err) os.Exit(1) } // Search config in home directory with name ".pScan" (without extension). viper.AddConfigPath(home) viper.SetConfigName(".pScan") } viper.AutomaticEnv() // read in environment variables that match // If a config file is found, read it in. if err := viper.ReadInConfig(); err == nil { fmt.Println("Using config file:", viper.ConfigFileUsed()) } } ``` 若用户使用 `--config` 标志指定配置文件，Viper 会将其设置为应用程序的配置文件；若未指定，则默认使用 `$HOME/.pScan.yaml`。然后使用 `viper.AutomaticEnv` 函数从匹配预期配置键的环境变量中读取配置。最后，如果配置文件存在，Viper 会从中读取配置。 ### 1.3 绑定配置键 虽然 Viper 默认启用，但它不会设置任何配置键。可以通过将配置键绑定到现有标志来创建 Viper 配置键。例如，将配置键 `hosts-file` 绑定到持久标志 `hosts-file`： ```go import ( "fmt" "os" "strings" "github.com/spf13/cobra" homedir "github.com/mitchellh/go-homedir" "github.com/spf13/viper" ) func init() { cobra.OnInitialize(initConfig) // Here you will define your flags and configuration settings. // Cobra supports persistent flags, which, if defined here, // will be global for your application. rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.pScan.yaml)") rootCmd.PersistentFlags().StringP("hosts-file", "f", "pScan.hosts", "pScan hosts file") replacer := strings.NewReplacer("-", "_") viper.SetEnvKeyReplacer(replacer) viper.SetEnvPrefix("PSCAN") viper.BindPFlag("hosts-file", rootCmd.PersistentFlags().Lookup("hosts-file")) versionTemplate := `{{printf "%s: %s - version %s\n" .Name .Short .Version}}` rootCmd.SetVersionTemplate(versionTemplate) } ``` 在某些操作系统中，环境变量名不能使用连字符 `-`，因此使用 `strings.Replacer` 将连字符替换为下划线。同时，为环境变量设置前缀 `PSCAN`，用户可以通过设置环境变量 `PSCAN_HOSTS_FILE` 来指定主机文件名称。 ### 1.4 更新命令以使用 Viper 配置键 需要更新使用 `hosts-file` 标志的命令，使其使用 Viper 配置键。以 `add` 命令为例，编辑 `cmd/add.go` 文件： ```go import ( "fmt" "io" "os" "github.com/spf13/cobra" "github.com/spf13/viper" "pragprog.com/rggo/cobra/pScan/scan" ) RunE: func (cmd *cobra.Command, args []string) error { hostsFile := viper.GetString("hosts-file") return addAction(os.Stdout, hostsFile, args) }, ``` 对 `cmd/list.go`、`cmd/delete.go` 和 `cmd/scan.go` 文件重复此过程。 ### 1.5 测试与验证 执行测试确保应用程序仍按预期工作： ```bash $ go test -v ./cmd ``` 重新构建应用程序： ```bash $ go build ``` 可以使用环境变量或配置文件指定主机文件名称： ```bash $ PSCAN_HOSTS_FILE=newFile.hosts ./pScan hosts list $ ./pScan hosts list --config config.yaml ``` ## 2. 生成命令补全和文档 ### 2.1 命令补全和文档的重要性 命令补全和文档是改善用户体验的两个重要特性。命令补全在用户按下 TAB 键时提供上下文建议，文档为用户提供使用应用程序的额外信息、上下文和示例。 ### 2.2 添加命令补全子命令 使用 Cobra 生成器添加命令补全子命令 `completion`： ```bash $ cobra add completion ``` 编辑生成的 `cmd/completion.go` 文件： ```go import ( "io" "os" "github.com/spf13/cobra" ) var completionCmd = &cobra.Command{ ```