البنى Struct في Golang: التعريف والتهيئة والمقارنة والوسوم

تعريف بنية وإنشاؤها

نوع البنية (struct) قائمة من الحقول المسمّاة. تعرّفه بـ type Name struct { ... } وتنشئ القيم بحرفية مركّبة.

package main

import "fmt"

type User struct {
	Name  string
	Email string
	Age   int
	Admin bool
}

func main() {
	a := User{Name: "Ana", Email: "ana@example.com", Age: 31}
	fmt.Println(a.Name, a.Age)

	a.Age++ // fields are accessed and set with a dot
	fmt.Printf("%+v\n", a)

	var b User // zero value: every field at its own zero
	fmt.Printf("%+v\n", b)
	fmt.Printf("%#v\n", User{Name: "Bob"})
}

المخرجات:

Ana 31
{Name:Ana Email:ana@example.com Age:32 Admin:false}
{Name: Email: Age:0 Admin:false}
main.User{Name:"Bob", Email:"", Age:0, Admin:false}

يطبع %+v أسماء الحقول ويطبع %#v صيغة Go. كلاهما أسرع طريقة لفحص بنية أثناء تتبّع الأخطاء.

يمكن للحقول من النوع نفسه أن تتشارك سطرًا: X, Y float64. أسماء الحقول التي تبدأ بحرف كبير مُصدَّرة (مرئية للحزم الأخرى ولـ encoding/json)؛ والتي تبدأ بحرف صغير ليست كذلك.

أشكال الحرفيات

User{Name: "Ana", Age: 31}        // named fields: order-free, omitted fields are zero
User{"Ana", "a@x.com", 31, false} // positional: every field, in order
&User{Name: "Ana"}                // pointer to a new struct
new(User)                         // pointer to a zeroed struct

فضّل الحقول المسمّاة. تنكسر الحرفيات الموضعية عندما يضيف أحدهم حقلًا أو يعيد ترتيب الحقول، ويحذّر go vet منها لأنواع البنى من حزم أخرى (مثلًا net/url.Error struct literal uses unkeyed fields). الشكل الموضعي لا بأس به للأنواع المحلية الصغيرة مثل Point{1, 2}.

لا قيم افتراضية: القيم الصفرية ودوال البناء

لا تملك Go قيمًا افتراضية للحقول ولا دوال بناء في اللغة. يبدأ كل حقل بالقيمة الصفرية لنوعه: 0 و"" وfalse وnil. أسلوبان يسدّان الفجوة.

اجعل القيمة الصفرية مفيدة. تعمل sync.Mutex وbytes.Buffer وstrings.Builder كلها دون تهيئة. عندما تستطيع تصميم نوع بهذه الطريقة، افعل.

اكتب دالة NewX عندما يحتاج حقل قيمة افتراضية غير صفرية أو يجب حجز شيء ما، مثل خريطة:

package main

import (
	"fmt"
	"time"
)

type Server struct {
	Addr    string
	Timeout time.Duration
	routes  map[string]string
}

func NewServer(addr string) *Server {
	return &Server{
		Addr:    addr,
		Timeout: 30 * time.Second,
		routes:  make(map[string]string),
	}
}

func (s *Server) Handle(path, name string) {
	s.routes[path] = name
}

func main() {
	s := NewServer(":8080")
	s.Handle("/", "index")
	fmt.Println(s.Addr, s.Timeout, len(s.routes))
}

تعيد NewServer مؤشرًا لأن للخادم توابع تعدّله وسيُشارك. وإعادة البنية بالقيمة شائعة أيضًا للأنواع الصغيرة غير القابلة للتعديل (تعيد time.Date قيمة time.Time).

المؤشرات إلى البنى

تلغي Go مرجعية مؤشرات البنى تلقائيًا عند الوصول إلى الحقول. مع p := &User{} تكتب p.Name، لا (*p).Name.

package main

import "fmt"

type Point struct{ X, Y int }

func moveBy(p *Point, dx, dy int) {
	p.X += dx
	p.Y += dy
}

func main() {
	pt := Point{1, 2}
	moveBy(&pt, 10, 10)
	fmt.Println(pt)

	copyPt := pt // a struct assignment copies every field
	copyPt.X = 0
	fmt.Println(pt, copyPt)

	alias := &pt // a pointer shares the same struct
	alias.Y = 0
	fmt.Println(pt)
}

المخرجات:

{11 12}
{11 12} {0 12}
{11 0}

