Skip to content

Модули ​

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

Модуль в WELD позволяет собирать код домена в одном месте, предоставляя доступ к API через одну или несколько точек входа. Несколько точек входа позволяют сохранить единый модуль как функциональную область, при этом предоставляя API, которые относятся к разным слоям.

Какую проблему решает ​

Модули и слои — разные оси архитектуры:

  • Модуль объединяет код одной функциональной области
  • Слои задают порядок зависимостей между частями приложения

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

Пример

Рассмотрим два модуля: auth, отвечающий за текущую сессию пользователя, и users, содержащий компоненты для работы с пользователями.

Модуль auth предоставляет виджет управления текущей сессией и хук для получения данных текущего пользователя. Модуль users содержит список пользователей и компонент аватара.

Компонент ProfileMenu должен отображать аватар текущего пользователя, поэтому ему нужен UserAvatar из модуля users. В свою очередь, UsersList может использовать useCurrentUser, чтобы выделять текущего пользователя в списке.

Таким образом, auth зависит от части users, а users — от части auth.

Если рассматривать только зависимости между модулями, возникает цикл зависимостей. Однако на уровне слоев зависимости направлены в одну сторону: widgets могут использовать entities, но не наоборот.

Слои модулей и слои приложения ​

Состав слоев — часть архитектуры конкретного проекта. WELD не навязывает универсальный набор: проект сам определяет, какие слои ему нужны и в каком порядке они располагаются.

Для описания архитектуры используются два списка:

  • layers задает слои приложения
  • moduleLayers задает слои модулей

Например, конфигурация:

layers: app, pages, @modules, common
moduleLayers: widgets, entities

задает следующий порядок слоев:

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

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

Модуль с одной точкой входа ​

Модуль с одной точкой входа имеет корневой баррель, и другие модули имеют права обращаться к нему только через этот баррель

Пример такого модуля:

Важно!

Взаимодействие дочерних модулей с родительскими описано в статье Вложенные модули

Модуль с несколькими точками входа ​

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

Пример такого модуля:

Файл users/widgets/nice-widget.ts, не является корректной точкой входа, т.к. вложенные директории и файлы не могут быть точками входа в модуль.

Слои внутри модуля ​

Принадлежность к слою задает первое имя на пути от корня модуля. Если это имя совпадает с именем слоя из moduleLayers, вся ветка модуля с этим именем относится к слою — целиком, на любой глубине внутри нее. Глубже слой не ищется: имена внутри ветки принадлежность не меняют.

При moduleLayers: widgets, entities в примере выше, директория users/widgets и все ее содержимое относится к слою widgets, а директория users/entities - к слою entities.

Даже если внутри widgets появится директория entities, она останется частью widgets: слой задается один раз, у входа в ветку.

Ветки модуля, чье имя не совпадает ни с одним слоем, не относятся ни к одному слою и стоят ниже всех слоев модуля.

Правила ​

  1. Модуль с центральной точкой входа имеет корневой баррель

    Если модуль предоставляет центральную точку входа, он должен иметь корневой index.ts, который и определяет публичный API. Внешние модули не должны обращаться к внутренним файлам такого модуля в обход барреля.

  2. Модуль с несколькими точками входа не имеет корневого барреля

    В этом случае точками входа становятся каталоги и файлы непосредственно внутри модуля. Каждый из них предоставляет отдельный интерфейс для потребителей.

  3. Слой задает имя ветки модуля

    Код относится к слою, если первое имя на пути от корня модуля совпадает с именем слоя из moduleLayers. Слой распространяется на всю ветку, а вложенные имена его не переопределяют.

  4. Ветки без слоя - ниже всех слоев модуля

    Ветки модуля, чье имя не совпадает ни с одним слоем из moduleLayers, не относятся ни к одному слою и стоят ниже всех слоев модуля.

  5. Модуль с центральной точкой входа ниже всех слоев модуля

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