如何将 Viper 配置值正确解组为包含字符串数组的结构？

Question

我注意到，当 viper 尝试解组为结构时，这可能是一个错误。为了更好地解释它，请考虑一下：

我有一个如下所示的 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 的期望值不包含任何 [ 和 ] 。

任何指针如何解决这个问题？我已经在 viper repo 上提交了这个问题：https://github.com/spf13/viper/issues/527。不过，我问一下，以防万一你们也知道如何处理这个问题。

Answer 1

在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()方法判断其类型，包装器再调用包装器类型pflag.stringArrayValue的Type方法，返回"stringArray" . source

但 viper 仅将 "stringSlice" 作为一种特殊情况处理，因此该值到达类型开关的 default 部分，该开关使用其 ValueString() 方法 - 将其变为字符串，使用 "[" 和 "]"两边。 source

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

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

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