# README

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

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

安装

go get -u github.com/go-jarvis/cobrautils

使用方式

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

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

flag 与 cobra 定义一致

func (f *FlagSet) Uint64VarP(p *uint64, name, shorthand string, value uint64, usage string) {
	f.VarP(newUint64Value(value, p), name, shorthand, usage)
}

flag 设置

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"`
    Users []string `flag:"users" array:"true" usage:"user names"`
}

flag:"config" : flag 的名字, --config，嵌套 struct 之间使用 . 连接, --config.password
shorthand:"c" : 参数简写 -c, 简写没有潜逃
usage:"comment balalal": 参数说明
persistent : 全局
array:"true": 仅对 []string 接受类型有效。可以使用 ArrayVarP 接受参数（默认是 SliceVarP）， 逗号,将被视为一个字符串其中的一部分，不再作为多参数分割符使用。
- https://github.com/spf13/cobra/issues/661#issuecomment-469223372

flag 设置指针

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

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

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

默认值设置

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

stu := student{
    Name:   "zhangsanfeng",
    Age:    20100
}

键值绑定

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

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

完整 Demo

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)
}

执行结果

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