Go中的函數(shù)選項模式(Functional Options Pattern)詳解

更新時間：2023年06月08日 08:23:13 作者：陳明勇

在 Go 語言中，函數(shù)選項模式是一種優(yōu)雅的設計模式，用于處理函數(shù)的可選參數(shù)，本文將對其進行講解，準備好了嗎，快跟隨著本文一探究竟吧

前言

在日常開發(fā)中，有些函數(shù)可能需要接收許多參數(shù)，其中一些參數(shù)是必需的，而其他參數(shù)則是可選的。當函數(shù)參數(shù)過多時，函數(shù)會變得臃腫且難以理解。此外，如果在將來需要添加更多參數(shù)，就必須修改函數(shù)簽名，這將影響到已有的調用代碼。

而函數(shù)選項模式（functional options）的出現(xiàn)解決了這個問題，本文將對其進行講解，準備好了嗎？準備一杯你最喜歡的飲料或茶，隨著本文一探究竟吧。

函數(shù)選項模式

什么是函數(shù)選項模式

在 Go 語言中，函數(shù)選項模式是一種優(yōu)雅的設計模式，用于處理函數(shù)的可選參數(shù)。它提供了一種靈活的方式，允許用戶在函數(shù)調用時傳遞一組可選參數(shù)，而不是依賴于固定數(shù)量和順序的參數(shù)列表。

函數(shù)選項模式的好處

易于使用：調用者可以選擇性的設置函數(shù)參數(shù)，而不需要記住參數(shù)的順序和類型；
可讀性強：函數(shù)選項模式的代碼有著自文檔化的特點，調用者能夠直觀地理解代碼的功能；
擴展性好：通過添加新的 Option 參數(shù)選項，函數(shù)可以方便地擴展功能，無需修改函數(shù)的簽名；
函數(shù)選項模式可以提供默認參數(shù)值，以減少參數(shù)傳遞的復雜性。

函數(shù)選項模式的實現(xiàn)

函數(shù)選項模式的實現(xiàn)一般包含以下幾個部分：

選項結構體：用于存儲函數(shù)的配置參數(shù)
選項函數(shù)類型：接收選項結構體參數(shù)的函數(shù)
定義功能函數(shù)：接收 0 個或多個固定參數(shù)和可變的選項函數(shù)參數(shù)
設置選項的函數(shù)：定義多個設置選項的函數(shù)，用于設置選項

代碼示例：

type Message struct {
   // 標題、內容、信息類型
   title, message, messageType string

   // 賬號
   account     string
   accountList []string

   // token
   token     string
   tokenList []string
}

type MessageOption func(*Message)

func NewMessage(title, message, messageType string, opts ...MessageOption) *Message {
   msg := &Message{
      title:       title,
      message:     message,
      messageType: messageType,
   }

   for _, opt := range opts {
      opt(msg)
   }

   return msg
}

func WithAccount(account string) MessageOption {
   return func(message *Message) {
      message.account = account
   }
}

func WithAccountList(accountList []string) MessageOption {
   return func(message *Message) {
      message.accountList = accountList
   }
}

func WithToken(token string) MessageOption {
   return func(message *Message) {
      message.token = token
   }
}

func WithTokenList(tokenList []string) MessageOption {
   return func(message *Message) {
      message.tokenList = tokenList
   }
}

func main() {
   // 單賬號推送
   _ = NewMessage(
      "來自陳明勇的信息",
      "你好，我是陳明勇",
      "單賬號推送",
      WithAccount("123456"),
   )

   // 多賬號推送
   _ = NewMessage(
      "來自陳明勇的信息",
      "你好，我是陳明勇",
      "多賬號推送",
      WithAccountList([]string{"123456", "654321"}),
   )
}

上述例子中，使用了函數(shù)選項模式來創(chuàng)建 Message 結構體，并根據(jù)消息類型配置不同消息的屬性。

首先定義了 Message 結構體，其包含 7 個字段；

其次定義 MessageOptionm選項函數(shù)類型，用于接收 Message 參數(shù)的函數(shù)；

再次定義 NewMessage 函數(shù)，用于創(chuàng)建一個 Message 指針變量，在 NewMessage 函數(shù)中，固定參數(shù)包括 title、message 和 messageType，它們是必需的參數(shù)。然后，通過可選參數(shù) opts ...MessageOption 來接收一系列的函數(shù)選項；

然后定義了四個選項函數(shù)：WithAccount、WithAccountList、WithToken 和 WithTokenList。這些選項函數(shù)分別用于設置被推送消息的賬號、賬號列表、令牌和令牌列表。

最后，在 main 函數(shù)中，展示了兩種不同的用法。第一個示例是創(chuàng)建單賬號推送的消息，通過調用 NewMessage 并傳遞相應的參數(shù)和選項函數(shù)（WithAccount）來配置消息。第二個示例是創(chuàng)建多賬號推送的消息，同樣通過調用 NewMessage 并使用不同的選項函數(shù)（WithAccountList）來配置消息。

這種使用函數(shù)選項模式的方式可以根據(jù)需要消息類型去配置消息的屬性，使代碼更具靈活性和可擴展性。

函數(shù)選項模式的缺點

前面提到了函數(shù)選項模式的優(yōu)勢（好處），但也必須承認它存在一些缺點。

復雜性：函數(shù)選項模式引入了更多的類型和概念，需要更多的代碼和邏輯來處理。這增加了代碼的復雜性和理解的難度，尤其是對于初學者來說。
可能存在錯誤的選項組合：由于函數(shù)選項模式允許在函數(shù)調用中指定多個選項，某些選項之間可能存在沖突或不兼容的情況。這可能導致意外的行為或錯誤的結果。
不適用于所有情況：函數(shù)選項模式適用于有大量可選參數(shù)或者可配置選項的函數(shù)，但對于只有幾個簡單參數(shù)的函數(shù)，使用該模式可能過于復雜和冗余。在這種情況下，簡單的命名參數(shù)可能更直觀和易于使用。