농장

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

코드를 작성하면서 오류 처리를 개선하게 돼요. 그러면 나중에 농장 일상에서 사용할 때 코드가 더 견고해지고 디버깅하기도 쉬워져요.

1. 음식을 똑같이 나누기

먼저 소 한 마리당 사료의 양을 계산하는 코드를 작성하는 데 집중해요.

FodderCalculator와 소의 수를 정수로 인자로 받는 함수 DivideFood를 구현해요. 이 과제에서는 전달되는 소의 수가 항상 0보다 크다고 가정해요. 이 함수는 소 한 마리당 먹이의 양을 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. 소의 수 확인하기

위의 첫 번째 과제를 하다 보면, 사용하는 외부 라이브러리가 생각만큼 품질이 좋지 않다는 걸 깨닫게 돼요. 예를 들어, 잘못된 입력을 제대로 처리하지 못해요. 이 한계를 피하려면 직접 작성하는 코드에서 입력값을 검사하는 부분을 추가하면 돼요.

위의 DivideFood와 시그니처가 같은 함수 ValidateInputAndDivideFood를 작성해요.

• 전달된 소의 수가 0보다 크면, 함수는 DivideFood를 호출하고 그 결과를 반환해야 해요.
• 소의 수가 0 이하이면, 함수는 "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}

사용자 정의 오류를 갖추었으니, 소의 수를 정수로 받고 오류(또는 nil)를 반환하는 함수 ValidateNumberOfCows를 구현해요.

• 소의 수가 0보다 작으면, 함수는 사용자 정의 메시지가 "there are no negative cows"로 설정된 InvalidCowsError를 반환해요.
• 소의 수가 0이면, 함수는 사용자 정의 메시지가 "no cows don't need food"로 설정된 InvalidCowsError를 반환해요.
• 그 외의 경우에는 검증이 성공했음을 나타내기 위해 함수가 nil을 반환해요.

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

이 검증 함수를 만드는 고된 작업을 끝내고 나면, 어느새 저녁이 된 걸 알아차리고 책상을 떠나 산 위로 지는 노을을 즐기러 가요. 새 검증 함수를 실제로 코드에 추가하는 일은 다음 날로 미뤄둬요.