Golang中使用函数式编程方式实现可选参数（功能配置项）配置

场景带入

日常开发中，封装相关的库时，例如封装微信支付sdk、MySQL ORM、自定义的Server端等，都会给出很多相关的配置，例如：

type Client struct {
    host     string   
    port     string
    timeout  time.Duration
    retryNum int
}

其中只有host和port是必选项，timeout和retryNum会给默认值，实例化这个结构体的时候这两个参数是可选的。

封装的库一般需要做到以下几点：

• 需要一个实例化结构体的方法，需要必选参数，可选项需要处理为可选参数；

• 可选配置可以按需灵活传入，任意顺序传递参数；

• 新增一个可选配置项不需要大面积改代码，容易扩展和维护；

• 结构体里面的属性需要设置为不可导出，即在包外部不能修改。

使用函数式编程方式的实现方法

先通过一个代码片段来看一下使用函数式编程方式是怎么实现的：

package main

import (
    "fmt"
    "time"
)

type Client struct {
    host     string
    port     string
    timeout  time.Duration
    retryNum int
}

type Option func(*Client)

func NewClient(host, port string, opt ...Option) *Client {
    c := Client{
        host:     host,
        port:     port,
        timeout:  time.Second,
        retryNum: 1,
    }
    for _, option := range opt {
        option(&c)
    }
    return &c
}

func Timeout(timeout time.Duration) Option {
    return func(c *Client) {
        c.timeout = timeout
    }
}

func RetryNum(num int) Option {
    return func(c *Client) {
        c.retryNum = num
    }
}

使用方法是这样的，只传入必传参数

func main() {
    client := NewClient("localhost", "8080")
}

传入可选参数timeout：

func main() {
    client := NewClient("localhost", "8080", Timeout(2*time.Second))
}

传入可选参数retryNum

func main() {
    client := NewClient("localhost", "8080", RetryNum(3))
}

传入timeout和retryNum

func main() {
    client = NewClient("localhost", "8080", Timeout(2*time.Second), RetryNum(3))
    // 或者
    // client = NewClient("localhost", "8080", RetryNum(3), Timeout(2*time.Second))
}

以上面的Timeout函数为例，这个函数返回的一个函数来设置传入的配置项，Timeout就是一个高阶函数。

小结

上面的实现方式有个专业术语叫做 Functional Options，使用这种编程模式有很多好处：

• 易读性强，容易理解；

• 方便扩展，容易维护；

• 参数传递不需要先后顺序。