re:re:actable
Урок 012 минуты чтения

Как разделить Express-приложение на слои?

На этой странице
Кратко

Маршрут описывает HTTP-адрес, контроллер переводит HTTP в вызов приложения, служба содержит правила, а репозиторий обращается к базе данных.

Вопрос

Как разделить Express-приложение на слои: маршрут, контроллер, служба и репозиторий? За что отвечает каждый?

Слои

route → controller → service → repository → PostgreSQL
  ↑                                           ↓
  └────────────── HTTP response ←─────────────┘
СлойОтветственность
МаршрутМетод, путь и цепочка обработчиков
Контроллерrequest, response, код ответа
СлужбаПрикладные правила и сценарий
РепозиторийDrizzle, SQL и строки базы

Структура по предметной области

src/
├── app.ts
├── server.ts
├── config/
│   └── env.ts
├── db/
│   ├── index.ts
│   └── schema.ts
├── middleware/
│   ├── error-handler.ts
│   └── not-found-handler.ts
└── modules/
    └── users/
        ├── users.schema.ts
        ├── users.routes.ts
        ├── users.controller.ts
        ├── users.service.ts
        └── users.repository.ts

Файлы одного ресурса находятся рядом, поэтому изменение пользователя не требует искать код по всему проекту.

Чего не должно быть в маршруте

// Трудно поддерживать: HTTP, проверка, правила и база смешаны.
router.post("/", async (request, response) => {
  // 80 строк проверки, SQL и обработки ошибок...
});

Понятнее:

router.post("/", validateBody(createUserSchema), createUser);

Не создавай слои ради слоёв

Для двух простых маршрутов достаточно routes.ts и repository.ts. Отдельная служба полезна, когда появляется:

  • прикладное правило;
  • несколько репозиториев;
  • транзакция;
  • повторное использование сценария;
  • необходимость модульного теста без HTTP.

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

Что важно помнить

  • Маршрут описывает адрес и цепочку обработчиков, контроллер переводит HTTP в вызов службы.
  • Служба содержит прикладные правила и не знает про request и response.
  • Репозиторий — единственное место, которое знает про Drizzle или SQL.
  • Код удобно группировать по предметной области (modules/users), а не по типу файла.
  • Для двух простых маршрутов отдельные слои не нужны — их добавляют, когда появляется ответственность.

Мини-шпаргалка

  • Маршрут описывает адрес.
  • Контроллер работает с HTTP.
  • Служба содержит прикладные правила.
  • Репозиторий обращается к данным.
  • Добавляй слой, когда у него появляется отдельная ответственность.

Документация

Express: Routing, Express: FAQ.

Дочитали до конца?
Отметьте урок — прогресс сохранится в браузере.

Поиск

Поиск по урокам