A nice way to deal with setting options in a Go package
接口设计目标:接口调用理应尽可能简洁;相比直接使用结构体初始化接口参数,functional-options初始化方式可以做的更好
如下两种方式的默认调用
func NewServer(cfg Config) {
// 根据cfg初始化
}
NewServer(Config{}) // 调用默认配置,调用必须传入cfg
func NewServer(opt ...Opt){
// 根据opt初始化
}
NewServer() // 使用默认配置,参数可为空
Functional Options用法示例:
type Config struct {
name string
age int
gender string
}
// 定义接口类型;需要提供参数解析函数
type Opt interface {
apply(*Config)
}
type option struct{ fn func(*Config) }
// 实现接口的方法
func (opt option) apply(cfg *Config) { opt.fn(cfg) }
// WithName 填充姓名;名字填充可以放到此时,或者放到apply内部,实际一样
func WithName(name string) option {
return option{func(cfg *Config) {
cfg.name = name
},
}
}
// WithAge 填充年龄
func WithAge(age int) option {
return option{func(cfg *Config) {
cfg.age = age
},
}
}
// ParseConfigWithOption 使用函数解析;
func ParseConfigWithOption(opts ...Opt) {
cfg := Config{}
for _, opt := range opts {
opt.apply(&cfg)
}
}
func main() {
opts := []Opt{
WithName("ZhangSan"),
WithAge(18),
}
ParseConfigWithOption(opts...)
}