البنى قيم. الإسناد ووسائط الدوال تنسخها؛ والمؤشر يشارك واحدة. والنسخ حقلًا بحقل سطحي: حقل الشريحة أو الخريطة في النسخة ما زال يشير إلى البيانات نفسها. راجع المؤشرات لتعرف متى تستخدم كلًا منهما.

البنى المجهولة

يمكن كتابة نوع بنية في مكانه دون اسم. هذا مفيد للتجميعات لمرة واحدة، والاختبارات المبنية على الجداول، وفكّ ترميز JSON تقرؤه مرة واحدة.

package main

import "fmt"

func main() {
	point := struct {
		X, Y int
	}{3, 4}
	fmt.Println(point.X, point.Y)

	tests := []struct {
		in   string
		want int
	}{
		{"go", 2},
		{"gopher", 6},
	}
	for _, tc := range tests {
		fmt.Println(tc.in, len(tc.in) == tc.want)
	}
}

جدول []struct{ in string; want int } هو الشكل المعتاد لاختبار في Go.

مقارنة البنى

البنى قابلة للمقارنة بـ == عندما يكون كل حقل قابلًا للمقارنة. والمساواة تعني تساوي كل الحقول. ويمكن للبنى القابلة للمقارنة أن تكون مفاتيح خرائط أيضًا.

package main

import (
	"fmt"
	"slices"
)

type Point struct{ X, Y int }

type Polygon struct {
	Name   string
	Points []Point // slices make the struct incomparable
}

func main() {
	fmt.Println(Point{1, 2} == Point{1, 2})

	grid := map[Point]string{{0, 0}: "origin"}
	fmt.Println(grid[Point{0, 0}])

	a := Polygon{"tri", []Point{{0, 0}, {1, 0}, {0, 1}}}
	b := Polygon{"tri", []Point{{0, 0}, {1, 0}, {0, 1}}}
	// fmt.Println(a == b) // compile error: struct containing []Point cannot be compared
	fmt.Println(a.Name == b.Name && slices.Equal(a.Points, b.Points))
}

لبنية فيها حقول شرائح أو خرائط، اكتب تابع Equal أو قارن في الاختبارات بـ reflect.DeepEqual.

وسوم البنى

الوسم حرفية نصية بعد نوع الحقل. تتجاهله اللغة؛ وتقرؤه المكتبات بالانعكاس. أشيع قارئ له هو encoding/json:

package main

import (
	"encoding/json"
	"fmt"
)

type Product struct {
	ID       int     `json:"id"`
	Name     string  `json:"name"`
	Price    float64 `json:"price,omitempty"`
	internal string  // unexported: never encoded
}

func main() {
	out, err := json.Marshal(Product{ID: 7, Name: "Mug", internal: "x"})
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Println(string(out))
}

يطبع هذا {"id":7,"name":"Mug"}: يعيد الوسم تسمية الحقول، ويُسقط omitempty الحقل Price الصفري، والحقل غير المُصدَّر غير مرئي للمرمّز. تتبع الوسوم اصطلاح key:"value"، مع عدة مفاتيح مفصولة بمسافات: `json:"name" db:"user_name"`. الوسم المشوّه يُترجم بلا مشكلة ويُتجاهل بصمت، ويكتشفه go vet. صفحة json تشرح الخيارات.

البنى الفارغة وترتيب الحقول

ليس لـ struct{} أي حقول وتشغل صفر بايت. تُستخدم كقيمة مجموعة (map[string]struct{}) وكإشارة على القنوات (chan struct{})، حيث يهمّ الحدث وحده.

يؤثّر ترتيب الحقول في تخطيط الذاكرة: يحشو المترجم الحقول حسب محاذاتها. بنية من bool, int64, bool تشغل 24 بايتًا على أنظمة 64 بت، بينما int64, bool, bool تشغل 16. هذا يهمّ فقط للأنواع المخزّنة بأعداد كبيرة.

أخطاء شائعة

• تعديل نسخة. for _, u := range users { u.Age++ } تغيّر نسخة في كل مرة. استخدم الفهرس: users[i].Age++.
• نسيان تهيئة حقل خريطة. القيمة الصفرية للبنية تحمل خريطة nil؛ والكتابة فيها تسبّب panic. احجزها في دالة بناء.
• نسخ بنية تحمل sync.Mutex. للنسخة حالة قفل خاصة بها. مرّر هذه البنى بمؤشر؛ ويبلغ go vet عن النسخ.
• الحرفيات الموضعية لأنواع حزم أخرى. تنكسر عند إضافة حقل.