التوابع في Golang: مستقبِل القيمة مقابل مستقبِل المؤشر

تعريف تابع

التابع (method) دالة لها مستقبِل (receiver): معامل إضافي يُكتب قبل اسم التابع. يربط المستقبِل التابع بنوع.

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
}

يكون اسم المستقبِل عادة حرفًا أو حرفين مأخوذين من النوع (c لـ Circle). لا تستخدم 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. تُعاد كتابة 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 والمكتبة القياسية قاعدة عملية واحدة: كن متّسقًا. إذا احتاج أي تابع مستقبِل مؤشر، فأعطِ كل التوابع مستقبِلات مؤشر، لتكون مجموعة التوابع متوقّعة. يبلغ 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) تستخدم هذا عمدًا؛ ومعظمها لا تتوقّعه.