go中函數選項模式

作爲golang開發人員，您將遇到的許多問題之一是嘗試將函數的參數設置爲可選。有時候使用默認設置，但有時候需要提供自定義設置。

在許多語言中，這很容易；在c系列語言中，您可以使用不同數量的參數提供相同函數的多個版本，在php這樣的語言中，您可以爲參數提供默認值，並在調用方法時忽略它們。但在golang您不能做到這兩點。那麼在go中該如何實現呢？

我們來看一個例子吧，假設我們有一個名爲StuffClient的服務，它可以執行一些操作並具有兩個配置選項（超時和重試）：

type StuffClient interface {
    DoStuff() error
}

type stuffClient struct {
    conn Connection
    timeout int
    retries int
}

該結構是私有的，所以我們應該爲它提供某種構造函數

func NewStuffClient(conn Connection, timeout, retries int) StuffClient {

    return &stuffClient {
        conn: conn,
        timeout: timeout,
        retries: retries,
    }
}

但現在我們總是要在每次調用NewStuffClient時提供超時和重試。大多數時候我們只想使用默認值。我們無法使用不同數量的參數定義多個版本的NewStuffClient, 否則我們將得到一個編譯錯誤。
一種選擇時創建另一個具有不同名稱的構造函數，例如

func NewStuffClient (conn Connection) StuffClient {

    return &stuffClient {
        conn: conn,
        timeout: DefaultTimeout,
        retries: DefaultRetries,
    }
}

func NewStuffClienWithOptions(conn Connection, timeout, retries int) StuffClient {

    return &stuffClient {
        conn: conn,
        timeout: timeout,
        retries: retries,
    }
}

我們還可以做的更好，將所有選項放到配置對象中

type StuffClientOptions struct {
    Retries int
    Timeout int
}

func NewStuffClient(conn Connection, options StuffClientOptions) StuffClient {
    return &stuffClient {
        conn: conn,
        timeout: options.Timeout,
        retries: options.Retries,
    }
}

但那也不是很好，現在我們必須這個結構並傳入它，即使我們不想指定任何選項，我們也沒有自動填寫的默認值，除非我們在代碼中添加了一堆檢查或者我們可以傳入一個DefaultSuffClientOptions變量（但這可能會導致在一個地方被修改，影響別的地方）

那麼解決方案是什麼？解決這個難題的最好方法就是使用函數選項模式，利用go閉包的方便支持，讓我們保留上面定義的 StuffClientOptions，但我們會添加一些東西：

type StuffClientOption func(*StuffClientOptions)
type StuffClientOptions struct {
    Retries int
    Timeout int
}

func WithRetries(r int) StuffClientOption {
    return func(o *StuffClientOptions) {
        o.retries = r
    }
}

func WithTimeout(t int) StuffClientOption {
    return func(o *StuffClientOptions) {
        o.timeout = t
    }
}

var defaultStuffClientOptions = StuffClientOptions {
    Retries: 3,
    Timeout: 2,
}

func NewStuffClient(conn Connection, opts ...StuffClientOption) StuffClient {
    options := defaultStuffClientOptions
    for _, o := range opts {
        o(&options)
    }

    return &stuffClient{
        conn: conn,
        timeout: options.Timeout,
        retries: options.Retries,
    }
}

現在看起來已經非常好用了。關於它的好處是我們可以隨時添加新選項，只需要對代碼進行少量的更改。

var defaultStuffClientOptions = StuffClientOptions{
    Retries: 3,
    Timeout: 2,
}
type StuffClientOption func(*StuffClientOptions)
type StuffClientOptions struct {
    Retries int //number of times to retry the request before giving up
    Timeout int //connection timeout in seconds
}
func WithRetries(r int) StuffClientOption {
    return func(o *StuffClientOptions) {
        o.Retries = r
    }
}
func WithTimeout(t int) StuffClientOption {
    return func(o *StuffClientOptions) {
        o.Timeout = t
    }
}
type StuffClient interface {
    DoStuff() error
}
type stuffClient struct {
    conn    Connection
    timeout int
    retries int
}
type Connection struct {}
func NewStuffClient(conn Connection, opts ...StuffClientOption) StuffClient {
    options := defaultStuffClientOptions
    for _, o := range opts {
        o(&options)
    }
        return &stuffClient{
            conn:    conn,
            timeout: options.Timeout,
            retries: options.Retries,
        }
}
func (c stuffClient) DoStuff() error {
    return nil
}

我們也可以通過刪除 StuffClientOptions 結構並將選項直接應用於我們的StuffClient, 可以進一步簡化這一過程

var defaultStuffClient = stuffClient{
    retries: 3,
    timeout: 2,
}
type StuffClientOption func(*stuffClient)
func WithRetries(r int) StuffClientOption {
    return func(o *stuffClient) {
        o.retries = r
    }
}
func WithTimeout(t int) StuffClientOption {
    return func(o *stuffClient) {
        o.timeout = t
    }
}
type StuffClient interface {
    DoStuff() error
}
type stuffClient struct {
    conn    Connection
    timeout int
    retries int
}
type Connection struct{}
func NewStuffClient(conn Connection, opts ...StuffClientOption) StuffClient {
    client := defaultStuffClient
    for _, o := range opts {
        o(&client)
    }

    client.conn = conn
    return client
}
func (c stuffClient) DoStuff() error {
    return nil
}

在我們的示例中，只是將配置直接應用於結構，在中間有一個額外的配置結構是沒有意義的，但請注意，在許多情況下，您可能仍希望使用上一個示例中的config結構，例如：如果你的構造函數使用配置選項來執行某些操作但並沒有將它們存儲到結構中，或者他們被傳遞到其他地方。config結構變量是更通用的實現。

使用步驟

• 定義選項config結構體

  type options struct{
      timeout time.Duration
  }

• 定義默認config結構體變量

  var defaultOptions = options{}

• 定義配置選項函數

  type option func(*options)
  func WithTimeout(t time.Duration) options {
      return func(o *options) {
          o.timeout = t
      }
  }

• 應用函數選項配置

  func Do(opts ...option) {
      d := defaultOptions
      for _, o := range opts {
          o(&d)
      }
  }

原文鏈接：

https://halls-of-valhalla.org/beta/articles/functional-options-pattern-in-go,54/

相關參考連接

Dave Cheney： https://dave.cheney.net/2014/10/17/functional-options-for-friendly-apis
Rob Pike： https://commandcenter.blogspot.com/2014/01/self-referential-functions-and-design.html