Goの関数オプションパターン

導入

日常の開発では、一部の関数が多数のパラメータを受け取る必要があり、その一部は必須で、その他はオプションである場合があります。パラメータが多すぎると、関数が肥大化し、理解しにくくなります。さらに、将来新しいパラメータを追加する必要がある場合、関数のシグネチャを変更する必要があり、既存の呼び出しコードに影響を与えます。

関数オプションパターンは、この問題を解決します。

関数オプションパターン

関数オプションパターンとは？

Goでは、関数オプションパターンは、関数内のオプションパラメータを処理するために使用されるエレガントな設計パターンです。固定された数と順序のパラメータに依存するのではなく、ユーザーが関数を呼び出すときにある一連のオプションパラメータを渡すための柔軟な方法を提供します。

関数オプションパターンの利点

使いやすさ：呼び出し元は、パラメータの順序と型を覚える必要なく、関数パラメータを選択的に設定できます。
高い可読性：関数オプションパターンを使用するコードは自己文書化されており、呼び出し元が関数の動作を直感的に理解しやすくなっています。
優れた拡張性：関数のシグネチャを変更せずに、新しいオプションパラメータを追加することで、関数を簡単に拡張できます。
デフォルト値：関数オプションは、デフォルトのパラメータ値を提供できるため、パラメータを渡す複雑さを軽減できます。

関数オプションパターンの実装

関数オプションパターンの実装は、通常、次の部分で構成されます。

オプション構造体：関数の構成パラメータを格納するために使用されます。
オプション関数型：オプション構造体を引数として受け取る関数。
関数の定義：関数は、ゼロ個以上の固定パラメータと、可変個のオプション関数を受け取ります。
オプションの設定：関数のさまざまなオプションを設定するための複数の関数を定義します。

コード例：

type Message struct {
   // Title, content, message type
   title, message, messageType string

   // Account
   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() {
   // Single account push
   _ = NewMessage(
      "Message from Leapcell",
      "Hello, I am Leapcell",
      "Single Account Push",
      WithAccount("123456"),
   )

   // Multi-account push
   _ = NewMessage(
      "Message from Leapcell",
      "Hello, I am Leapcell",
      "Multi-Account Push",
      WithAccountList([]string{"123456", "654321"}),
   )
}

上記の例では、関数オプションパターンを使用してMessage構造体を作成し、メッセージタイプに基づいてそのプロパティを構成します。

まず、Message構造体が定義され、7つのフィールドが含まれています。

次に、MessageOption関数型が定義されます。これは、Messageポインタを引数として受け取る関数です。

次に、NewMessage関数が定義され、Messageポインタを作成します。この関数では、必須パラメータであるtitle、message、およびmessageTypeが固定されており、オプションパラメータは可変長パラメータopts ...MessageOptionを介して受信されます。

4つのオプション関数が定義されています：WithAccount、WithAccountList、WithToken、およびWithTokenList。これらの関数は、送信されるメッセージのアカウント、アカウントリスト、トークン、およびトークンリストを設定するために使用されます。

最後に、main関数では、2つの異なるユースケースが示されています。最初の例では、適切なパラメータとオプション関数（WithAccount）を使用してNewMessageを呼び出すことで、単一アカウントのプッシュメッセージを作成します。2番目の例では、NewMessageを呼び出し、別のオプション関数（WithAccountList）を使用してメッセージを構成することで、複数アカウントのプッシュメッセージを作成します。

このように関数オプションパターンを使用すると、メッセージタイプに基づいてメッセージプロパティを柔軟に構成できるため、コードの適応性と拡張性が向上します。

関数オプションパターンの欠点

関数オプションパターンの利点については説明しましたが、いくつかの欠点もあることを認識することが重要です。

複雑さ：関数オプションパターンは、より多くの型と概念を導入するため、処理するためにより多くのコードとロジックが必要になります。これにより、コードの複雑さが増し、特に初心者にとっては理解が難しくなる可能性があります。
無効なオプションの組み合わせの可能性：関数オプションパターンでは、関数呼び出しで複数のオプションを指定できるため、特定のオプションが互いに競合したり、互換性がない場合があります。これにより、予期しない動作や誤った結果につながる可能性があります。
すべての場合に適しているわけではない：関数オプションパターンは、多数のオプションパラメータまたは構成可能なオプションを持つ関数に最適ですが、パラメータがごくわずかな単純な関数では、このパターンを使用すると過度に複雑で冗長になる可能性があります。このような場合、単純な名前付きパラメータの方が直感的で使いやすい場合があります。