Обработка ошибок в Express.js

Из-за неопределенного характера JavaScript существует множество способов выполнения одной задачи. Это может стать как достоинством, так и недостатком, особенно при работе в более крупной команде. Именно здесь в игру вступают процессы и руководящие принципы.

Предусловия

• Установленный NodeJS
• Знание NodeJS и Express.js
• Знание того, как работает middleware в Express.js

Настройка проекта

Создадим базовое приложение Express.js с одним эндпоинтом. Этот эндпоинт (или ручка) будет методом POST, который принимает два входных параметра title и author.

const express = require('express');
const bodyParser = require('body-parser');

const app = express();
const port = 3000;

app.use(bodyParser.json());

app.post('/post', async (req, res) => {
  const { title, author } = req.body;

  if (!title || !author) {
    return res.status(400).json({
      status: 'error',
      message: 'Missing required fields: title or author'
    });
  }

  try {
    const post = await db.post.insert({ title, author });
    res.json(post);
  } catch (error) {
    return res.status(500).json({
      status: 'error',
      message: 'Internal Server Error'
    });
  }
});

app.listen(port, () =>
  console.log(`app is listening at http://localhost:${port}`)
);

Мы проверяем, существуют ли title и author, если нет, мы выбрасываем ошибку 400 и отправляем обратно JSON со статусом и сообщением. Если title и author существуют, приложение все равно будет аварийно завершать работу, потому что db не определена, и наш блок try/catch поймает его и отправит обратно ошибку 500 и JSON со статусом и сообщением. Со временем, по мере роста количества эндпоинтов и проверок, ввод res.status(4xx).json({ some: JSON }) каждый раз может быстро стать громоздким, а также создать большую избыточность кода. Почему бы не сделать что-то вроде throw new BadRequest('message')? Давайте посмотрим, как мы можем это реализовать.

Создание утилит для ошибок

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

// /utils/errors.js

class GeneralError extends Error {
  constructor(message) {
    super();
    this.message = message;
  }

  getCode() {
    if (this instanceof BadRequest) {
      return 400;
    } if (this instanceof NotFound) {
      return 404;
    }
    return 500;
  }
}

class BadRequest extends GeneralError { }
class NotFound extends GeneralError { }

module.exports = {
  GeneralError,
  BadRequest,
  NotFound
};

Этот файл определяет, какие ошибки мы можем выбросить в нашем приложении. Класс GeneralError расширяет Error и используется для получения наших сообщений и кодов состояния. Здесь у нас есть BadRequest и NotFound, которые расширяют GeneralError. Мы также указываем их коды ошибок в блоке getCode в GeneralError. Для простоты этой демонстрации у нас будут толькоBadRequest и NotFound. Если вы хотите добавить другие типы ошибок, все, что вам нужно сделать, это создать новый класс, который расширяет GeneralError и обновить его код состояния внутри блока getCode.

Создание middleware для обработки ошибок

Теперь мы сосредоточимся на реализации express middleware для обработки ошибок в нашем приложении. Создадим новый файл /middleware/handleErrors.js.

// /middleware/handleErrors.js

const { GeneralError } = require('../utils/errors');

const handleErrors = (err, req, res, next) => {
  if (err instanceof GeneralError) {
    return res.status(err.getCode()).json({
      status: 'error',
      message: err.message
    });
  }

  return res.status(500).json({
    status: 'error',
    message: err.message
  });
}


module.exports = handleErrors;

Примечание: middleware для обработки ошибок принимает 4 аргумента (ошибка в качестве первого аргумента), а не 3 аргумента для обычного middleware . Функция middleware handleErrors проверяет, является ли переданная ошибка экземпляром GeneralError. Если это так, мы возвращаем код состояния и тело JSON со статусом и сообщением.

Использование middleware для обработки ошибок

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

const express = require('express');
const bodyParser = require('body-parser');
const handleErrors = require('./middleware/handleErrors');
const { BadRequest } = require('./utils/errors');

const app = express();
const port = 3000;

app.use(bodyParser.json());

app.post('/post', async (req, res, next) => {
  const { title, author } = req.body;
  
  try {
    if (!title || !author) {
      throw new BadRequest('Missing required fields: title or author');  // строка 16
    }
    const post = await db.post.insert({ title, author });
    res.json(post);
  } catch (err) {
    next(err)
  }
});

app.use(handleErrors); // строка 25

app.listen(port, () =>
  console.log(`app is listening at http://localhost:${port}`)
);

Во-первых, мы импортируем handleErrors и регистрируем его как middleware, как показано в строке 25. Мы также импортируем BadReqest и обновляем строку 16, чтобы выбросить новый BadRequest, если title и author отсутствуют. Наконец, мы добавляем next в качестве третьего аргумента в наш обработчик маршрута. Затем мы обновляем блок catch, чтобы передать ошибки в next чтобы наш обработчик ошибок мог обработать его.

Тестирование middleware для обработки ошибок

Для тестирования middleware используем Postman. Сначала мы делаем POST-запрос без body. Мы получаем ошибку 400 со статусом и сообщением в формате JSON.

{
  "status": "error",
  "message": "Missing required fields: title or author"
}

Теперь давайте сделаем еще один запрос POST и передадим title и author. На этот раз мы получаем ошибку 500 со статусом и сообщением в JSON.

{
  "status": "error",
  "message": "db is not defined"
}

Простое и чистое решение для обработки ошибок в приложении Express.js.

