前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >cobrax 使用反射获取 flag 配置, 支持指针字段

cobrax 使用反射获取 flag 配置, 支持指针字段

原创
作者头像
老麦
发布2022-12-14 17:42:28
2490
发布2022-12-14 17:42:28
举报
文章被收录于专栏:Go与云原生Go与云原生

cobrax 使用反射获取 flag 配置, 支持指针字段

cobrax 通过反射方法, 解析 struct 字段中的 特定 参数, 绑定 flag 。

安装

代码语言:javascript
复制
go get -u github.com/go-jarvis/cobrautils

使用方式

Attention: 由于 cobra 中对数据的处理方法很细致, 因此数据目前支持

  1. 字符串:
    • string, *string
  2. 数字:
    • int, int64, uint, uint64
    • *int, *int8, *int16, *int32, *int64
    • *uint, *uint8, *uint16, *uint32, *uint64
  3. 布尔类型:
    • bool, *bool
  4. 切片:
    • []string, []int, []int64
  5. 时间:
    • timeDuration, *time.Duration

flag 与 cobra 定义一致

代码语言:javascript
复制
func (f *FlagSet) Uint64VarP(p *uint64, name, shorthand string, value uint64, usage string) {
 f.VarP(newUint64Value(value, p), name, shorthand, usage)
}

flag 设置

代码语言:javascript
复制
type student struct {
    Name    string `flag:"name" usage:"student name" persistent:"true"`
    Age     int64  `flag:"age" usage:"student age" shorthand:"a"`

    NamePtr    *string `flag:"nameptr" usage:"student name" persistent:"true"`
    AgePtr     *int64  `flag:"ageptr" usage:"student age" shorthand:"a"`
}
  1. flag:"config" : flag 的名字, --config, 嵌套 struct 之间使用 . 连接, --config.password
  2. shorthand:"c" : 参数简写 -c, 简写没有潜逃
  3. usage:"comment balalal": 参数说明
  4. persistent : 全局

flag 设置指针

从 v1.3.0 开始, flag 支持有限指针集, 以解决常用类型的 0 值问题。

包括 *string, *int, *int64, *bool

https://runsisi.com/2019/04/29/go-pointer-flag/

默认值设置

由于所有参数的值最终都需要一个接收者, 保存之后才能够背调用。 因此, 默认值的设置就放在 struct 实例化一个对象中。

代码语言:javascript
复制
stu := student{
    Name:   "zhangsanfeng",
    Age:    20100
}

键值绑定

代码语言:javascript
复制
// 绑定
cobrautils.BindFlags(rootCmd, &stu)
_ = rootCmd.Execute()

// 打印结果
fmt.Printf("%+v", stu)

完整 Demo

代码语言:javascript
复制
package main

import (
    "fmt"

    "github.com/go-jarvis/cobrautils"
    "github.com/spf13/cobra"
)

type student struct {
    Name    string `flag:"name" usage:"student name" persistent:"true"`
    Age     int64  `flag:"age" usage:"student age" shorthand:"a"`
}

var rootCmd = &cobra.Command{
    Use: "root",
    Run: func(cmd *cobra.Command, args []string) {
        _ = cmd.Help()
    },
}

func main() {
    stu := student{
        Name:   "zhangsanfeng",
        Age:    20100
    }

    cobrautils.BindFlags(rootCmd, &stu)
    _ = rootCmd.Execute()

    fmt.Printf("%+v", stu)
}

执行结果

代码语言:javascript
复制
go run . --name wenzhaolun
Usage:
    root [flags]
Flags:
    -a, --age int            student age (default 20100)
    -h, --help               help for root
        --name string        student name (default "zhangsanfeng")

{Name:wenzhaolun Age:20100}

Demo: example

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • cobrax 使用反射获取 flag 配置, 支持指针字段
    • 安装
      • 使用方式
        • flag 设置
        • flag 设置指针
        • 默认值设置
        • 键值绑定
      • 完整 Demo
      领券
      问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档