【Go】Builder Patternで実装してみた

これは何

前回の記事 ではGoのFunctional Option Patternについて書きました。
今回はそれと対比される実装パターンである、Builderパターンについて書きたいと思います。

この記事のゴール

• builderパターンによる実装方法を理解できること

結論

• Builderとなる構造体にメソッドを実装する
• そのメソッドを通して元になる構造体にパラメータをセットする
• Builderを呼び出す側はセットするかしないかを自由に選択できる

Builder Patternの具体例

以下、Builder Patternの実装例です。

UserとUserParam

以下のようにUserとUserParamを用意します。
UserParamという構造体を介して、Userにパラメータをセットしていくことになります。
また、petName,height,weightは任意でつけるようなパラメータだと想定します。

user.go

type User struct {
	param UserParam
}
type UserParam struct {
	name    string
	age     int
	petName string // 任意のパラメータ
	height  int // 任意のパラメータ
	weight  int // 任意のパラメータ
}

Builderを作成する関数

次に、UserParamを初期化する関数を実装します。

user.go

func NewBuilder(name string, age int) *UserParam {
	return &UserParam{
		name: name,
		age:  age,
	}
}

UserParamにメソッドを実装

UserParamに対してパラメータをセットして、自身を返すメソッドを実装します。

user.go

func (up *UserParam) PetName(petName string) *UserParam {
	up.petName = petName
	return up
}

func (up *UserParam) Height(height int) *UserParam {
	up.height = height
	return up
}

func (up *UserParam) Weight(weight int) *UserParam {
	up.weight = weight
	return up
}

Buildメソッド

最後にUserParam自身をUserにセットするBuildメソッド実装します。

user.go

func (up *UserParam) Build() *User {
	user := &User{
		param: *up,
	}

	return user
}

Builderを呼び出してUserを生成

実際にBuilderを使ってみます。
以下のようにメソッドチェーンで繋ぐことによってパラメータを設定していきます。

main.go

func main() {
	builder := NewBuilder("taro", 19). // nameとageは必須で入れる
		PetName("pochi"). // petName,height,weightはオプションなのでBuilderを使う
		Height(170).
		Weight(70)
	user := builder.Build() // BuildするとUserが生成される
	fmt.Println(user) // &{{taro 19 pochi 170 70}}
}

最後に

以上です！
少しでも参考になれば幸いです。