Модель С4 архитектуры

23 ноября 2023 г. · 5 min read

Привет! 🦌 Сегодня мы поговорим о модели C4 архитектуры. Эта модель была разработана Саймоном Брауном и представляет собой метод визуализации и документирования архитектуры программного обеспечения.

Что такое Модель C4?

Модель C4 - это подход к визуализации архитектуры программного обеспечения, который делится на четыре уровня: Context (Контекст), Containers (Контейнеры), Components (Компоненты), и Code (Код). Каждый уровень предоставляет разные детали архитектуры.

Контекст

Контекст — это самый высокоуровневый слой в модели C4 архитектуры программного обеспечения. Он служит для предоставления обзора всей системы, позволяя понять её роль и взаимодействие с внешним миром.

Основные Элементы Контекста

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

Зачем Нужен Контекст?

Контекст важен для:

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

Пример Контекстной Диаграммы

Допустим, у нас есть интернет магазин. На контекстном уровне мы бы изобразили:

Магазин как центральный элемент.
Пользователей (покупатель и администратор) как заинтересованные стороны, взаимодействующие с системой.
Внешние Системы, такие как аналитические системы или системы онлайн-платежей.

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

Контейнеры

Контейнеры — это второй уровень модели C4, который концентрируется на высокоуровневой структуре и компоновке системы. После того, как мы определили общий контекст системы, переходим к более детальному уровню, анализируя контейнеры.

Основные Элементы Контейнеров

Определение Контейнеров: Контейнер в модели C4 — это приложение, служба данных, клиентское приложение, веб-сайт, микросервис и т.д. Каждый контейнер исполняет определенную роль в системе и содержит части системы или компоненты.
Взаимодействие между Контейнерами: Показывает, как различные контейнеры в системе взаимодействуют друг с другом. Например, как веб-приложение взаимодействует с сервером баз данных или с внешними API.
Технологии: Для каждого контейнера указывается используемая технология. Например, веб-приложение может быть написано на React, сервер - на Java, а база данных может использовать MySQL.

Зачем Нужны Контейнеры?

Рассмотрение на уровне контейнеров важно для:

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

Пример Контейнеров

Представим, что у нас есть система электронной коммерции. На уровне контейнеров мы бы увидели:

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

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

Компоненты

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

Основные Элементы Компонентов

Определение Компонентов: Компонент в модели C4 — это часть контейнера, которая выполняет определенную функцию или набор функций в рамках системы. Это может быть модуль, служба, объект или класс (в контексте ООП).
Взаимодействие между Компонентами: Описывает, как компоненты внутри контейнера взаимодействуют друг с другом. Это включает в себя внутренние вызовы, передачу данных, события и т.д.
Ответственность Компонентов: Определяет, за что отвечает каждый компонент, какие задачи он выполняет и какие функции обеспечивает.

Зачем Нужны Компоненты?

Рассмотрение на уровне компонентов важно для:

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

Пример Компонентов

Возьмем тот же пример системы электронной коммерции. На уровне компонентов мы могли бы рассмотреть:

В Управлении контентом:
- Компонент Редактор контента, который занимается создание удаление и изменения статей.
- Компонент Менеджер баннеровкоторый занимается, созданием удалением и изменением баннеров на сайте.
- Компонент Управления категориями, занимается создаеним удалением и изменения категорий.

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

Код

Что такое Уровень Кода в Модели C4?

Уровень Кода — это четвертый и самый детализированный уровень в модели C4. Этот уровень фокусируется на реализации конкретных компонентов системы на уровне исходного кода.

Основные Элементы Уровня Кода

Детали Реализации: Здесь рассматривается, как именно реализованы компоненты на уровне исходного кода. Это включает классы, методы, функции, интерфейсы и другие программные конструкции.
Схемы Классов и Структур: Особое внимание уделяется диаграммам классов, структурам данных и их взаимосвязям. Эти детали помогают разработчикам понять, как реализована конкретная функциональность.
Алгоритмы и Логика Работы: Рассматриваются ключевые алгоритмы и логические последовательности, используемые в компонентах.

Зачем Нужен Уровень Кода?

Уровень Кода важен для:

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

Пример Уровня Кода

Продолжая пример системы электронной коммерции, на уровне кода мы могли бы рассмотреть:

В компоненте Редактор контента

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

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

Заключение

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

Подписывайтесь на телеграмм канал там больше материла про ML https://t.me/ml_pops