Error handling in Go

• 원문: https://medium.com/rungo/error-handling-in-go-f0125de052f0

Go 언어 에러 핸들링

• Go에서는 에러 핸들링을 위한 try/catch 메소드를 지원하지 않는 대 에러는 정상적은 return value로 반환된다.

• 우리는 에러를 프로그램에 치명적인 무언가로 배웠지만 Go에서는 다른 의미를 가진다.

• Go에서의 에러는 함수가 예상치 못한 상황이 발생했을 때 반환하는 값일 뿐이다.

val, err := myFunction( args... );

if err != nil {
    // handle error
} else {
    // success
}

• error는 Go의 built-in 타입이고 zero value는 nil이다. 관용적으로 에러를 핸들링하는 방법은 에러를 함수의 마지막 return value로 반환하고 그것이 nil값인지 확인하는 것이다.

먼저 에러가 어떻게 생겼는지 확인하자.

type error interface {
    Error() string
}

에러는 인터페이스 타입이고 Error()메소드를 통해 에러 메세지를 리턴할 수 있다.

• 에러 인터페이스를 통해 우리만의 에러를 만들어보자

package main

import "fmt"

// 구조체 만들기 
type MyError struct{}

// Error메소드를 구현해주
func (myErr *MyError) Error() string {
    return "Something unexpected happend!"
}

func main() {
    
    myErr := &MyError{}
    
    fmt.Println(myErr)
    //참고로 Println()은 값이 에러라면 자동으로 Error()메소드를 호출한다.
}

조금 더 간단하게 만들어 보자

package main

import "fmt"
import "errors"

func main() {

    // create error
    myErr := errors.New("Sonething unexpected happend!")
    
    fmt.Println(myErr)
}

위 예제에서 New()를 통해 에러 메세지를 정해주었다. 그리고 에러 error 를 구현한 것이다.

그럼 myErr는 무슨 타입일까

fmt.Printf("Type of myErr is %T \n", myErr)
fmt.Printf("Value of myErr is %v \n", myErr)
-------------------------------------------------------
Type of myErr is *errors.errorString
Value of myErr is &errors.errorString{s:"Something unexpected happend!"}

여기서 myErr는 s라는 문자열 필드를 가진 구조체 errors.errorString의 포인터이다.

우리는 New함수가 s를 포함한 errorString struct를 반환하는것으로 추측할 수 있다. error 패키지를 확인해보자

type errorString struct {
    s string
}

func (e *errorString) Error() string {
    return e.s
}

func New(text string) error {
    return &errorString{text}
}
New함수는 s문자열을 포함하고 Error메소드를 구현 구조체를 반환한다는 것을 확인할 수 있다.

이제 에러 핸들링을 구현해볼 차례다

package main

import "fmt"
import "errors"

// divide two number
func Divide(a, int, b int) (int, error) {

    // can not divide by '0'
    if b == 0 {
        return 0, errors.New("Can not device by Zero!")
    } else {
        return (a / b), nil
    }
}

func main() {
    //divide 4 by 0
    if result, err := Divide(4, 0); err != nil {
        fmt.Println("Error occured: ", err)
    } else {
        fmt.Println("4/0 is", result)
    }
}
---------------------------------------------------------------------------------
Error occured: Can not devuce by Zero!

• 위 예제는 2개의 int를 받아서 나누기를 하는 함수이다. 그리고 0으로 나누는지를 확인하고 0이라면 non-nil error를 반환한다.

커스텀 에러

지금까지는 단순한 타입의 에러에 대해서 알아보았다. 하지만 실제 상황에서는 에러에 대한 더 많은 정보들이 필요다.

HTTP요청을 하는 경우 에러가 발생했다면 어떤 메소드로 요청을 했고, 상태코드가 궁금할 것이다. 가상의 403에러를 반환하는 함수를 작성해보자.

package main

import "fmt"

type HttpError struct {
    status int
    method string
}

func (httpError *HttpError) Error() string {
    return fmt.Sprintf("Something went wrong with the %v request. 
            Server returned %v status.", httpError.method, httpError.status)
}
// mock 함
func GetUserEmail(userid int) (string, error) {
    //return failed, return an error
    return "", &HttpError{403, "GET"}
}

func main() {
    //get user email address
    if email, err := GetUserEmail(1); err != nil {
        fmt.Println(err) //print error
        
        if errVal := err.(*HttpError); errVal.status == 403 {
            fmt.Println("Performing session cleaning...")
        }
    } else {
        // do something with the 'email'
        fmt.Println("User email is", email)
    }
}
---------------------------------------------------------------------------
Something went wrone with the GET request. Server returned 403 status.
Performing session cleaning...

• 우선 method, status 를 포함하는 HttpError 구조체를 만들었다.

• 여기서 Error 메소드는 상태코드와 메소드에 대한 정보를 같이 반환해 준다.

위 예제에서는 단순히 err.(*HttpError)를 사용 HttpError 한 종류의 에러에 대해서만 다루어보았다.

만약 여러기지의 에러 종류를 사용한다면 어떻게 다루어야 할까. - type switch에 대해 알아보

package main

import "fmt"

//network error
type NetworkError struct {}

func (e *NetworkError) Error() string{
    return "A network connection was aborted"
}

// file save fail error
type FileSaveFailedError struct {}

func (e *FileSaveFailedError) Error() string{
    return "The requested file could not be saved."
}

// a function that can return either of the above errors
func saveFileToRemote() error {
    result := 2 //mock result of save operation
    
    if result == 1 {
        return &NewNetworkError()
    } else if resutl == 2 {
        return &FileSaveFailedError{}
    } else {
        return nul
    }
}

func main() {
    // check type
    switch err := saveFileToRemote(); err.type {
        case nil:
            fmt.Println("File successfully saved.")
        case *NetworkError:
            fmt.Println("Network Error:", err)
        case *FileSavedFailedError:
            fmt.Println("File save Error:", err)
    }
} 
--------------------------------------------------------------------------
File save Error: The request file could not be saved.

위 예제에서는 NetworkError, FileSavedFailedError 2가지 타입의 에러가 있다.

saveFileToRemote 함수는 nil또는 2가지 에러중 어떤것이든 반환할 수 있다.

main함수에서는 type switch를 통해 우리가 어떤 종류의 에러가 일어났는지 확인할 수 있다.

Saving original error as a context

단순히 원래 있는 에러를 포함하고 싶다면 해당 에러를 포함하는 새로운 구조체를 만들면 된다.

package main

import "fmt"

//simple user unauthorized error
type UnauthorizedError struct {
    UserId int
    OriginalError error
}

// add some context to the original error message
func (httpErr *UnauthorizedError) Error() string {
    return fmt.Sprintf("User unauthorized Error: %v", httpErr.OriginalError)
}

// mock function call to validate user, returns error
func validateUser{ userId int } error {
    
    //mock general error from a function call: getSession(userId)
    err := fmt.Errorf("Session invalid for user id %d", userId)
    
    //return UnauthorizedError with original error
    return &UnauthorizedError{userId, err}
}

func main() {
    //validate user with id '1'
    err := validateUser(1)
    
     if err != nil {
         fmt.Println(err)
     } else {
         fmt.Println("User is allowed to perform this action!")
     }
 }
 --------------------------------------------------------------------
 User unauthorized Error: Session invalid for user id 1
  

위 예제에서는 OriginalError를 포함하는 UnauthorizedError struct를 만들었다.

Error 메소드 안에서는 %v 를 통해 httpErr.OriginalError의 Error메소드를 호출한다.

Error handling in GoMedium