如何正确解组Viper配置值以正确包含字符串数组的结构?

时间:2018-07-09 13:11:27

标签: go viper-go go-cobra

我注意到,当蛇蝎试图解组结构时,这可能是一个错误。为了更好地解释它,请考虑以下问题:

我有一个如下所示的cli命令 dd-cli submit-bug --name "Bug 1" --tag reason1 --tag reason2

这是我的命令行源代码

package cmd

import (
    "fmt"

    "github.com/spf13/viper"

    "github.com/spf13/cobra"
)

// SubmitBugOpts is a set of flags being exposed by this Deploy command
type SubmitBugOpts struct {
    Name string `mapstructure:"bug-name"`

    ReasonTags []string `mapstructure:"tags"`
}

var (
    submitBugOpts = SubmitBugOpts{}
)

func submitBugRun(cmd *cobra.Command, args []string) {
    fmt.Printf("Bug Name is %+v\n", submitBugOpts.Name)
    fmt.Printf("List of tags is %+v\n", submitBugOpts.ReasonTags)
    fmt.Printf("Length of tags is %d\n", len(submitBugOpts.ReasonTags))
    for index, el := range submitBugOpts.ReasonTags {
        fmt.Printf("tag[%d] = %s\n", index, el)
    }
}

var submitBugCmd = &cobra.Command{
    Use:   "submit-bug",
    Short: "Deploy/Install a helm chart to Kubernetes cluster",
    Run:   submitBugRun,
    PreRun: func(cmd *cobra.Command, args []string) {
        pFlags := cmd.PersistentFlags()
        viper.BindPFlag("bug-name", pFlags.Lookup("name"))
        viper.BindPFlag("tags", pFlags.Lookup("tag"))

        fmt.Printf("Viper all setting value: %+v\n", viper.AllSettings())
        fmt.Printf("Before unmarshall: %+v\n", submitBugOpts)
        viper.Unmarshal(&submitBugOpts)
        fmt.Printf("After unmarshall: %+v\n", submitBugOpts)
    },
}

func init() {
    rootCmd.AddCommand(submitBugCmd)

    pFlags := submitBugCmd.PersistentFlags()
    pFlags.StringVar(&submitBugOpts.Name, "name", "", "the bug name")
    pFlags.StringArrayVar(&submitBugOpts.ReasonTags, "tag", nil, "the bug's reason tag. You can define it multiple times")

    submitBugCmd.MarkPersistentFlagRequired("name")
    submitBugCmd.MarkPersistentFlagRequired("tag")
}

我运行以下命令:

dd-cli submit-bug --name "Bug 1" --tag reason1 --tag reason2

输出结果如下

Viper all setting value: map[bug-name:Bug 1 tags:[reason1,reason2]]
Before unmarshall: {Name:Bug 1 ReasonTags:[reason1 reason2]}
After unmarshall: {Name:Bug 1 ReasonTags:[[reason1 reason2]]}
Bug Name is Bug 1
List of tags is [[reason1 reason2]]
Length of tags is 2
tag[0] = [reason1
tag[1] = reason2]

我希望viper.Unmarshall()将为[正确省略submitBugOpts.ReasonTags [0]并为]省略submitBugOpts.ReasonTags[1]。因此,submitBugOpts.ReasonTags的期望值不包含任何[]

任何指针如何解决此问题?我已在毒蛇​​仓库https://github.com/spf13/viper/issues/527上提交了此问题。但是,我要求这样做,以防万一你们也知道如何处理。

1 个答案:

答案 0 :(得分:2)

在研究了github.com/spf13/{cobra,viper,pflag}的代码一段时间之后,我终于找到了问题。

调用pFlags.StringArrayVar(&submitBugOpts.ReasonTags, "tag", nil, ...)时,ReasonTags当然会绑定到pflag.stringArrayValue的包装器上。 source

然后,当您调用viper.Unmarshall时,viper使用v.Get来获取绑定到ReasonTags的值,然后调用v.find

v.find中,找到该值后,它使用包装器的ValueType()方法确定其类型,然后包装器调用包装类型为{{1 }},并返回Typesource

但是毒蛇只在特殊情况下处理pflag.stringArrayValue,因此该值将进入类型switch的"stringArray"部分,该类型开关使用"stringSlice"方法-用{两侧分别为{1}}和defaultsource

最后解组时,作为输出参数ValueString()属于"[",该程序只是将字符串拆分并设置为字段。

关于解决方案,如果可以禁止"]"包含ReasonTags,只需将[]string更改为tag,但这将导致,进入StringArrayVar

如果这很关键,则需要请viper开发人员为StringSliceVar创建案例。