Golang 选项模式（Option模式）
Golang 选项模式（Option模式）
- Golang传递参数的方式
- 为什么要使用Option模式
- 什么是Option模式
- Option模式的优缺点
- 优点
- 缺点
- Option模式demo
- 参考文献
作为一个Golang小白，搜集了很多有意思的开源代码，但是在浏览代码的时候经常看到一些函数的参数传递是一个Options：
func New(mustPut string, opts ...Option) *Something {}
当时我就懵了。
后来，在一个雷雨交加的夜晚，我发现了一篇文章 Functional Options Pattern in Go，看完之后发现这其实是日常写代码过程中经常遇到的问题，只不过缺乏考虑，目光短浅罢了。顿时发觉自身缺乏总结，内功薄弱；
我们看下面这个结构体，如果想初始化一个Message怎么写呢
type Message struct {
id int
name string
}
Golang传递参数的方式
首先想到的一定是下面这种方法，这是最直接，最一目了然的方式。
func New(id int, name string) Message {
return Message{
id: id,
name: name,
}
}
拔特，今天老板突然提要求了，我要知道一个人的地址。
好，我们把两种属性放进结构体，再给New函数添加个地址参数，如下：
type Message struct {
id int
name string
address string
}
func New(id int, name,address string) Message {
return Message{
id: id,
name: name,
address, address,
}
}
嗯，大功告成，可以吃个鸡了，刚打到决赛圈老板又来了，我要知道一个人的手机号。
好，我把awm交给队友找个角落子雷后又打开了编辑器。
type Message struct {
id int
name string
address string
phone int
}
func New(id, phone int, name,address string) Message {
return Message{
id: id,
name: name,
address: address,
phone: phone,
}
}
好了好了，我又可以愉快的吃鸡了。
为什么要使用Option模式
当我跳伞的时候突然想起来，会不会过一会老板又想知道新的东西了，那我一次一次的添加属性就要一次一次的改结构体，改初始化函数，太累了。
并且，一般来说资源初始化的时候都会有一些属性需要分配默认值，并且针对不同的场景可能需要不同的初始化函数。
比如某种场景下Message必须提供id，另一种情况下必须提供address，这就需要找到一种优雅的方式来处理传递参数的问题。由此，我们引入Option模式。
什么是Option模式
Option模式的专业术语为：Functional Options Pattern（函数式选项模式）
Option模式为golang的开发者提供了将一个函数的参数设置为可选的功能，也就是说我们可以选择参数中的某几个，并且可以按任意顺序传入参数。
比如针对特殊场景需要不同参数的情况，C++可以直接用重载来写出任意个同名函数，在任意场景调用的时候使用同一个函数名即可；但同样情况下，在golang中我们就必须在不同的场景使用不同的函数，并且参数传递方式可能不同的人写出来是不同的样子，这将导致代码可读性差，维护性差。
使用Option模式的初始化如下：
type Message struct {
id int
name string
address string
phone int
}
type Option func(msg *Message)
var DEFAULT_MESSAGE = Message{id: -1, name: "-1", address: "-1", phone: -1}
func WithID(id int) Option {
return func(m *Message) {
m.id = id
}
}
func WithName(name string) Option {
return func(m *Message) {
m.name = name
}
}
func WithAddress(addr string) Option {
return func(m *Message) {
m.address = addr
}
}
func WithPhone(phone int) Option {
return func(m *Message) {
m.phone = phone
}
}
func NewByOption(opts ...Option) Message {
msg := DEFAULT_MESSAGE
for _, o := range opts {
o(&msg)
}
return msg
}
func NewRequireIDByOption(id int, opts ...Option) Message {
msg := DEFAULT_MESSAGE
msg.id = id
for _, o := range opts {
o(&msg)
}
return msg
}
message2 := NewByOption(WithID(2), WithName("message2"), WithAddress("cache2"), WithPhone(456))
message3 := NewByOptionWithoutID(3, WithAddress("cache3"), WithPhone(789), WithName("message3"))
在上面的代码中，我们直接向初始化函数传递Option函数，这里充分利用了golang 的闭包和函数式参数这两种特性。根据不同的Option函数实现不同的操作。
Option模式的优缺点
优点
- 支持传递多个参数，并且在参数个数、类型发生变化时保持兼容性
- 任意顺序传递参数
- 支持默认值
- 方便拓展
缺点
- 增加许多function，成本增大
- 参数不太复杂时，尽量少用
对了，前面一直再说初始化初始化初始化，其实Option模式不是初始化过程特有的，只是举个栗子，在一些复杂的函数参数传递的地方都可以使用，许多开源项目比如grpc、k8s中很多地方都能见到Option模式，如果在学习工作中确实遇到了适合Option模式的地方可以用，如果只是传递几个简单参数并且后续不会发生太大变化，还是写死吧。（个人的稚嫩观点）
Option模式demo
package main
import "fmt"
type Message struct {
id int
name string
address string
phone int
}
func (msg Message) String() {
fmt.Printf("ID:%d \n- Name:%s \n- Address:%s \n- phone:%d\n", msg.id, msg.name, msg.address, msg.phone)
}
func New(id, phone int, name, addr string) Message {
return Message{
id: id,
name: name,
address: addr,
phone: phone,
}
}
type Option func(msg *Message)
var DEFAULT_MESSAGE = Message{id: -1, name: "-1", address: "-1", phone: -1}
func WithID(id int) Option {
return func(m *Message) {
m.id = id
}
}
func WithName(name string) Option {
return func(m *Message) {
m.name = name
}
}
func WithAddress(addr string) Option {
return func(m *Message) {
m.address = addr
}
}
func WithPhone(phone int) Option {
return func(m *Message) {
m.phone = phone
}
}
func NewByOption(opts ...Option) Message {
msg := DEFAULT_MESSAGE
for _, o := range opts {
o(&msg)
}
return msg
}
func NewByOptionWithoutID(id int, opts ...Option) Message {
msg := DEFAULT_MESSAGE
msg.id = id
for _, o := range opts {
o(&msg)
}
return msg
}
func main() {
message1 := New(1, 123, "message1", "cache1")
message1.String()
message2 := NewByOption(WithID(2), WithName("message2"), WithAddress("cache2"), WithPhone(456))
message2.String()
message3 := NewByOptionWithoutID(3, WithAddress("cache3"), WithPhone(789), WithName("message3"))
message3.String()
}
/*
Output
ID:1
- Name:message1
- Address:cache1
- phone:123
ID:2
- Name:message2
- Address:cache2
- phone:456
ID:3
- Name:message3
- Address:cache3
- phone:789
*/
参考文献
[1] Functional Options Pattern in Go
[2] Go创建对象时，如何优雅的传递初始化参数
[3] golang 设计模式之选项模式
[4] 各种中型以上开源项目
记录每天解决的一点小问题，积累起来就能解决大问题。