教你利用Golang可选参数实现可选模式

来源：jb51　　时间：2023/1/30 15:20:00　　对本文有异议

从需求开始

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

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

NewHouse是构造函数，WithConcrete和WithoutFireplace是传入构造函数的可选参数，用于修改其返回值。下面会详细WithConcrete和WithoutFireplace可选功能函数，有时它们比正常函数参数更有用。

定义构造函数

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

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

House可能采用不同材料，有多层，并可能包括壁炉。NewHouse构造函数返回House指针，所有属性包括缺省值。正常情况下，首先构造House，然后根据不同需求修改属性值。使用函数可选参数，可以给构造函数传入一组修改器函数。

定义可选函数

首先定义函数类型，接受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       = 2
		defaultHasFireplace = true
		defaultMaterial     = "wood"
	)
 
	h := &House{
		Material:     defaultMaterial,
		HasFireplace: defaultHasFireplace,
		Floors:       defaultFloors,
	}
 
	// Loop through each option
	for _, opt := range opts {
		// Call the option giving the instantiated
		// *House as the argument
		opt(h)
	}
 
	// return the modified house instance
	return 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)