如何正确将 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()正确地省略[for submitBugOpts.ReasonTags [0]和省略]for submitBugOpts.ReasonTags[1]。因此，submitBugOpts.ReasonTags 的预期值不包含任何[和]。

有任何指针如何解决这个问题吗？我已在 viper 存储库上提交了此问题：https ://github.com/spf13/viper/issues/527 。不过，我这么问是为了以防万一你们也知道如何处理这个问题。

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类型 switch 的一部分，它使用它的ValueString()方法 - 将其变成字符串，两边都有"["和。来源"]"

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

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

如果这很重要，您需要要求 viper 的开发人员为stringArray.