Лабораторная работа 2. Разработка модульной структуры проекта (диаграммы модулей) (1)

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

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

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

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

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

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

Модуль — это элемент программного проекта, имеющий чётко очерченную
область ответственности и единый интерфейс взаимодействия с другими
модулями.
Ключевое свойство модуля — минимизация внутренней сложности и
максимизация независимости от внешних факторов.
Каждый модуль должен иметь единственную ответственность. Нарушение
этого принципа ведет к путанице, высокой сложности тестирования и рискам
дублирования функционала.
Управление структурой модулей обеспечивается применением
специализированных шаблонов проектирования (паттернов), таких как MVC,
MVVM, Clean Architecture и др., позволяющих поддерживать чистоту и
прозрачность связей между компонентами.

5. Проектирование и разработка диаграмм модулей

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

6. Проектирование и разработка диаграмм модулей

При создании диаграмм важно соблюдать ряд правил, обеспечивающих
ясность и читаемость документа:
1. Стандартизация обозначений
Используйте стандартные обозначения, рекомендованные отраслевыми
стандартами, такими как UML (Unified Modeling Language). Применение
стандартных символов делает схему понятной даже незнакомым
специалистам.
2. Минимизация количества уровней вложенности
Избегайте чрезмерной иерархичности схемы, особенно глубоких уровней
вложенности. Рекомендуется ограничивать число уровней тремя-пятью, чтобы
схема оставалась удобной для восприятия.
3. Четкая группировка модулей
Объединяйте схожие модули в группы и размещайте их рядом друг с другом,
чтобы показать логическую близость. Используйте цвета или рамки для
выделения кластеров.

7. Проектирование и разработка диаграмм модулей

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

8. Проектирование и разработка диаграмм модулей

Создание качественной диаграммы требует соблюдения последовательных
этапов:
Шаг 1. Постановка целей
Определите цель разработки диаграммы. Нужно ли вам описать текущую
систему или спланировать новую архитектуру? Какие именно вопросы должно
решить ваше исследование?
Шаг 2. Сбор информации
Соберите всю необходимую информацию о проекте, включая требования,
ограничения и предположения. Проверьте документацию, спецификации и
прототипы, чтобы лучше понять контекст.
Шаг 3. Формирование набора модулей
Выделите основные модули исходя из поставленных задач и целей проекта.
Определите зоны ответственности каждого модуля и распределите функции
между ними.

9. Проектирование и разработка диаграмм модулей

Шаг 4. Выявление интерфейсов и зависимостей
Опишите все необходимые интерфейсы и каналы взаимодействия между
модулями. Определяйте типы передач (синхронные/асинхронные), формулы
сообщений и форматы данных.
Шаг 5. Оформление и дизайн
Оформляйте диаграмму согласно принятым стандартам и правилам.
Используемый редактор должен обеспечивать лёгкую модификацию и
поддержку версий.
Шаг 6. Проверка и утверждение
Проверьте вашу диаграмму на предмет полноты, правильности и соответствия
требованиям. Получите одобрение команды и руководителя проекта.

10. Unified Modeling Language (UML)

Наиболее популярным стандартом для создания диаграмм модулей является
UML. Среди множества типов диаграмм, входящих в состав UML, особо
выделяются:
• Компонентная диаграмма (Component diagram) — демонстрирует
компоненты системы и их связи.
• Диаграмма развертывания (Deployment diagram) — показывает физические
узлы сети и размещение компонентов на них.
• Структура классов (Class diagram) — отражает классы и их
взаимоотношения, хотя применяется чаще всего для объектноориентированного проектирования.
Использование стандарта UML обеспечивает унифицированный подход к
представлению моделей, поддерживаемый большинством CASE-инструментов
и систем автоматизации разработки.

11. Оптимизация и рефакторинг модульной структуры

Оптимизация и рефакторинг модульной структуры направлены на повышение
эффективности, надёжности и простоты сопровождения программного
проекта.
Эти процессы позволяют устранить недостатки первоначальной архитектуры,
сделать систему устойчивее к изменениям и быстрее адаптироваться к новым
условиям.
Существуют ситуации, в которых обязательно требуется провести
оптимизацию и рефакторинг модульной структуры:
• Система становится трудноуправляемой вследствие сложного
взаимодействия модулей.
• Возникают частые сбои и конфликты между модулями.
• Время отклика системы ухудшается.
• Расширение функционала затруднено из-за жёстких ограничений
архитектуры.
• Стоимость поддержки и модернизации резко возрастает.
Любая из перечисленных ситуаций свидетельствует о проблемах в
архитектуре и призывает к проведению оптимизации.

12. Оптимизация и рефакторинг модульной структуры

