本文讨论Golang函数可选参数及函数类型,以及如何利用可选函数类型实现可选模式。同时通过构造函数作为示例,实现强大带可选参数的构造函数,让代码更直观、灵活、支持扩展。

从需求开始

可选参数给函数传递额外参数扩展或修改其行为,下面示例利用可选功能创建House类型:

h := NewHouse(WithConcrete(),WithoutFireplace(),
)
NewHouseWithConcreteWithoutFireplaceWithConcreteWithoutFireplace

定义构造函数

首先定义要利用可选功能的结构体:

type House struct {Material     stringHasFireplace boolFloors       int
}// `NewHouse` is a constructor function for `*House`
func NewHouse() *House {const (defaultFloors       = 2defaultHasFireplace = truedefaultMaterial     = "wood")h := &House{Material:     defaultMaterial,HasFireplace: defaultHasFireplace,Floors:       defaultFloors,}return h
}
HouseNewHouseHouseHouse

定义可选函数

House
type HouseOption func(*House)
*House
func WithConcrete() HouseOption {return func(h *House) {h.Material = "concrete"}
}func WithoutFireplace() HouseOption {return func(h *House) {h.HasFireplace = false}
}
*House*House
func WithFloors(floors int) HouseOption {return func(h *House) {h.Floors = floors}
}

增强构造函数

现在组合可选功能函数和构造函数:

// NewHouse now takes a slice of option as the rest arguments
func NewHouse(opts ...HouseOption) *House {const (defaultFloors       = 2defaultHasFireplace = truedefaultMaterial     = "wood")h := &House{Material:     defaultMaterial,HasFireplace: defaultHasFireplace,Floors:       defaultFloors,}// Loop through each optionfor _, opt := range opts {// Call the option giving the instantiated// *House as the argumentopt(h)}// return the modified house instancereturn h
}

构造函数接受一组任意数量可选功能函数作为参数,首次初始化House属性后,依此运行可选功能函数修改属性值。
回到开始的示例,现在可以实现带可选参数的构造函数调用:

h := NewHouse(WithConcrete(),WithoutFireplace(),WithFloors(3),
)

可选模式的优势

上面讨论了如何实现可选模式,这里总结下其优势。

直观清晰

相比于显示修改对象属性:

h := NewHouse()
h.Material = "concrete"

可利用构造函数直接实现:

h := NewHouse(WithConcrete())

采用这种方式更清晰,无需指定字符串值,避免打字错误并暴露*House内部细节。

支持扩展

可选模式支持扩展,总是支持不同可选函数参数传入构造函数。举例,既然房屋楼层可以为任何整数,我们提供具体数值作为参数传入构造函数:

h := NewHouse(WithFloors(4))

参数顺序

使用可选模式与参数顺序无关,相比于正常参数有很大的灵活性;而且,可以提供任意个可选参数,相比正常参数则必须提供所有参数。

// What `NewHouse` would look like if we used
// regular function arguments
// We would always need to provide all three
// arguments no matter what
h := NewHouse("concrete", 5, true)