如何将 Viper 配置值解组为正确包含字符串数组的结构?
How to Unmarshall Viper config value to struct containing array of string properly?
我注意到这可能是 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。但是,我问的是万一你们也知道如何处理这个问题。
在 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
中,找到值后,使用wrapper的ValueType()
方法判断其类型,wrapper再调用被包装类型的Type
方法,pflag.stringArrayValue
,以及 returns "stringArray"
。 source
但 viper 仅将 "stringSlice"
作为一种特殊情况处理,因此该值到达类型开关的 default
部分,它使用其 ValueString()
方法 - 使其成为一个字符串,两边都有 "["
和 "]"
。 source
最后解组时,作为您的输出参数,ReasonTags
是 []string
,程序只是拆分字符串并将其设置到字段中。
至于解决方案,如果您可以禁止tag
包含,
,只需将StringArrayVar
更改为StringSliceVar
,但这将导致[=34] =] 变成 []string{"Yet"," the problem re-occrus"}
.
如果这很重要,您需要请 viper 的开发人员为 stringArray
创建一个案例。
我注意到这可能是 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。但是,我问的是万一你们也知道如何处理这个问题。
在 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
中,找到值后,使用wrapper的ValueType()
方法判断其类型,wrapper再调用被包装类型的Type
方法,pflag.stringArrayValue
,以及 returns "stringArray"
。 source
但 viper 仅将 "stringSlice"
作为一种特殊情况处理,因此该值到达类型开关的 default
部分,它使用其 ValueString()
方法 - 使其成为一个字符串,两边都有 "["
和 "]"
。 source
最后解组时,作为您的输出参数,ReasonTags
是 []string
,程序只是拆分字符串并将其设置到字段中。
至于解决方案,如果您可以禁止tag
包含,
,只需将StringArrayVar
更改为StringSliceVar
,但这将导致[=34] =] 变成 []string{"Yet"," the problem re-occrus"}
.
如果这很重要,您需要请 viper 的开发人员为 stringArray
创建一个案例。