مزرعه

type error interface {
  Error() string
}

func DoSomething() (int, error) {
  // ...
}

func DoSomething() (SomeStruct, int, error) {
  // ...
  return SomeStruct{}, 0, errors.New("failed to calculate result")
}

import "errors"

var ErrNotFound = errors.New("resource was not found")

func DoSomething() error {
  // ...
  return ErrNotFound
}

func Foo() (int, error) {
  return 10, nil
}

func processUserFile() error {
	file, err := os.Open("./users.csv")
	if err != nil {
		return err
	}

	// do something with file
}

type MyCustomError struct {
  message string
  details string
}

func (e *MyCustomError) Error() string {
  return fmt.Sprintf("%s, details: %s", e.message, e.details)
}

func someFunction() error {
  // ...
  return &MyCustomError{
    message: "...",
    details: "...",
  }
}

دستورالعمل‌ها

روزی که مدت‌ها منتظرش بودید بالاخره فرا رسید و حالا با افتخار صاحب یک مزرعه‌ی زیبا در کوه‌های آلپ هستید.

هنوز هم دوست ندارید صبح زود برای غذا دادن به گاوهایتان از خواب بیدار شوید. چون مهندس زبردستی هستید، یک دستگاه پخش غذا به اسم FEED-M-ALL می‌سازید.

آخرین چیزی که برای به پایان رساندن پروژه‌تان لازم دارید، تکه‌کدی است که مقدار علوفه‌ای را که هر گاو باید دریافت کند محاسبه می‌کند. مهم است که هر گاو مقدار یکسانی دریافت کند؛ باید از بروز درگیری جلوگیری کنید. گاوها بسیار حساس‌اند.

خوشبختانه لازم نیست همه‌ی فرمول‌های محاسبه‌ی مقدار علوفه را خودتان به دست آورید. از یک کتابخانه‌ی خارجی مرموز استفاده می‌کنید که در اینترنت پیدایش کرده‌اید. قرار است نتیجه‌اش شادترین گاوها باشد. این کتابخانه نوعی را ارائه می‌دهد که واسط زیر را پیاده‌سازی می‌کند. در کدی که خودتان می‌نویسید به این تکیه خواهید کرد.

type FodderCalculator interface {
	FodderAmount(int) (float64, error)
	FatteningFactor() (float64, error)
}

همان‌طور که روی کدتان کار می‌کنید، مدیریت خطا را بهتر می‌کنید تا مقاوم‌تر شود و بعدها که در زندگی روزمره‌ی مزرعه از آن استفاده می‌کنید، debug کردنش آسان‌تر باشد.

1. تقسیم مساوی غذا

اول از همه، روی نوشتن کدی تمرکز می‌کنید که برای محاسبه‌ی مقدار علوفه‌ی هر گاو لازم است.

تابعی به اسم DivideFood پیاده‌سازی کنید که یک FodderCalculator و تعداد گاوها به‌صورت عدد صحیح را به عنوان آرگومان می‌پذیرد. برای این کار، فرض کنید تعداد گاوهای ورودی همیشه بزرگ‌تر از صفر است. تابع باید مقدار غذای هر گاو را به‌صورت float64 برگرداند، یا اگر خطایی رخ داد، خود آن خطا را برگرداند.

برای انجام محاسبه، ابتدا باید مقدار کل علوفه‌ی همه‌ی گاوها را به دست آورید. این کار با فراخوانی متد FodderAmount و پاس دادن تعداد گاوها انجام می‌شود. علاوه بر این، به ضریبی نیاز دارید که این مقدار باید در آن ضرب شود. این ضریب را با فراخوانی متد FatteningFactor به دست می‌آورید. با این دو مقدار و تعداد گاوها، حالا می‌توانید مقدار غذای هر گاو را (به‌صورت float64) محاسبه کنید. همین مقدار باید از تابع DivideFood برگردانده شود.

اگر یکی از متدهایی که فراخوانی می‌کنید خطایی برگرداند، اجرا باید متوقف شود و همان خطا (بدون تغییر) از تابع DivideFood برگردانده شود.

// For this example, we assume FodderAmount returns 50
// and FatteningFactor returns 1.5.
DivideFood(fodderCalculator, 5)
// => 15 <nil>

// Now assuming FodderAmount returns an error with message "something went wrong".
DivideFood(fodderCalculator, 5)
// => 0 "something went wrong"

2. بررسی تعداد گاوها

در حین انجام کار اول بالا، متوجه شدید کتابخانه‌ی خارجی‌ای که استفاده می‌کنید آن‌قدرها هم که فکر می‌کردید باکیفیت نیست. مثلاً نمی‌تواند ورودی‌های نامعتبر را درست مدیریت کند. می‌خواهید این محدودیت را با افزودن یک بررسی برای مقدار ورودی در کد خودتان دور بزنید.

تابعی به اسم ValidateInputAndDivideFood بنویسید که همان امضای DivideFood بالا را دارد.

• اگر تعداد گاوهای ورودی بزرگ‌تر از صفر باشد، تابع باید DivideFood را فراخوانی کند و نتیجه‌ی آن فراخوانی را برگرداند.
• اگر تعداد گاوها صفر یا کمتر باشد، تابع باید خطایی با پیام "invalid number of cows" برگرداند.

ValidateInputAndDivideFood(fodderCalculator, 5)
// => 15 <nil>

ValidateInputAndDivideFood(fodderCalculator, -2)
// => 0 "invalid number of cows"

3. بهبود مدیریت خطا

بررسی تعداد گاوها پیش از پاس دادنش کار خوبی بود، اما از پیام خطای غیراختصاصی چندان راضی نیستید. تصمیم می‌گیرید بهتر عمل کنید و یک نوع خطای سفارشی به اسم InvalidCowsError بسازید.

این خطای سفارشی باید تعداد گاوها (int) و یک پیام سفارشی (string) را نگه دارد، و متد Error باید داده‌ها را در قالب زیر سریالایز کند:

{number of cows} cows are invalid: {custom message}

با در دست داشتن خطای سفارشی‌تان، تابعی به اسم ValidateNumberOfCows پیاده‌سازی کنید که تعداد گاوها را به‌صورت عدد صحیح می‌پذیرد و یک خطا (یا nil) برمی‌گرداند.

• اگر تعداد گاوها کمتر از صفر باشد، تابع یک InvalidCowsError برمی‌گرداند که پیام سفارشی‌اش "there are no negative cows" تنظیم شده است.
• اگر تعداد گاوها صفر باشد، تابع یک InvalidCowsError برمی‌گرداند که پیام سفارشی‌اش "no cows don't need food" تنظیم شده است.
• در غیر این صورت، تابع nil برمی‌گرداند تا نشان دهد اعتبارسنجی موفق بوده است.

err := ValidateNumberOfCows(-5)
err.Error()
// => "-5 cows are invalid: there are no negative cows"

بعد از کار سخت راه‌اندازی این تابع اعتبارسنجی، متوجه می‌شوید که دیگر غروب شده است؛ از میزتان بلند می‌شوید تا از تماشای غروب خورشید روی کوه‌ها لذت ببرید. و کارِ واقعاً اضافه کردن تابع اعتبارسنجی جدید به کدتان را به روزی دیگر موکول می‌کنید.