Перейти к содержимому

Избыточные сущности

Слой entities в Feature-Sliced Design относится к нижним слоям и предназначен прежде всего для бизнес-логики. К нему могут обращаться все слои, кроме shared. Из-за такой широкой доступности изменения в entities могут затронуть многие части приложения. Поэтому этот слой нужно тщательно проектировать, чтобы избежать дорогостоящего рефакторинга.

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

0. Подумайте, можно ли обойтись без слоя entities

Заголовок раздела «0. Подумайте, можно ли обойтись без слоя entities»

Может показаться, что без этого слоя приложение не будет соответствовать Feature-Sliced Design, но отсутствие слоя entities вполне допустимо. Это никак не нарушает правила FSD. Напротив, архитектура становится проще, а слой entities можно добавить позже, когда потребуется масштабировать приложение. Например, если ваше приложение работает как тонкий клиент, этот слой ему, скорее всего, не нужен.

1. Избегайте преждевременного выделения слайсов

Заголовок раздела «1. Избегайте преждевременного выделения слайсов»

В отличие от предыдущих версий, FSD 2.1 рекомендует откладывать декомпозицию на слайсы, а не проводить её заранее. Это относится и к слою entities. На первых этапах можно разместить весь код в сегменте model страницы, виджета или фичи, а к рефакторингу вернуться позже, когда бизнес-требования устоятся.

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

Не создавайте отдельную сущность для каждого фрагмента бизнес-логики. Вместо этого используйте типы из shared/api, а логику размещайте в сегменте model текущего слайса. Бизнес-логику, которая нужна в нескольких местах, размещайте в сегменте model слайса сущности, оставляя определения данных в shared/api:

  • Директорияentities
    • Директорияorder
      • index.ts
      • Директорияmodel
        • apply-discount.ts Бизнес-логика, использующая OrderDto из shared/api
  • Директорияshared
    • Директорияapi
      • index.ts
      • Директорияendpoints
        • order.ts

CRUD-операции необходимы, но часто представляют собой шаблонный код без существенной бизнес-логики. В слое entities такой код может создавать лишний шум и мешать находить важную логику. Вместо этого размещайте CRUD-операции в shared/api:

  • Директорияshared
    • Директорияapi
      • client.ts
      • index.ts
      • Директорияendpoints
        • order.ts Все CRUD-операции, связанные с заказами
        • products.ts
        • cart.ts

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

Для данных аутентификации, например токенов или пользовательских DTO, полученных от сервера, лучше использовать слой shared, а не создавать сущность user. Эти данные привязаны к конкретному контексту и вряд ли понадобятся за пределами аутентификации:

  • Ответы на запросы аутентификации, например токены или DTO, часто не содержат полей, необходимых для более широкого использования, или различаются в зависимости от контекста, например для приватного и публичного профилей пользователя.
  • Хранение данных аутентификации в сущностях может привести к импортам между слоями, например из entities в shared, или к использованию @x нотации, что усложняет архитектуру.

Вместо этого храните данные аутентификации в shared/auth или shared/api:

  • Директорияshared
    • Директорияauth
      • use-auth.ts Данные аутентифицированного пользователя или токен
      • index.ts
    • Директорияapi
      • client.ts
      • index.ts
      • Директорияendpoints
        • order.ts

Подробнее о реализации аутентификации читайте в руководстве по аутентификации.

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

Неизолированный бизнес-контекст (не рекомендуется):

  • Директорияentities
    • Директорияorder
      • Директория@x/
        • …
      • Директорияmodel/
        • …
    • Директорияorder-item
      • Директория@x/
        • …
      • Директорияmodel/
        • …
    • Директорияorder-customer-info
      • Директория@x/
        • …
      • Директорияmodel/
        • …

Изолированный бизнес-контекст (рекомендуется):

  • Директорияentities
    • Директорияorder-info
      • index.ts
      • Директорияmodel
        • order-info.ts

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