Для достижения улучшений применяются следующие техники:
1. Деление крупных модулей на мелкие
Крупные монолитные модули целесообразно разбивать на меньшие
специализированные компоненты.
2. Сокращение избыточных зависимостей
Удаляют ненужные связи между модулями, чтобы уменьшить сцеплённость и
минимизировать влияние изменений одного модуля на другие.
3. Увеличение числа абстрактных интерфейсов
Создаются промежуточные слои абстракции, снижающие непосредственное
взаимодействие модулей и повышающие гибкость архитектуры.
4. Асинхронное выполнение операций
Переработка синхронных алгоритмов в асинхронные увеличивает
производительность и отзывчивость системы.
5. Удаление устаревших или неиспользуемых модулей
Отказ от лишнего кода освобождает ресурсы и сокращает временные издержки
на поддержку.

13. Оптимизация и рефакторинг модульной структуры

Рефакторинг — целенаправленное изменение внутренней структуры кода без
изменения внешней функциональности. Его главная задача — подготовить
систему к будущему развитию и улучшению характеристик.
Примеры эффективных приёмов рефакторинга:
• Переименование сущностей: смена названия модулей и переменных для
лучшего отражения их роли и содержания.
• Упрощение условий: сокращение количества ветвей и условия логики,
приводящие к снижению сложности.
• Экстракт-класс (Extract Class): выделение повторяющегося фрагмента кода в
новый класс.
• Инкапсуляция полей: защита внутренних данных класса от прямого доступа
извне.
• Замена наследования делегированием: снижение хрупкости иерархической
структуры классов посредством использования композиции.
Эффективный рефакторинг позволяет добиться следующих результатов:
• Более стабильная система, менее подверженная ошибкам.
• Устойчивость к будущим изменениям.
• Снижение стоимости поддержания и развития проекта.

14. Оптимизация и рефакторинг модульной структуры

Несмотря на очевидные плюсы, оптимизация и рефакторинг несут некоторые
риски:
• Возникновение регрессий: исправляя одну проблему, можно случайно
внести новые ошибки.
• Рост временных затрат: значительный объём работы, необходимой для
тщательного планирования и аккуратного исполнения.
• Непредсказуемые последствия: непредвиденные эффекты от внесённых
изменений.
Чтобы минимизировать риски, следуют следующим рекомендациям:
• Создавать резервные копии исходного состояния системы.
• Регулярно запускать тесты после внесения изменений.
• Применять постепенный подход к рефакторингу, осуществляя поэтапные
изменения.
• Проводить регулярный code review с участием коллег.
Таким образом, грамотно проведённая оптимизация и рефакторинг способны
превратить сложную и труднопонимаемую систему в стройную, эффективную и
простую в поддержке конструкцию.

15. Практическое задание:

Задание:
Выберите два модуля из предложенных и реализуйте UML-диаграмму
последовательности.
Список модулей:
1. Модуль Авторизации (AuthModule)
• Описание: Отвечает за проверку подлинности пользователей и
предоставление доступа к защищённым ресурсам.
• Задача: Осуществляет аутентификацию пользователей с помощью разных
способов входа (логин + пароль, токены OAuth, социальные сети и т.д.).
• Взаимодействие: Предоставляет API-интерфейсы для других модулей
(например, UserManagement, Security).
2. Модуль Управления Пользователями (UserManagementModule)
• Описание: Управляет регистрацией, профилем и настройками
пользователей.
• Задача: Добавляет, удаляет и обновляет профили пользователей, управляет
ролями и правами доступа.
• Взаимодействие: Сотрудничает с модулем авторизации (AuthModule), базой
данных (Database) и уведомлениями (NotificationService).

16. Практическое задание:

3. Модуль Безопасности (SecurityModule)
• Описание: Обеспечивает защиту от несанкционированного доступа и атак.
• Задача: Выполняет шифрование данных, защиту паролей, предотвращение
SQL-инъекций и XSS-атак.
• Взаимодействие: Интегрируется с модулями авторизации (AuthModule),
администрирования (AdministrationPanel) и баз данных (Database).
4. Модуль Баз данных (DatabaseModule)
• Описание: Хранит и обрабатывает данные приложения.
• Задача: Управление схемой базы данных, обеспечение транзакционной
целостности и производительности запросов.
• Взаимодействие: Поддерживает запросы и обмен данными с модулями
управления пользователями (UserManagement), товаров (ProductCatalogue),
заказов (OrderProcessing) и безопасности (Security).
5. Модуль Каталога Товаров (ProductCatalogueModule)
• Описание: Содержит информацию обо всех товарах, представленных в
приложении.
• Задача: Ведёт каталог продуктов, категорий, фильтров и ценовых
диапазонов.
• Взаимодействие: Используется совместно с модулями корзины покупок
(ShoppingCart), заказов (OrderProcessing) и оплаты (PaymentGateway).

17. Практическое задание:

