Как определить собственный тип ошибки (custom error) в Go?

Для определения собственного типа ошибки в Go, необходимо создать новый тип, который реализует интерфейс ошибки. В Go стандартная библиотека предоставляет интерфейс error, который содержит всего один метод:

type error interface {
    Error() string
}

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

Шаги для создания собственного типа ошибки

1. Определите новый тип: Создайте новый тип, который может быть структурой или простым типом, в зависимости от ваших требований.

   Пример:

   type MyError struct {
       Message string
       Code    int
   }
   

2. Реализуйте интерфейс error: Для этого вам нужно добавить метод Error() string для вашего нового типа, который будет возвращать строку с описанием ошибки.

   Пример:

   func (e *MyError) Error() string {
       return fmt.Sprintf("Error %d: %s", e.Code, e.Message)
   }
   

3. Создайте экземпляр вашей ошибки: Вы можете создать экземпляр вашей пользовательской ошибки, когда это необходимо.

   Пример:

   func doSomething() error {
       return &MyError{
           Message: "Что-то пошло не так",
           Code:    404,
       }
   }
   

4. Обработка ошибки: При обработке ошибки, вы можете использовать type assertion или type switch, чтобы проверить, является ли ошибка вашей пользовательской ошибкой, и получить доступ к дополнительным полям.

   Пример:

   err := doSomething()
   if err != nil {
       if myErr, ok := err.(*MyError); ok {
           fmt.Printf("Пользовательская ошибка: %s\n", myErr.Error())
       } else {
           fmt.Println("Общая ошибка:", err)
       }
   }
   

Примеры использования

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

type APIError struct {
   StatusCode int
   Message    string
}

func (e *APIError) Error() string {
   return fmt.Sprintf("API Error %d: %s", e.StatusCode, e.Message)
}

func requestAPI() error {
   // Имитация ошибки
   return &APIError{
       StatusCode: 500,
       Message:    "Внутренняя ошибка сервера",
   }
}

Практические советы

• Используйте контекст: Добавление полей, таких как код ошибки или дополнительная информация, поможет в диагностике и устранении неисправностей.
• Обрабатывайте ошибки: Всегда проверяйте ошибки, возвращаемые функциями, и обрабатывайте их соответствующим образом.
• Соблюдайте стандарт: Если ваша ошибка может быть связана с внешними библиотеками, старайтесь придерживаться стандартных шаблонов форматирования ошибок.

Распространенные ошибки

• Не реализовать метод Error(): Самая распространенная ошибка — это не реализовать метод Error() для вашего типа.
• Не использовать указатели: Если вы не используете указатель для вашего типа ошибки, вы можете получить копию структуры, и изменения не будут видны при обработке.
• Смешивать пользовательские ошибки с общими: Используйте пользовательские ошибки для специфичных случаев, а стандартные ошибки для общих случаев.

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