Go言語のメソッド：値レシーバーとポインタレシーバーの違い

メソッドを宣言する

メソッドはレシーバーを持つ関数です。レシーバーはメソッド名の前に書く追加の引数で、メソッドを型に結びつけます。

package main

import (
	"fmt"
	"math"
)

type Circle struct {
	Radius float64
}

func (c Circle) Area() float64 {
	return math.Pi * c.Radius * c.Radius
}

func (c Circle) String() string {
	return fmt.Sprintf("Circle(r=%.1f)", c.Radius)
}

func main() {
	c := Circle{Radius: 2}
	fmt.Printf("%.2f\n", c.Area())
	fmt.Println(c) // uses the String method
}

レシーバーの名前は、たいてい型から取った1、2文字にします（Circle なら c）。Goは this や self を使わず、スタイルガイドもそうした名前を勧めていません。

Circle は String() string メソッドを持っているので fmt.Stringer を満たし、fmt.Println は {2} ではなくその結果を表示します。

値レシーバーとポインタレシーバー

値レシーバー (c Circle) はコピーを受け取ります。ポインタレシーバー (c *Circle) はアドレスを受け取るので、フィールドへの変更が残ります。

package main

import "fmt"

type Counter struct {
	n int
}

func (c Counter) IncByValue() {
	c.n++ // changes the copy only
}

func (c *Counter) Inc() {
	c.n++
}

func (c Counter) Value() int {
	return c.n
}

func main() {
	var c Counter
	c.IncByValue()
	fmt.Println(c.Value()) // 0

	c.Inc() // Go takes &c automatically
	c.Inc()
	fmt.Println(c.Value()) // 2

	p := &c
	fmt.Println(p.Value()) // Go dereferences p automatically
}

IncByValue はコンパイルできますが、目に見える効果は何もありません。典型的なバグです。レシーバーを変更するためのメソッドには、ポインタレシーバーが必要です。

この呼び出しは、Goが提供する2つの便利な仕組みも示しています。アドレスを取れる変数に対する c.Inc() は (&c).Inc() に書き換えられ、ポインタに対する p.Value() は (*p).Value() に書き換えられます。メソッドを呼ぶためだけに & や * を書くことはめったにありません。

自動的な & には、アドレスを取れるものが必要です。マップの要素や複合リテラルはそうではありません。

m := map[string]Counter{"a": {}}
m["a"].Inc()    // compile error: cannot call pointer method Inc on Counter
Counter{}.Inc() // same error: a composite literal is not addressable

マップにポインタを格納する（map[string]*Counter）か、値を取り出して変更し、書き戻します。

どちらのレシーバーを選ぶか

GoのFAQと標準ライブラリは1つの経験則に従っています。一貫させることです。どれか1つのメソッドにポインタレシーバーが必要なら、すべてのメソッドをポインタレシーバーにして、メソッドセットを予測しやすくします。go vet は、sync.Mutex を持つ構造体が値レシーバーでコピーされていると指摘します（passes lock by value）。

メソッドセットとインターフェース

この違いが最も重要になるのはインターフェースです。T のメソッドセットには値レシーバーのメソッドが含まれます。*T のメソッドセットには、値レシーバーとポインタレシーバーの両方のメソッドが含まれます。

package main

import "fmt"

type Shape interface {
	Area() float64
}

type Square struct{ Side float64 }

func (s *Square) Area() float64 { return s.Side * s.Side }

type Rect struct{ W, H float64 }

func (r Rect) Area() float64 { return r.W * r.H }

func main() {
	shapes := []Shape{
		&Square{Side: 3},  // *Square has Area
		Rect{W: 2, H: 5},  // Rect has Area
		&Rect{W: 1, H: 1}, // *Rect has it too
	}
	for _, s := range shapes {
		fmt.Printf("%T %.0f\n", s, s.Area())
	}
}

このスライスで & を付けずに Square{Side: 3} と書くと、コンパイルに失敗します。

cannot use Square{…} (value of struct type Square) as Shape value in array or slice literal: Square does not implement Shape (method Area has pointer receiver)

理由は、インターフェースはアドレスを取れない Square のコピーを保持しうるので、Goがポインタメソッドを呼ぶためにそのアドレスを取れないからです。続きはインターフェースのページを参照してください。

構造体以外の型のメソッド

構造体に限らず、自分のパッケージで宣言した名前付きの型ならどれでもメソッドを持てます。

package main

import (
	"fmt"
	"strings"
)

type Celsius float64

func (c Celsius) Fahrenheit() float64 {
	return float64(c)*9/5 + 32
}

type Tags []string

func (t Tags) String() string {
	return "#" + strings.Join(t, " #")
}

type Status int

func (s Status) String() string {
	switch s {
	case 0:
		return "pending"
	case 1:
		return "done"
	}
	return fmt.Sprintf("Status(%d)", int(s))
}

func main() {
	fmt.Println(Celsius(100).Fahrenheit())
	fmt.Println(Tags{"go", "backend"})
	fmt.Println(Status(1), Status(7))
}

制限は次のとおりです。型はメソッドと同じパッケージで定義されている必要があり、基底型がポインタやインターフェースであってはいけません。自分のパッケージから int、string、time.Time にメソッドを追加することはできません。新しい名前付きの型で包むのがGoのやり方です。整数型の String() は、列挙型を読みやすく表示する方法でもあります。iotaを使った列挙型のページを参照してください。

メソッド値とメソッド式

特定のレシーバーに束縛されたメソッドは、関数の値になります。

package main

import "fmt"

type Greeter struct{ Name string }

func (g Greeter) Hello(to string) string {
	return g.Name + " says hi to " + to
}

func main() {
	g := Greeter{Name: "Ana"}

	f := g.Hello // method value: receiver bound now
	g.Name = "Bob"
	fmt.Println(f("Cy")) // still Ana: the receiver was copied

	h := Greeter.Hello // method expression: receiver becomes the first parameter
	fmt.Println(h(g, "Dee"))
}

値レシーバーのメソッド値は作られたときにレシーバーをコピーするので、f はAnaのままです。ポインタレシーバーならポインタを保存し、後の変更が見えます。メソッド値はコールバックに便利です：http.HandleFunc("/", srv.handleIndex)。

よくある間違い

• 変更するメソッドに値レシーバーを使う。 コンパイルは通り、何も言わずにコピーを変更します。
• レシーバーの種類を混ぜる。 T と *T のどちらがインターフェースを満たすのかがわかりにくくなります。型ごとにどちらか一方を選びます。
• nilポインタでポインタメソッドを呼ぶ。 これは許されていて、メソッドはnilのレシーバーで実行されます。panicするのはフィールドに触れたときだけです。一部の型（nilに安全な連結リストなど）はこれを意図的に使いますが、ほとんどの型は想定していません。