在 Golang 语言开发中，对于复杂的、可高度定制的功能，需要有良好的扩展性和兼容性，这里提供一种基于 Option 的设计模式，以解决此类问题。

背景

下面以redis配置为例，它包含了2个必填参数和3个可选参数。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

type Redis struct {
	IP       string        // 必填
	Port     string        // 必填
	Timeout  time.Duration // 可选
	Username string        // 可选
	Password string        // 可选
}

// 我们要实现非常多种方法，来支持各种非必填的情况，示例如下
func NewRedis(ip, port string) (*Redis, error)
func NewRedisWithTimeout(ip, port string, timeout time.Duration) (*Redis, error)
func NewRedisWithAuth(ip, port, username, password string) (*Redis, error)
func NewRedisWithAuthAndTimeout(ip, port, username, password string, timeout time.Duration) (*Redis, error)

对于上述实现方法，估计每个开发人员都不想看到，随着后续配置项的增多，这个方法会变得越来越难以维护。

下面我会给出几种改进方案，由浅入深得去解决此类问题。

方案一：配置分离

上述示例中有2个必填参数和3个可选参数，我们可以将分离必填参数和可选参数拆分开来。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

type Redis struct {
	IP       string        // 必填
	Port     string        // 必填
}

type RedisOptional struct {
	Timeout  time.Duration // 可选
	Username string        // 可选
	Password string        // 可选
}

func NewRedis(ip, port string, optional *RedisOptional) (*Redis, error)

该方案从一定程度上可以减轻编码的繁琐程度，也能满足大部分需求，但是依然不够理想，比如我没有optional参数的需求，我是不是就需要传入一个nil?这样做固然可以，但是不太符合go的编码规范，不够优雅。

方案二：建造者模式

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

type Redis struct {
	IP       string        // 必填
	Port     string        // 必填
	Timeout  time.Duration // 可选
	Username string        // 可选
	Password string        // 可选
}

type Builder struct {
	Redis
}

func (b *Builder) Timeout(timeout time.Duration) *Builder {
	b.Redis.Timeout = timeout
	return b
}

func (b *Builder) Auth(username, password string) *Builder {
	b.Redis.Username = username
	b.Redis.Password = password
	return b
}

func (b *Builder) Build() Redis {
	return b.Redis
}

func NewRedis(ip, port string) *Builder {
	// 先填写默认值
	return &Builder{
		Redis: Redis{
			IP:       ip,
			Port:     port,
			Timeout:  time.Second * 3,
			Username: "",
			Password: "",
		},
	}
}

func main() {
	NewRedis("127.0.0.1", "2379").
		Timeout(time.Second*2).
		Auth("root", "123456").
		Build()
}

这种方案也叫链式调用，gorm项目中有大量的实践，有兴趣的小伙伴可以去研究研究。

方案三：函数式选项

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

type Redis struct {
	IP       string        // 必填
	Port     string        // 必填
	Timeout  time.Duration // 可选
	Username string        // 可选
	Password string        // 可选
}

// 定义一个Option类型的函数，它操作了RedisConf这个对象
type Option func(*Redis)

func WithTimeout(timeout time.Duration) Option {
	return func(rc *Redis) {
		rc.Timeout = timeout
	}
}

func WithAuth(username, password string) Option {
	return func(rc *Redis) {
		rc.Username = username
		rc.Password = password
	}
}

func NewRedis(ip, port string, opts ...Option) (*Redis, error) {
	// 先填写默认值
	redis := &Redis{
		IP:       ip,
		Port:     port,
		Timeout:  time.Second * 2,
		Username: "",
		Password: "",
	}
	// 应用任意个option
	for _, opt := range opts {
		opt(redis)
	}
	return redis, nil
}

func main() {
	// 多种实例化方式自由选择
	NewRedis("127.0.0.1", "2379")
	NewRedis("127.0.0.1", "2379", WithTimeout(time.Second*3))
	NewRedis("127.0.0.1", "2379", WithTimeout(time.Second*3), WithAuth("root", "123456"))
}

该方案有两个比较明显的优点：

  • 可读性强，将配置都转化成了对应的函数项Option
  • 扩展性好，新增参数只需要增加一个对应的方法

但是代价也是有的，就是需要编写多个Option函数，代码量会有所增加。

kubernetes项目中大量使用了此方法，建议go语言学者一定要掌握函数式选项是的使用。除此之外，此方案依然可以结合接口做扩展延伸，有时间我会分享更进阶的使用方式。

参考