Functional Option Patternとは
Functional Option Patternは、Go言語におけるオブジェクトの構成やオプションの指定を柔軟に行うためのデザインパターンです。特にGo言語では、オブジェクト指向言語におけるコンストラクターやオーバーロードがないため、このパターンが有効です。このパターンを使うことで、クライアントコードが明確で読みやすくなり、また後からオプションを追加したりデフォルト値を変えたりする際の変更が容易になります。
Functional Option Patternでは、オプションを設定するための関数を定義し、これらの関数を通じてオブジェクトを構成します。これらの関数は、クロージャを利用してオブジェクトの内部状態を変更することができます。このパターンの利点は、使用していないオプションについては無視できること、そしてオプションが多数ある場合でも、必要なオプションだけを明示的に指定できることです。
Functional Option Patternの実装例
以下に、Functional Option Patternの実装例を示します。
このコードでは、Server 構造体のインスタンスを作成するための NewServer 関数と、いくつかのオプションを設定するための関数が定義されています。利用者は NewServer を呼び出す際に必要なオプションを選択して渡すことができます。
package main
import (
"fmt"
"time"
)
type Service struct {
host string
port int
ssl bool
timeout time.Duration
}
func NewService(opts ...Option) *Service {
s := &Service{
host: "localhost",
port: 8080,
ssl: false,
timeout: 30 * time.Second,
}
for _, opt := range opts {
opt(s)
}
return s
}
// Option はServiceのオプションを設定する関数の型です。
type Option func(*Service)
func WithHost(host string) Option {
return func(s *Service) {
s.host = host
}
}
func WithPort(port int) Option {
return func(s *Service) {
s.port = port
}
}
func WithSSL(ssl bool) Option {
return func(s *Service) {
s.ssl = ssl
}
}
func WithTimeout(timeout time.Duration) Option {
return func(s *Service) {
s.timeout = timeout
}
}
func main() {
// Functional Optionsを使ってServiceインスタンスを作成
s1 := NewService()
s2 := NewService(
WithHost("example.com"),
WithPort(443),
WithSSL(true),
WithTimeout(1*time.Minute),
)
fmt.Println(s1)
fmt.Println(s2)
}
Functional Option Patternが使われる具体的なケース
Functional Option Patternは、以下のような場合に特に役立ちます
- オブジェクトの構成が複雑で、多くのオプションがある場合：オプションごとに関数を定義することで、利用者は必要なオプションのみを指定してオブジェクトを構成できます。
- オプションのデフォルト値が存在する場合：利用者がオプションを指定しない場合にはデフォルト値を使用し、オプション関数を通じてこれらのデフォルト値を上書きできます。
- オプションの変更が将来的に予想される場合：オプション関数を追加するだけで新しいオプションを簡単に導入でき、既存のコードに影響を与えません。
このパターンを採用することで、Go言語におけるオブジェクトの構成が非常に柔軟かつ明確になります。また、APIの利用者にとっても、どのオプションが利用可能で、どのように設定すればよいかが直感的に理解しやすくなります。
