Опубликовано в Профессии

Модульный монолит для учебного проекта: где провести границы

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

Время чтения: 5 мин.

Для учебного backend-проекта модульный монолит позволяет разделить обязанности, сохранив одно приложение и простой запуск. Границы модулей полезны, когда они ограничивают доступ к данным и делают понятным изменение конкретного правила. Сам набор каталогов такой границы ещё не создаёт.

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

Отдели развёртывание от логического устройства

Монолит обычно развёртывается как единое приложение. При этом внутри могут существовать несколько частей с разными правилами. В обзоре архитектур Microsoft эти свойства рассматриваются отдельно: единица развёртывания и внутреннее логическое разделение не обязаны совпадать.

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

Опиши работу приложения одним абзацем, затем выпиши части с собственными решениями. Расписание отвечает на вопросы о времени и вместимости. Бронирование определяет, кто занимает место и какие переходы состояния разрешены. Уведомление занимается подготовкой и отправкой сообщения о результате.

Если несколько названий обозначают один и тот же набор правил, пока оставь их вместе. Ранняя граница должна объяснять конкретное ограничение зависимости. Модуль, который существует только потому, что так выглядит чужая схема, создаёт работу без понятной пользы.

Найди владельца каждого изменения

Пройди действие «записаться на занятие» и для каждого изменения назови владельца. Кто проверяет вместимость? Кто решает, можно ли отменить бронь? Кто знает адрес доставки сообщения? Это важнее названий классов и файлов на первом этапе.

Предположим, правило последнего свободного места принадлежит бронированию. Тогда остальные части запрашивают операцию бронирования через его контракт, а не изменяют счётчик мест напрямую. Иначе одинаковое правило придётся помнить во всех местах, где встречается нужная таблица.

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

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

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

Сохрани целостность одной операции

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

Учебник PostgreSQL о транзакциях объясняет объединение нескольких изменений в целую операцию. Для бронирования важно определить, какие данные должны сохраняться совместно и какое состояние остаётся при отказе. Детали зависят от схемы и выбранного уровня изоляции.

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

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

Проведи границу в коде и импортах

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

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

Составь короткую карту: HTTP вызывает приложение, приложение обращается к бронированию, а бронирование использует определённые операции хранилища. Отметь обратные зависимости. Если для объявления простого типа нужна циклическая связь, попробуй пересмотреть направление контракта.

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

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

Проверь границу изменением требования

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

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

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

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

Сохрани одну короткую запись о границе: какие данные скрыты, кто принимает решение и как его проверить. Если позже контракт придётся расширить, сравни новую потребность с этой записью. Так будет видно, изменились требования или первоначальная граница была проведена по случайному техническому признаку.

Оставь архитектуру соразмерной проекту

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

На разбор подготовь один пользовательский сценарий, карту зависимостей и пример требования, которое добавлял после первой версии. Покажи, где граница помогла и где потребовала лишней работы. Такой материал позволяет обсуждать устройство приложения предметно.

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

Обсуди границы своего приложения

Покажи один пользовательский сценарий, зависимости модулей и изменение требования. Выбери backend-ментора для предметного разбора решений.

Выбрать ментора