Method di Golang: Penjelasan Value Receiver vs Pointer Receiver

Mendeklarasikan method

Method adalah fungsi yang punya receiver: parameter tambahan yang ditulis sebelum nama method. Receiver mengikat method ke sebuah tipe.

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
}

Nama receiver biasanya satu atau dua huruf yang diambil dari nama tipenya (c untuk Circle). Go tidak memakai this atau self, dan panduan gaya Go tidak menyarankan nama-nama itu.

Karena Circle punya method String() string, ia memenuhi fmt.Stringer, dan fmt.Println mencetak hasil method itu, bukan {2}.

Value receiver dan pointer receiver

Value receiver (c Circle) mendapat salinan. Pointer receiver (c *Circle) mendapat alamatnya, jadi perubahan pada field tetap tersimpan.

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 bisa dikompilasi tapi tidak melakukan apa pun yang terlihat, sebuah bug klasik. Kalau sebuah method dimaksudkan untuk mengubah receiver-nya, method itu butuh pointer receiver.

Pemanggilan di atas juga menunjukkan dua kemudahan yang diberikan Go. c.Inc() pada variabel yang addressable ditulis ulang menjadi (&c).Inc(), dan p.Value() pada pointer ditulis ulang menjadi (*p).Value(). Kamu jarang perlu menulis & atau * hanya untuk memanggil method.

& otomatis itu butuh sesuatu yang addressable. Elemen map atau composite literal tidak addressable:

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

Simpan pointer di map (map[string]*Counter), atau salin nilainya keluar, ubah, lalu tulis kembali.

Receiver mana yang dipilih

FAQ Go dan standard library mengikuti satu patokan: konsisten. Kalau ada method yang butuh pointer receiver, berikan pointer receiver ke semua method, supaya method set-nya mudah ditebak. go vet menandai struct berisi sync.Mutex yang tersalin lewat value receiver (passes lock by value).

Method set dan interface

Perbedaan ini paling penting untuk interface. Method set milik T berisi method dengan value receiver. Method set milik *T berisi method dengan value receiver maupun pointer receiver.

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())
	}
}

Menulis Square{Side: 3} tanpa & di slice itu akan gagal dikompilasi:

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)

Alasannya: interface bisa menyimpan salinan Square yang tidak addressable, jadi Go tidak bisa mengambil alamatnya untuk memanggil method pointer. Lihat interface untuk kelanjutan ceritanya.

Method pada tipe yang bukan struct

Named type apa pun yang dideklarasikan di package-mu bisa punya method, bukan hanya struct.

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))
}

Batasannya: tipe itu harus didefinisikan di package yang sama dengan method-nya, dan underlying type-nya tidak boleh berupa pointer atau interface. Kamu tidak bisa menambahkan method ke int, string, atau time.Time dari package-mu sendiri. Membungkusnya dalam named type baru adalah cara Go. String() pada tipe integer juga merupakan cara enum mendapatkan output yang mudah dibaca; lihat enum dengan iota.

Method value dan method expression

Method yang terikat ke receiver tertentu adalah sebuah nilai fungsi:

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"))
}

Method value dengan value receiver menyalin receiver-nya saat dibuat, itulah sebabnya f masih menyebut Ana. Dengan pointer receiver, ia akan menyimpan pointer dan melihat perubahan yang terjadi kemudian. Method value berguna untuk callback: http.HandleFunc("/", srv.handleIndex).

Kesalahan umum

• Value receiver pada method yang mengubah data. Bisa dikompilasi, tapi diam-diam hanya mengubah salinan.
• Mencampur jenis receiver. Membuat tidak jelas apakah T atau *T yang memenuhi interface. Pilih satu untuk setiap tipe.
• Memanggil method pointer pada pointer nil. Diperbolehkan, dan method-nya berjalan dengan receiver nil. Method itu baru panic saat menyentuh sebuah field. Beberapa tipe (seperti linked list yang aman terhadap nil) sengaja memanfaatkan ini; kebanyakan tipe tidak mengantisipasinya.