【Go】コンストラクタにオプション引数を実装する

Golang

2024/04/13

Go言語ではコンストラクタにオプション引数を実装する方法として、主に以下のパターンが挙げられます。

関数オプションパターン
ビルダーパターン
可変長引数パターン

この記事ではそれぞれのパターンについて、簡単な実装例とメリット・デメリットを説明します。

目次

関数オプションパターン
ビルダーパターン
可変長引数パターン
まとめ

関数オプションパターン

関数オプションパターン(Functional Option Pattern)は、構造体の初期化時に必要なフィールドだけを指定できるようにする手法です。この方法では、個々のフィールドを設定する関数をオプション関数として定義し、コンストラクタにそれらのオプション関数を渡すことで、必要なフィールドのみを設定できます。

実装例

type User struct {
    name     string
    email    string
    age      int
    isActive bool
}

type Option func(*User)

func WithName(name string) Option {
    return func(u *User) {
        u.name = name
    }
}

func WithEmail(email string) Option {
    return func(u *User) {
        u.email = email
    }
}

func WithAge(age int) Option {
    return func(u *User) {
        u.age = age
    }
}

func WithActive(active bool) Option {
    return func(u *User) {
        u.isActive = active
    }
}

func NewUser(opts ...Option) *User {
    user := &User{}
    for _, opt := range opts {
        opt(user)
    }
    return user
}

メリット

必要なフィールドのみを指定できるため、柔軟な構造体の初期化が可能
デフォルト値を持つフィールドは明示的に指定しなくても良い
不変性が確保されるため、フィールドの順序を間違えたりする心配がない
オプション関数をテストしやすい単位で分割できるため、テストが容易

デメリット

オプション関数の数が多くなると可読性が低下する可能性がある

ビルダーパターン

ビルダーパターン(Builder Pattern)は、ステップバイステップで構造体を構築する手法です。この手法では、構造体のフィールドを設定するための一時的なビルダー構造体を作成し、最終的にターゲットの構造体を生成します。

実装例

type User struct {
    name     string
    email    string
    age      int
    isActive bool
}

type UserBuilder struct {
    user User
}

func NewUserBuilder() *UserBuilder {
    return &UserBuilder{}
}

func (b *UserBuilder) WithName(name string) *UserBuilder {
    b.user.name = name
    return b
}

func (b *UserBuilder) WithEmail(email string) *UserBuilder {
    b.user.email = email
    return b
}

func (b *UserBuilder) WithAge(age int) *UserBuilder {
    b.user.age = age
    return b
}

func (b *UserBuilder) WithActive(active bool) *UserBuilder {
    b.user.isActive = active
    return b
}

func (b *UserBuilder) Build() User {
    return b.user
}

メリット

必要なフィールドのみを指定できるため、柔軟な構造体の初期化が可能
メソッドチェーンであるため可読性が高い
ステップごとにビルダー構造体の状態をチェックできる

デメリット

ビルダー構造体とメソッドを別途定義する必要があり、コード量が増える
不変性が確保されない場合があるため注意が必要

可変長引数パターン

可変長引数パターン(Variadic Functions Pattern)は、コンストラクタに可変長引数を渡すことで、オプション引数を実装する手法です。この手法では、デフォルト値を持つフィールドについては明示的に指定しなくても良くなります。

実装例

type User struct {
    name     string
    email    string
    age      int
    isActive bool
}

func NewUser(name, email string, opts ...option) *User {
    user := User{
        name:  name,
        email: email,
        age:   0,
    }

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

    return &user
}

type option func(*User)

func WithAge(age int) option {
    return func(u *User) {
        u.age = age
    }
}

func WithActive(active bool) option {
    return func(u *User) {
        u.isActive = active
    }
}