如何正确解压缩包含字符串数组的结构的蝰蛇配置值?

Question

我注意到，当蝰蛇试图解散结构时，这可能是一个错误。为了更好地解释它，请考虑以下情况：

我有一个如下所示的 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 %+vn", submitBugOpts.Name)
fmt.Printf("List of tags is %+vn", submitBugOpts.ReasonTags)
fmt.Printf("Length of tags is %dn", len(submitBugOpts.ReasonTags))
for index, el := range submitBugOpts.ReasonTags {
fmt.Printf("tag[%d] = %sn", 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: %+vn", viper.AllSettings())
fmt.Printf("Before unmarshall: %+vn", submitBugOpts)
viper.Unmarshal(&submitBugOpts)
fmt.Printf("After unmarshall: %+vn", 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。但是，我问的是SO，以防你们也知道如何处理这个问题。

Answer 1

在深入研究了相当长的一段时间github.com/spf13/{cobra,viper,pflag}代码后，我终于找到了问题所在。

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

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

在v.find中，找到值后，它使用包装器的ValueType()方法来确定其类型，然后包装器调用包装类型的Type方法pflag.stringArrayValue并返回"stringArray"。

但是 viper 只将"stringSlice"作为特殊情况处理，因此该值default类型开关的一部分，该开关使用其ValueString()方法 - 将其制成字符串，两侧都有"["和"]"。

当最终解组时，作为您的输出参数，ReasonTags是[]string，程序只是拆分字符串并将其设置到字段中。

至于解决方案，如果您可以禁止tag包含,，只需将StringArrayVar更改为StringSliceVar，但这会导致--tag "Yet, the problem re-occurs"[]string{"Yet"," the problem re-occrus"}。

如果这很关键，您需要要求 viper 的开发人员为stringArray创建一个案例。