Итоги

В этой статье мы рассмотрели, как создать middleware для обработки ошибок для приложения Express.js. Это позволит поддерживать чистоту кода с меньшим количеством избыточного кода. Все, что нам нужно сделать, это выбросить ошибку и передать сообщение. Эта реализация добавляет гибкость для добавления дополнительных классов ошибок для вашего приложения по мере необходимости.

Простые проекты

1. Приложение «Список дел» (Todo list)

Приложение «Список дел» — это простой, но важный проект для любого разработчика. Это позволяет вам создать список задач и упорядочить их на основе их приоритета и сроков выполнения. Данный проект может быть реализован с использованием различных технологий и фреймворков, что делает его отличной возможностью как для начинающих, так и для продвинутых разработчиков попрактиковаться в своих навыках. Вот несколько идей для функций, которые можно добавить в приложение со списком дел:

• Теги и категории: Разрешить пользователям классифицировать задачи на основе тегов или категорий (например, работа, личные, поручения), чтобы помочь им организовать свой список дел.
• Автоматическое сохранение: автоматическое сохранение элементов списка дел в локальном хранилище каждый раз, когда вносятся изменения, чтобы пользователю не приходилось беспокоиться о сохранении списка вручную.
• Поиск: добавьте в приложение панель поиска, которая может искать элементы в списке дел и сохранять историю поиска пользователя в локальном хранилище.

2. Веб-сайт личного портфолио

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

3. Генератор случайных цитат

Генератор случайных цитат — это простое веб-приложение, которое генерирует случайные цитаты или высказывания при нажатии кнопки. Этот проект может стать отличным способом попрактиковаться в навыках веб-разработки, включая получение данных из API, отображение динамического контента и стилизацию с помощью CSS. Пользовательский интерфейс может включать в себя простой дизайн с кнопкой и пространством для отображения предложения.

4. Простой калькулятор

Простой калькулятор — это проект, который может стать отличным способом для разработчиков попрактиковаться в своих навыках в JavaScript и HTML/CSS. Проект включает в себя создание калькулятора, который может выполнять основные математические операции, такие как сложение, вычитание, умножение и деление. Калькулятор должен иметь простой пользовательский интерфейс с кнопками для каждого из чисел, операторами и понятной функцией. Калькулятор также должен обрабатывать ввод как с клавиатуры, так и с мыши. Чтобы немного усложнить проект, разработчики также могут включить дополнительные функции, такие как функция десятичной запятой, процентные вычисления и функции памяти. Калькулятор также можно стилизовать, чтобы сделать его визуально привлекательным и отзывчивым на разных устройствах.

5. Приложение «Погода»

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

Проекты средней сложности

1. Веб-сайт электронной коммерции (E-commerce)

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

2. Социальная сеть

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

3. Онлайн чат

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

4. Отслеживание расходов

Это приложение для управления финансами, которое позволяет пользователям отслеживать свои расходы и управлять своим бюджетом. Некоторые функции, которые можно добавить в трекер расходов:

• Категоризация: категоризация расходов, чтобы дать пользователям представление о том, куда они тратят свои деньги.
• Бюджетирования: Возможность установить бюджет для разных категорий и отслеживать расходы по нему.
• Визуализация данных: Предоставьте пользователям графики и диаграммы, которые визуализируют их расходы по категориям или периодам времени, давая им четкое представление об их привычках и моделях расходов.

5. Рецепты

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

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

Трудные проекты

1. Чат-бот с искусственным интеллектом

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

2. Веб-сайт потокового видео

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

• Категоризация контента: категоризация видео на основе их жанра, языка, продолжительности и других параметров, чтобы помочь пользователям легко найти контент, который они ищут.
• Профили пользователей и плейлисты: позволяют пользователям создавать свои собственные профили и плейлисты, сохранять видео для последующего просмотра и делиться своими любимыми видео с другими.
• Управление качеством видео и воспроизведением: Обеспечение высококачественной потоковой передачи видео с настраиваемыми элементами управления воспроизведением, такими как воспроизведение, пауза, перемотка назад и вперед.

3. Веб-сайт доски объявлений

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

• Фильтры расширенного поиска: позволяют соискателям фильтровать свой поиск по различным критериям, таким как тип работы, местоположение, уровень опыта и диапазон заработной платы.
• Оповещения о вакансиях: разрешите пользователям подписываться на электронную почту или push-уведомления о публикации новых вакансий, соответствующих их критериям.
• Конструктор резюме: инструмент, который позволяет соискателям создавать профессиональное резюме для подачи вместе с заявлением о приеме на работу.

4. Онлайн-редактор кода

Онлайн-редактор кода — это веб-приложение, которое позволяет разработчикам писать, редактировать и тестировать свой код прямо в браузере. Он предоставляет пользователям платформу для экспериментов с различными языками программирования и фреймворками, а также позволяет сотрудничать с другими разработчиками в режиме реального времени. Добавляемые функции:

• Подсветка синтаксиса: редактор должен выделить синтаксис кода, чтобы его было легче читать и понимать.
• Автозаполнение: Редактор должен предлагать фрагменты кода и автозаполнение кода, чтобы сэкономить время и свести к минимуму ошибки.
• Поддержка нескольких языков: редактор должен поддерживать несколько языков программирования, чтобы сделать его универсальным и полезным для более широкого круга разработчиков.

5. Платформа для ведения блогов

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

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

Еще идеи

Смотреть на Rutube