Go: Ошибки

Ошибки в Go — это особенность языка, которая позволяет работать с неожиданным поведением кода в явном виде:

import "errors"

func validateName(name string) error {
	if name == "" {
		// errors.New создает новый объект ошибки
		return errors.New("empty name")
	}

	if len([]rune(name)) > 50 {
		return errors.New("a name cannot be more than 50 characters")
	}

	return nil
}

Тип error является интерфейсом. Интерфейс — это отдельный тип данных в Go, представляющий набор методов. Любая структура реализует интерфейс неявно через структурную типизацию. Структурная типизация (в динамических языках это называют утиной типизацией) — это связывание типа с реализацией во время компиляции без явного указания связи в коде:

package main

import (
	"fmt"
)

// объявление интерфейса
type Printer interface {
	Print()
}

// нигде не указано, что User реализует интерфейс Printer
type User struct {
	email string
}

// структура User имеет метод Print, как в интерфейсе Printer. Следовательно, во время компиляции запишется связь между User и Printer
func (u *User) Print() {
	fmt.Println("My email is", u.email)
}

// функция принимает как аргумент интерфейс Printer
func TestPrint(p Printer) {
	p.Print()
}

func main() {
	// в функцию TestPrint передается структура User, и так как она реализует интерфейс Printer, все работает без ошибок
	TestPrint(&User{email: "test@test.com"})
}

Интерфейс error содержит только один метод Error, который возвращает строковое представление ошибки:

// The error built-in interface type is the conventional interface for
// representing an error condition, with the nil value representing no error.
type error interface {
	Error() string
}

Следовательно, легко можно создавать свои реализации ошибок:

type TimeoutErr struct {
	msg string
}

// структура TimeoutErr реализует интерфейс error и может быть использована как обычная ошибка
func (e *TimeoutErr) Error() string {
	return e.msg
}

Следует запомнить, что если функция возвращает ошибку, то она всегда возвращается последним аргументом:

// функция возвращает несколько аргументов, и ошибка возвращается последней
func DoHTTPCall(r Request) (Response, error) {
	// ...
}

Нулевое значение для интерфейса — это пустое значение nil. Следовательно, когда код работает верно, возвращается nil вместо ошибки.

Задание

Для выполнения этого задания потребуется функция json.Unmarshal, которая декодирует JSON байты в структуру:

package main

import (
	"encoding/json"
	"fmt"
)

type HelloWorld struct {
	Hello string
}

func main() {
	hw := HelloWorld{}

	// первым аргументом передается JSON-строка в виде слайса байт. Вторым аргументом указатель на структуру, в которую нужно декодировать результат.
	err := json.Unmarshal([]byte("{\"hello\":\"world\"}"), &hw)

	fmt.Printf("error: %s, struct: %+v\n", err, hw) // error: %!s(<nil>), struct: {Hello:world}
}

В API методах часто используются запросы с телом в виде JSON. Такие тела нужно декодировать в структуры и валидировать. Хоть это и не лучшая практика делать функции, в которых происходит несколько действий, но для простоты примера реализуйте функцию DecodeAndValidateRequest(requestBody []byte) (CreateUserRequest, error), которая декодирует тело запроса из JSON в структуру CreateUserRequest и валидирует ее. Если приходит невалидный JSON или структура заполнена неверно, функция должна вернуть ошибку. Структура запроса:

type CreateUserRequest struct {
	Email                string `json:"email"`
	Password             string `json:"password"`
	PasswordConfirmation string `json:"password_confirmation"`
}

Список ошибок, которые нужно возвращать из функции:

// validation errors
var (
	errEmailRequired                = errors.New("email is required")                             // когда поле email не заполнено
	errPasswordRequired             = errors.New("password is required")                          // когда поле password не заполнено
	errPasswordConfirmationRequired = errors.New("password confirmation is required")             // когда поле password_confirmation не заполнено
	errPasswordDoesNotMatch         = errors.New("password does not match with the confirmation") // когда поля password и password_confirmation не совпадают
)

Примеры работы функции DecodeAndValidateRequest:

DecodeAndValidateRequest([]byte("{\"email\":\"\",\"password\":\"test\",\"password_confirmation\":\"test\"}"))
// CreateUserRequest{}, "email is required"

DecodeAndValidateRequest([]byte("{\"email\":\"test\",\"password\":\"\",\"password_confirmation\":\"test\"}"))
// CreateUserRequest{}, "password is required"

DecodeAndValidateRequest([]byte("{\"email\":\"test\",\"password\":\"test\",\"password_confirmation\":\"\"}"))
// CreateUserRequest{}, "password confirmation is required"

DecodeAndValidateRequest([]byte("{\"email\":\"test\",\"password\":\"test\",\"password_confirmation\":\"test2\"}"))
// CreateUserRequest{}, "password does not match with the confirmation"

DecodeAndValidateRequest([]byte("{\"email\":\"email@test.com\",\"password\":\"passwordtest\",\"password_confirmation\":\"passwordtest\"}"))
// CreateUserRequest{Email:"email@test.com", Password:"passwordtest", PasswordConfirmation:"passwordtest"}, nil