Phương thức trong Golang: receiver giá trị và con trỏ

Khai báo phương thức

Phương thức (method) là một hàm có receiver: một tham số bổ sung được viết trước tên phương thức. Receiver gắn phương thức với một kiểu.

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
}

Tên receiver thường là một hoặc hai chữ cái lấy từ tên kiểu (c cho Circle). Go không dùng this hay self, và các hướng dẫn về phong cách code cũng khuyên không đặt những tên đó.

Vì Circle có phương thức String() string, nó thỏa mãn fmt.Stringer, và fmt.Println in ra kết quả của phương thức này thay vì {2}.

Receiver giá trị và receiver con trỏ

Receiver giá trị (c Circle) nhận một bản sao. Receiver con trỏ (c *Circle) nhận địa chỉ, nên thay đổi trên các trường được giữ lại.

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 vẫn biên dịch được nhưng không tạo ra thay đổi nào nhìn thấy được, một bug kinh điển. Nếu phương thức cần sửa receiver, nó phải dùng receiver con trỏ.

Các lời gọi trên cũng cho thấy hai tiện lợi mà Go mang lại. c.Inc() trên một biến lấy địa chỉ được sẽ được viết lại thành (&c).Inc(), và p.Value() trên một con trỏ được viết lại thành (*p).Value(). Bạn hiếm khi phải viết & hay * chỉ để gọi một phương thức.

Dấu & tự động cần một thứ lấy địa chỉ được. Phần tử của map hay một composite literal thì không:

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

Hãy lưu con trỏ trong map (map[string]*Counter), hoặc sao chép giá trị ra, sửa nó rồi ghi lại.

Chọn loại receiver nào

Go FAQ và thư viện chuẩn theo một nguyên tắc chung: hãy nhất quán. Nếu có phương thức cần receiver con trỏ, hãy cho mọi phương thức dùng receiver con trỏ, để method set dễ đoán. go vet cảnh báo khi một struct chứa sync.Mutex bị sao chép qua receiver giá trị (passes lock by value).

Method set và interface

Sự khác biệt này quan trọng nhất với interface. Method set của T chứa các phương thức có receiver giá trị. Method set của *T chứa cả phương thức có receiver giá trị lẫn receiver con trỏ.

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

Viết Square{Side: 3} mà thiếu & trong slice đó sẽ không biên dịch được:

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)

Lý do: một interface có thể chứa bản sao của Square không lấy địa chỉ được, nên Go không thể lấy địa chỉ của nó để gọi phương thức con trỏ. Xem interface để biết phần còn lại.

Phương thức trên kiểu không phải struct

Mọi kiểu đặt tên được khai báo trong package của bạn đều có thể có phương thức, không chỉ 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))
}

Giới hạn: kiểu phải được định nghĩa trong cùng package với phương thức, và kiểu nền của nó không được là con trỏ hay interface. Bạn không thể thêm phương thức cho int, string hay time.Time từ package của mình. Cách làm của Go là bọc nó trong một kiểu đặt tên mới. String() trên kiểu số nguyên cũng là cách enum có đầu ra dễ đọc; xem enum với iota.

Method value và method expression

Một phương thức gắn với một receiver cụ thể là một giá trị hàm:

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 có receiver giá trị sẽ sao chép receiver ngay khi được tạo, đó là lý do f vẫn in ra Ana. Với receiver con trỏ, nó sẽ lưu con trỏ và thấy được các thay đổi sau đó. Method value rất tiện cho callback: http.HandleFunc("/", srv.handleIndex).

Lỗi thường gặp

• Receiver giá trị trên phương thức cần sửa dữ liệu. Vẫn biên dịch, nhưng âm thầm sửa một bản sao.
• Trộn hai loại receiver. Khiến khó biết T hay *T thỏa mãn interface. Mỗi kiểu chỉ chọn một loại.
• Gọi phương thức con trỏ trên con trỏ nil. Được phép, và phương thức chạy với receiver nil. Nó chỉ panic khi chạm vào một trường. Một số kiểu (như danh sách liên kết an toàn với nil) cố ý tận dụng điều này; phần lớn thì không lường trước.