Вложенные модули
Когда модуль становится слишком большим, его внутреннюю структуру можно выделить в более мелкие вложенные модули.
В WELD для этого предусмотрены вложенные модули. Они позволяют развивать внутреннюю структуру приложения, не превращая каждую новую область ответственности в модуль верхнего уровня.
Вложенность влияет не только на организацию кода, но и на доступность модулей друг для друга.
Фрактальность дерева модулей
Модули могут содержать вложенные (или дочерние) модули, а те — свои вложенные модули. При этом на каждом уровне действует одна и та же архитектурная модель.
Модули которые выше по дереву или в другой ветке называются внешними.
Например, в системе управления обучением модуль courses может содержать уроки и материалы курса, а каждый урок — упражнения:
Вложенные модули размещаются в отдельной поддиректории родительского модуля - modules. Она служит только контейнером: не является слоем и не имеет собственного публичного API. Имя контейнера определяется проектом.
Такое разделение позволяет отличать вложенные модули от остальных частей родительского модуля и не смешивать разные структурные сущности на одном уровне.
Видимость определяется иерархией
Дерево модулей ограничивает область видимости модуля: внутренние части одной ветки не видны для остальных веток.
Модулю доступны:
- предки - кто выше по дереву
- братья - соседи по дереву
- братья предков - соседи предков
- непосредственные дочерние модули
Так внутренняя структура модулей остается скрытой.
Пример видимости модуля materials:
В этой структуре materials может обращаться к модулям courses, lessons и students. А вот к exercises доступа нет, так как это уже внутренняя структура lessons.
Какую проблему решает
При росте функциональности важно контролировать публичный интерфейс, без потерь в удобстве внутренней реализации.
Родительский модуль не только объединяет и координирует вложенные модули, но и является фасадом к ним.
Фрактальность позволяет развивать внутреннюю структуру приложения постепенно, не усложняя саму архитектурную модель.
Правила
Вложенные модули размещаются в отдельной поддиректории
Для размещения вложенных модулей используется отдельная поддиректория родительского модуля, например
modules/. Она служит только контейнером: не является модулем сама по себе, не имеет собственных слоев и публичного API. Имя контейнера определяется конфигурацией проекта.Корень проекта устроен похожим образом: он содержит поддиректорию
modules/с модулями верхнего уровня. Однако сходство ограничивается организацией дерева — корень проекта не является модулем WELD.Видимость модулей определяется их положением в дереве
Модулю доступны его родительские модули, братья, братья его родителей и непосредственные дети. Остальные модули дерева недоступны.
Правило порядка слоев одинаково применяется ко всем модулям
Правило порядка слоев одинаково применяется ко всем модулям, в том числе вложенным.
Исключение
Родительский модуль может обращаться к непосредственному дочернему модулю, даже если они находятся на одном слое.
Хотя это противоречит правилу порядка слоев, но по осям Модуль и Слой вместе цикла нет.
Правильно
В примерах ниже порядок слой entities находится ниже widgets.
Импорт из родительского модуля
courses . lessons . exercises (widgets)
↓
courses . lessons (entities)
Импорт из модуля-дяди
courses . lessons . exercises (widgets)
↓
students (entities)
Импорт из непосредственного дочернего модуля
courses (widgets)
↓
courses . lessons (entities)
Импорт из непосредственного дочернего модуля (Исключение)
courses (entities)
↓
courses . lessons (entities)
Это единственное исключение, когда импорт разрешен на том же слое, так как цикл по осям "Модуль + Слой" не образуется (родитель владеет ребенком).
Неправильно
Нарушение иерархии
courses . materials (widgets)
↓
courses . lessons . exercises (entities)
materialsиlessons— братья. Ноexercisesявляется дочерним дляlessons. Доступ к дочерним модулям братских модулей ("племянникам") строго запрещен. Это ломает инкапсуляцию веткиlessons.
Нарушение порядка слоев
courses . lessons . exercises (entities)
↓
courses . materials (widgets)
Модуль
materialsдоступен (брат родителя), но слойwidgetsнаходится вышеentities. Импорт снизу вверх запрещен.
Импорт того же слоя
courses . lessons . exercises (entities)
↓
students (entities)
Модуль
studentsдоступен по иерархии, но оба файла находятся на слоеentities. Исключение "родитель ➔ ребенок" здесь не работает, так как это горизонтальная связь.
Рекомендации
Вложенные модули стоит выделять, когда домен представляет собой единое целое с точки зрения других модулей, но внутри него есть самостоятельные поддомены, не требующие отдельного доступа извне.
Желательно избегать глубокой вложенности: в большинстве случаев достаточно двух уровней. Более глубокая структура оправдана только при необходимости выделить устойчивые внутренние границы и сохранить читаемость дерева модулей. Не следует создавать дополнительные уровни ради технической группировки файлов.