Как вернуть сообщение об ошибке?

Как вернуть сообщение об ошибке в Go

В Go ошибки представлены интерфейсом error, который является одним из фундаментальных элементов языка. Возвращение и обработка ошибок — центральная часть философии Go, способствующая написанию надежного и понятного кода.

Основные подходы возвращения ошибок

1. Возвращение ошибки как последнего возвращаемого значения

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

func Divide(a, b float64) (float64, error) {
    if b == 0 {
        return 0, errors.New("деление на ноль")
    }
    return a / b, nil
}

2. Использование стандартного пакета errors

Пакет errors предоставляет базовые функции для создания ошибок.

import "errors"

func OpenFile(filename string) (*File, error) {
    if filename == "" {
        return nil, errors.New("имя файла не может быть пустым")
    }
    // ... логика открытия файла
}

3. Создание форматированных ошибок с fmt.Errorf

Для создания ошибок с динамическим сообщением удобно использовать fmt.Errorf. Она позволяет включать в сообщение контекст, например, значения переменных.

func ProcessUser(id int) error {
    if id <= 0 {
        return fmt.Errorf("неверный ID пользователя: %d", id)
    }
    // ... обработка
}

4. Добавление контекста к существующим ошибкам с Wrap

С помощью errors.Wrap (или fmt.Errorf с %w) можно оборачивать исходную ошибку, добавляя дополнительный контекст, сохраняя при этом возможность восстановить исходную ошибку через errors.Unwrap.

import "github.com/pkg/errors" // или стандартный пакет с Go 1.13

func ReadConfig() error {
    data, err := ioutil.ReadFile("config.json")
    if err != nil {
        return errors.Wrap(err, "не удалось прочитать конфигурационный файл")
    }
    // ... обработка data
}

В стандартной библиотеке (Go 1.13+):

func ReadConfig() error {
    data, err := os.ReadFile("config.json")
    if err != nil {
        return fmt.Errorf("не удалось прочитать конфигурационный файл: %w", err)
    }
    // ...
}

5. Создание типизированных ошибок с помощью собственных типов

Определение собственных типов ошибок позволяет проводить более точную проверку и обработку ошибок через type assertion или errors.Is/errors.As.

type NotFoundError struct {
    Resource string
}

func (e *NotFoundError) Error() string {
    return fmt.Sprintf("ресурс '%s' не найден", e.Resource)
}

func FindUser(name string) (*User, error) {
    if !exists(name) {
        return nil, &NotFoundError{Resource: name}
    }
    // ...
}

Проверка и обработка возвращенных ошибок

После получения ошибки её необходимо проверить. Для проверки типов ошибок в современном Go используются функции errors.Is и errors.As.

err := FindUser("Alice")
if err != nil {
    // Проверка на конкретный тип ошибки
    var notFound *NotFoundError
    if errors.As(err, &notFound) {
        log.Printf("Не найден: %s", notFound.Resource)
    }
    
    // Проверка на конкретное значение ошибки
    if errors.Is(err, io.EOF) {
        log.Println("Достигнут конец файла")
    }
}

Ключевые принципы и рекомендации

• Ясность сообщений: Сообщения об ошибках должны быть информативными, помогая понять, что произошло и где.
• Сохранение цепочки: Используйте оборачивание ошибок (%w) для построения цепочки контекстов, но избегайте чрезмерного оборачивания.
• Индикация типа: Для ошибок, требующих специфичной обработки, создавайте собственные типы, реализуя интерфейс error.
• Не игнорируйте ошибки: Каждая возвращенная ошибка должна быть явно проверена или, в редких случаях, сознательно игнорирована с комментарием.
• Логирование vs возвращение: Различайте ошибки, которые должны быть возвращены клиенту функции, и внутренние ошибки, которые могут быть залогированы для диагностики.

Возвращение ошибок в Go — это не просто технический механизм, но и способ структурирования логики программы, делая её более устойчивой и понятной для разработчиков.