القيم المعادة المتعدّدة في Golang: (value, error) والنتائج المسمّاة

إعادة أكثر من قيمة

اسرد أنواع النتائج بين قوسين. أعد القيم مفصولة بفواصل، واستقبلها بالطريقة نفسها.

package main

import "fmt"

func minMax(xs []int) (int, int) {
	lo, hi := xs[0], xs[0]
	for _, x := range xs[1:] {
		lo = min(lo, x)
		hi = max(hi, x)
	}
	return lo, hi
}

func main() {
	lo, hi := minMax([]int{4, 9, 1, 7})
	fmt.Println("min:", lo, "max:", hi)
}

الدالتان المدمجتان min وmax موجودتان منذ Go 1.21. يجب أن يستقبل المستدعي كل النتائج: تفشل x := minMax(nums) في الترجمة برسالة assignment mismatch: 1 variable but minMax returns 2 values.

اصطلاح (value, error)

أشيع سبب لإعادة قيمتين هو الإبلاغ عن الفشل. اصطلاحًا يأتي الخطأ أخيرًا، وعندما لا يكون nil يجب اعتبار النتائج الأخرى بلا معنى.

package main

import (
	"errors"
	"fmt"
	"strconv"
)

func parsePort(s string) (int, error) {
	n, err := strconv.Atoi(s)
	if err != nil {
		return 0, fmt.Errorf("port %q: %w", s, err)
	}
	if n < 1 || n > 65535 {
		return 0, errors.New("port out of range")
	}
	return n, nil
}

func main() {
	for _, in := range []string{"8080", "http", "70000"} {
		port, err := parsePort(in)
		if err != nil {
			fmt.Println("error:", err)
			continue
		}
		fmt.Println("port:", port)
	}
}

المخرجات:

port: 8080
error: port "http": strconv.Atoi: parsing "http": invalid syntax
error: port out of range

عند الفشل أعد القيمة الصفرية لكل نتيجة أخرى (0 و"" وnil). النمط الكامل، بما في ذلك التغليف والفحص، في صفحة معالجة الأخطاء.

نمط comma-ok

تعيد عدة عمليات مدمجة قيمة ثانية اختيارية من النوع bool تقول هل القيمة الأولى حقيقية. يُسمّى المتغيّر اصطلاحًا ok.

package main

import "fmt"

func main() {
	ages := map[string]int{"ana": 31}

	age, ok := ages["bob"]
	fmt.Println(age, ok) // 0 false: missing key, not a zero age

	var v any = "hello"
	s, ok := v.(string)
	fmt.Println(s, ok)

	ch := make(chan int, 1)
	ch <- 5
	close(ch)
	x, ok := <-ch
	fmt.Println(x, ok) // 5 true: a buffered value is still delivered
	x, ok = <-ch
	fmt.Println(x, ok) // 0 false: closed and drained
}

هذه الأشكال الثلاثة (البحث في خريطة، وتأكيد النوع، والاستقبال من قناة) خاصة: تعيد قيمة واحدة أو قيمتين حسب عدد المتغيّرات التي تسند إليها. دوالك الخاصة لا تستطيع ذلك. الدالة المعرّفة بنتيجتين تعيد دائمًا نتيجتين.

المعرّف الفارغ

يستقبل _ قيمة ويرميها. استخدمه للنتائج التي لا تحتاجها:

_, err := fmt.Sscan(input, &n)
key, _ := parseLine(line)

تجاهل خطأ بـ _ يُترجم، فافعل ذلك فقط عندما تعرف أن الاستدعاء لا يفشل أو أن الفشل لا يهمّ. تعيد strings.Builder.WriteString مثلًا خطأ nil دائمًا؛ أما إغلاق ملف بعد الكتابة فيه فلا.

النتائج المسمّاة

يمكن أن تكون لمعاملات النتائج أسماء. تُعرَّف في بداية الدالة، وتُهيّأ بقيمها الصفرية، وتعيد return دون قيم ما تحمله.

package main

import "fmt"

func split(total int) (quotient, remainder int) {
	quotient = total / 7
	remainder = total % 7
	return
}

func main() {
	weeks, days := split(45)
	fmt.Println(weeks, "weeks and", days, "days")
}

تظهر الأسماء في مخرجات go doc، وهذا يفيد عندما تتشارك نتيجتان نوعًا: (quotient, remainder int) تقول أكثر من (int, int).

return المجرّدة في دالة طويلة صعبة القراءة، لأن على القارئ الرجوع ليرى ما تحمله النتائج. النصيحة المعتادة: سمِّ النتائج عندما توثّق الأسماء شيئًا، واكتب مع ذلك return quotient, remainder صراحة ما لم تكن الدالة بضعة أسطر.

النتائج المسمّاة وdefer

تُنفَّذ الدالة المؤجّلة بعد أن تضبط عبارة return النتائج وقبل أن يتلقّاها المستدعي. مع النتائج المسمّاة تستطيع الدالة المؤجّلة قراءتها وتغييرها. بهذا تضيف سياقًا إلى أي خطأ تعيده دالة، أو تحوّل panic إلى خطأ.

package main

import (
	"errors"
	"fmt"
)

func load(name string) (err error) {
	defer func() {
		if err != nil {
			err = fmt.Errorf("load %s: %w", name, err)
		}
	}()
	if name == "" {
		return errors.New("empty name")
	}
	return nil
}

func main() {
	fmt.Println(load(""))
	fmt.Println(load("config.json"))
}

يطبع هذا load : empty name ثم <nil>. تسند return errors.New(...) أولًا إلى err، ثم تغلّفه الدالة المؤجّلة. المزيد في صفحة defer.

تظليل نتيجة مسمّاة

تعيش النتائج المسمّاة في النطاق الأعلى للدالة. عبارة := داخل كتلة متداخلة تنشئ متغيّرًا جديدًا بالاسم نفسه، ثم تعيد return المجرّدة المتغيّر الخارجي.

func find() (n int, err error) {
	if true {
		n, err := compute() // new n and err, shadowing the results
		_ = n
		_ = err
	}
	return // returns 0, nil
}

يكتشف المترجم أسوأ حالة: return مجرّدة داخل الكتلة التي تُظلَّل فيها نتيجة تفشل برسالة result parameter err not in scope at return. لكنه لا يكتشف النسخة السابقة، حيث تقع العودة خارج الكتلة. استخدم = بدل := عندما تقصد متغيّرات النتائج.

أخطاء شائعة

• استخدام القيمة عندما لا يكون err مساويًا لـ nil. افحص err أولًا. للدالة الحرية في إعادة قيمة لا معنى لها مع الخطأ.
• إعادة مؤشر nil ذي نوع كخطأ. تعيد var e *MyErr; return e قيمة error ليست nil. أعد nil حرفيًا عند النجاح.
• نتائج كثيرة جدًا. ثلاث نتائج أو أكثر بمعانٍ مختلطة صعبة الاستخدام. أعد بنية بدلًا من ذلك.