New関数の慣習

不正な状態を作れなくする

構造体はどんな値でも入れられます。

item := Item{Name: "", Price: -500}   // 通ってしまう

名前が空で価格が負の商品ができました。エラーにはなりません。この Item が後の処理に流れていくと、どこかで壊れます。

作る時点で止めます。 そのための関数を用意するのが Go の慣習です。

func NewItem(name string, price int) (*Item, error) {
	if name == "" {
		return nil, errors.New("商品名が空です")
	}
	if price <= 0 {
		return nil, errors.New("価格が0以下です")
	}
	return &Item{Name: name, Price: price}, nil
}

第4章でやった検証が、生成と一体になりました。

New という名前

Go には constructor という仕組みがありません。ただの関数です。ただし名前の付け方に決まりがあります。

NewItem   Item を作る
NewUser   User を作る
New       パッケージの主役の型を作る

New で始めるだけで、読む人には「これは生成関数だ」と伝わります。言語の機能ではなく、名前の習慣で揃えているのが Go らしいところです。

&Item{} が返るもの

return &Item{Name: name, Price: price}, nil

& は「その居場所」を意味します。前のレッスンの *Item と対になっていて、&Item{...} は「作った Item の居場所」を返します。

*Item   居場所を表す型
&item   居場所を取り出す

生成関数がポインタを返すのは、受け取った側がメソッドで書き換えられるようにするためです。値で返すと、前のレッスンの問題がそのまま起きます。

失敗したときは nil

return nil, errors.New("商品名が空です")

ポインタのゼロ値は nil です。第4章で (int, error) を返したときの 0 にあたるものが、ポインタでは nil になります。

受け取る側は、いつもの形で確かめます。

item, err := NewItem("", 1200)
if err != nil {
	return err.Error()
}
// ここから先、item は nil ではないと信用してよい

err を確かめずに item を使うと panic します。 nil のポインタからフィールドを読もうとするからです。第4章で「エラーを _ で捨てるな」と書いた理由が、ここでは実行時の停止という形で現れます。

1. NewItem は (*Item, error) を返す
2. 検証の順番は 商品名が空 → 価格が0以下 → 価格が上限超え
3. 成功時は &Item{...} と nil を返す
4. 失敗時は nil とエラーを返す
5. createItem は成功なら 商品名 価格円 を作成しました、失敗ならエラーの理由を返す