✅ Чек-лист по обработке ошибок и исключений в C#

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

1. Используйте try-catch блоки для обработки исключений

• Оборачивайте код, который может вызвать исключение, в блок try

• В блоке catch обрабатывайте конкретные типы исключений, чтобы избежать перехвата всех ошибок.

{
    // Код, который может вызвать исключение
}
catch (SpecificException ex)
{
    // Обработка конкретного исключения
}

2. Обрабатывайте только те исключения, которые вы можете корректно обработать.

3. Логируйте исключения для диагностики

• Записывайте подробную информацию о возникшем исключении: тип ошибки, сообщение, стек вызовов.

• Используйте библиотеки логирования: Serilog, NLog, Log4Net.

catch (Exception ex)
{
    logger.Error(ex, "Произошла ошибка");
}

4. Используйте блок finally для выполнения очистки

Блок finally выполняется всегда, независимо от того, возникло исключение или нет. Используйте его для освобождения ресурсов (например, закрытие файлов или соединений).

{
    // Ваш код
}
catch (Exception ex)
{
    // Обработка ошибки
}
finally
{
    // Очистка ресурсов
}

5. Создавайте собственные исключения

При необходимости создавайте свои собственные типы исключений для лучшей организации обработки ошибок.

public class CustomException : Exception
{
    public CustomException(string message) : base(message) { }
}

6. Не выбрасывайте исключения с пустыми сообщениями

Если вы выбрасываете исключение, всегда указывайте подробное сообщение, чтобы помочь диагностировать проблему.

throw new ArgumentNullException("parameterName", "Параметр не может быть null");

7. Используйте throw для повторного выбрасывания исключений

В случае, если вы хотите обработать исключение, но также передать его дальше, используйте throw без параметров, чтобы сохранить стек вызовов.

8. Не используйте исключения для обычного потока выполнения

Исключения должны использоваться для неожиданных или критических ошибок. Не используйте их для управления потоком выполнения (например, не используйте try-catch для проверки условий).

9. Используйте AggregateException для обработки нескольких исключений

Если вы работаете с задачами и несколько исключений могут быть выброшены одновременно, используйте AggregateException для их обработки.

{
    // Асинхронный код
}
catch (AggregateException ex)
{
    foreach (var innerEx in ex.InnerExceptions)
    {
        // Логирование каждого исключения
    }
}

10. Планируйте стратегию обработки ошибок в продакшн-среде

В продакшн-среде важно минимизировать влияние ошибок на пользователя. Рассмотрите возможность использования retry-логики или fallback-методов.

public async Task<T> RetryAsync<T>(Func<Task<T>> action)
{
    int retries = 3;
    while (retries > 0)
    {
        try
        {
            return await action();
        }
        catch
        {
            retries--;
            if (retries == 0) throw;
        }
    }
}

Этот чек-лист поможет вам правильно и эффективно обрабатывать ошибки и исключения в C#-проекте.

🐸Библиотека шарписта #буст