6. Модуль Корзины Покупок
• Описание: Позволяет пользователям добавлять товары в корзину и
управлять ими.
• Задача: Формирует заказы, хранит выбранные продукты и рассчитывает
стоимость покупки.
• Взаимодействие: Работает вместе с каталогом товаров, обработчиком заказов
и платёжным шлюзом.
7. Модуль Обработки Заказов
• Описание: Организует обработку поступивших заказов.
• Задача: Следит за статусом заказа, отправляет уведомления покупателям и
поставщикам, формирует отчёты.
• Взаимодействие: Комбинирует функции модулей корзины покупок, доставки
и уведомлений.
8. Платежный Шлюз
• Описание: Обрабатывает платежи клиентов.
• Задача: Обеспечивает подключение сторонних платёжных систем (Visa,
MasterCard, PayPal и т.д.) и проведение денежных переводов.
• Взаимодействие: Запрашивает подтверждение платежа у модуля корзины
покупок и заказов.

18. Практическое задание:

9. Сервис Доставка (ShippingServiceModule)
• Описание: Автоматизирует логистику доставки товаров клиентам.
• Задача: Интеграция с курьерскими службами, расчёт стоимости доставки,
отслеживание посылок.
• Взаимодействие: Взаимодействует с модулем обработки заказов, складским
учётом и системами биллинга.
10. Складской Учёт (InventoryManagementModule)
• Описание: Отслеживает наличие товаров на складе и управляет запасами.
• Задача: Управляет уровнем запасов, контролирует пополнение склада,
инвентаризационные процедуры.
• Взаимодействие: Передаёт данные о наличии товаров в каталог, доставляет
продукцию сервису доставки.
11. Панель Администрирования (AdministrationPanelModule)
• Описание: Представляет административный интерфейс для сотрудников
компании.
• Задача: Предназначен для настройки конфигурации, мониторинга
активности пользователей, добавления товаров и аналитического анализа.
• Взаимодействие: Пользуется услугами модулей безопасности, управления
пользователями, обработки заказов и статистики.

19. Практическое задание:

12. Модуль Уведомлений (NotificationServiceModule)
• Описание: Отправляет оповещения пользователям и сотрудникам.
• Задача: Генерирует письма, SMS-сообщения, push-уведомления о событиях
(заказ принят, товар поступил на склад и т.д.).
• Взаимодействие: Оповещает пользователей через модуль авторизации,
службу заказов и доставку.
13. Логгер (LoggerModule)
• Описание: Сохраняет события, происходящие в системе, для последующего
анализа.
• Задача: Ведёт журналы активности пользователей, технических ошибок и
предупреждений.
• Взаимодействие: Коллектирует данные от всех остальных модулей и
сохраняет их в хранилище журналов.
14. Хранилище Журналов (LogStorageModule)
• Описание: Архивирует лог-файлы, предоставляя удобный доступ к ним.
• Задача: Хранит записи журнала и предлагает средства для быстрого поиска и
фильтрации записей.
• Взаимодействие: Синхронизируется с логгером, панелью администратора и
сервисом аналитики.

20. Практическое задание:

15. Служба Аналитики (AnalyticsModule)
• Описание: Собирает статистику и предоставляет отчётность о поведении
пользователей и функционировании системы.
• Задача: Группирует и анализирует большие объёмы данных, формируя
удобные отчёты и графики.
• Взаимодействие: Совместно работает с журналами (LogStorage), панелями
администратора и маркетинговыми инструментами.
16. CRM-Система (CRMSystemModule)
• Описание: Автоматизирует взаимодействие с клиентами.
• Задача: Помогает вести учёт контактов, обрабатывать обращения и
организовывать коммуникации с покупателями.
• Взаимодействие: Объединяет усилия модулей авторизации, службы
поддержки и панели администратора.
17. Модуль Поддержки (SupportServiceModule)
• Описание: Обслуживает обращения пользователей и решает возникшие
проблемы.
• Задача: Ответственно принимает жалобы, обращаясь в соответствующие
подразделения и давая обратную связь клиенту.
• Взаимодействие: Напрямую сотрудничает с модулями авторизации, CRMсистемой и службой уведомлений.

21. Практическое задание:

18. Бизнес-Логика (BusinessLogicModule)
• Описание: Включает ядро прикладной логики приложения.
• Задача: Реализует основной алгоритм работы приложения, проводит
вычисления и объединяет данные из различных источников.
• Взаимодействие: Прямо зависит от большинства модулей системы,
определяя их общий рабочий цикл.
19. Мониторинг Производительности (PerformanceMonitoringModule)
• Описание: Постоянно следит за производительностью приложения и
серверов.
• Задача: Измеряет нагрузку на систему, обнаруживает узкие места и
своевременно предупреждает о сбоях.
• Взаимодействие: Сообщает службе аналитики, панели администратора и
логгерам.
20. Конфигурационный Менеджер (ConfigurationManagerModule)
• Описание: Управляет конфигурационными параметрами приложения.
• Задача: Загружает, сохраняет и изменяет настройки среды, адаптируя
приложение под разные сценарии использования.
• Взаимодействие: Доступ ко всем остальным модулям для настройки их
параметров.

22. Благодарю за внимание