**Модель C4   необработанная версия — Transcript & Summary | SozAI**
Source: https://sozai.app/transcript/model-c4-raw-version/

Лекция о модели C4 (контекст, контейнеры, компоненты, код) для понимания архитектуры программных систем и объяснения её разработчикам и ИИ-агентам. Разбор на примере графического редактора.

## Key Takeaways

- Архитектуру лучше описывать на нескольких уровнях абстракции, а не одной диаграммой классов
- Модель C4 включает четыре уровня: контекст, контейнеры, компоненты и код
- Уровень кода обычно не документируют вручную, а получают из исходников или генерируют автоматически
- Документация архитектуры полезна и людям, и ИИ-агентам при работе с кодовой базой

## What the video covers

- Введение: задача понять чужую архитектуру без изучения всего исходного кода
- Проблема: одной UML-диаграммы классов недостаточно для больших систем, она мелкая и перегруженная деталями
- Разные участники команды (новичок, разработчик фичи, архитектор, интеграторы) нуждаются в разных уровнях детализации
- Модель C4 предложена Саймоном Брауном; название по первым буквам уровней: Context, Containers, Components, Code
- Уровень 1 — системный контекст: система как единый блок, пользователи и внешние системы
- Уровень 2 — контейнеры: отдельные приложения и хранилища данных
- Уровень 3 — компоненты: логические части одного приложения и их взаимодействие
- Уровень 4 — код: классы, интерфейсы; обычно не документируется вручную, так как быстро устаревает и генерируется автоматически
- Аналогия с географической картой: разный масштаб показывает разную степень детализации
- Пример практической задачи: удаление фигур во вложенных группах с undo/redo и разгруппировкой групп из одной фигуры

## Chapters

1. 00:00 Введение и постановка задачи
2. 03:00 Проблема диаграмм классов и разные потребности участников
3. 06:10 Знакомство с моделью C4
4. 19:00 Уровень 1: системный контекст
5. 31:10 Уровень 2: диаграмма контейнеров
6. 39:10 Уровень 3: компоненты и их взаимодействие
7. 53:20 Уровень 4 и практические выводы
8. 69:00 Итоги и практическое задание

Answers

## Questions about this video

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

Модель C4 — подход к документированию архитектуры, предложенный Саймоном Брауном. Она описывает систему на четырёх уровнях детализации: контекст, контейнеры, компоненты и код. Название образовано от первых букв этих слов.

Почему одной диаграммы классов недостаточно?

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

Нужно ли использовать все четыре уровня C4?

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

## Full Transcript — Download SRT & Markdown

00:02

Speaker A

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

00:17

Speaker A

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

00:26

Speaker A

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

00:43

Speaker A

Соответственно, как быстро понять архитектуру системы, не изучая весь исходный код? Как объяснить её другому разработчику?

00:51

Speaker A

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

01:03

Speaker A

Сегодня мы познакомимся с вами с моделью C4, которая помогает решать эти задачи. Есть такая взрывчатка C4, да?

01:12

Speaker A

Вот, но мы с вами будем про другое говорить. Итак, значит, представим, что в нашу команду пришёл новый разработчик и ему поручили добавить удаление фигур внутри вложенных групп с поддержкой undo redo.

01:25

Speaker A

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

01:37

Speaker A

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

01:51

Speaker A

М, модель, которая хранит предметную область, модель, которая хранит выделение. Э, есть документ с историей команд.

01:58

Speaker A

Кроме того, удаление может изменить структуру групп. Например, если в группе останется всего одна фигура, то группу придётся разгруппировать.

02:07

Speaker A

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

02:28

Speaker A

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

02:41

Speaker A

И мы с вами знаем уже некоторые способы поделиться такой информацией. Это, допустим, диаграмма классов или диаграмма последовательности.

02:52

Speaker A

Но на больших проектах [смех] одной диаграммы классов может быть недостаточно. Вот у нас э, редактор-то небольшой, там всего лишь, наверное, несколько тысяч строк у вас получилось. Но в реальных приложениях там, э, объёмы, э, кода могут содержать десятки тысяч строк, сотни,

03:11

Speaker A

э, тысяч строк, а может быть, даже миллионы строк кода. И хотелось бы как-то в этом всём достаточно быстро уметь разбираться.

03:21

Speaker A

Мы с вами знакомы с диаграммами классов. Они показывают классы, методы, поля в этих классах и отношения между ними.

03:28

Speaker A

Если мы попробуем нарисовать такую диаграмму для того, чтобы объяснить, как у нас устроен э редактор то ну во-первых всё будет мелко.

03:37

Speaker A

Ой, давайте попробуем что-нибудь тут удастся хоть увеличить. Ну, вот, что-то есть, да? Вон, видите?

03:45

Speaker A

Мы что-то увидели, но всё равно непонятно. Какие-то разноцветные, м, классы, интерфейсы нам нарисовали, а что там у них сложно понять. И тут ещё мы никаких нету. А если вы какую-нибудь автогенерацию запустили, да?

04:03

Speaker A

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

04:13

Speaker A

Так, куда-то я зазумился. Ага, вот сюда. есть проблема не в UML диаграмме. Диаграмма классов полезна, когда нужно разобраться в устройстве конкретного компонента.

04:27

Speaker A

Например, отношения между интерфейсом I Shape, Group Shape, Shape Collection позволяют понять реализацию группировки фигур.

04:35

Speaker A

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

04:50

Speaker A

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

04:58

Speaker A

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

05:16

Speaker A

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

05:28

Speaker A

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

05:39

Speaker A

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

05:46

Speaker A

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

06:07

Speaker A

коду. Э-э, модель C4 получила такое своё название, потому что на каждом м-м, уровне [откашливается] у неё ну как присутствует слово на каждом масштабе, начинающееся с буквы C. Наверное, поэтому.

06:26

Speaker A

Итак, э-э, значит, мы пришли к выводу, что архитектуру системы нужно уметь рассматривать на разных уровнях детализации.

06:34

Speaker A

И именно эту, м-м, идею использует модель C4, предложенная Саймоном Брауном. Представим себе географическую карту.

06:42

Speaker A

Когда мы смотрим на целый город, э-э, нам важны основные районы и дороги. Но если нужно найти какой-нибудь конкретный дом, то мы увеличиваем масштаб.

06:52

Speaker A

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

07:11

Speaker A

C4 позволяет организовать такие представления, чтобы они дополняли друг друга. Название, э-э, C4 происходит от четырёх английских слов.

07:23

Speaker A

Контексты, э-э контейнеры э-э, компоненты и код. Ну, вот так удобно оказалось на английском языке.

07:33

Speaker A

Совпадение? Как говорится, не думаю. На первом уровне мы рассматриваем систему целиком, её пользователей и внешние системы.

07:42

Speaker A

Вот, на втором уровне, на уровне, ой, куда это у меня всё делось? Вот. На втором уровне мы уже видим отдельные приложения и хранилища данных.

07:52

Speaker A

На третьем уровне мы изучаем компоненты одного из приложений, какие они задачи они решают и как взаимодействуют.

08:01

Speaker A

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

08:08

Speaker A

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

08:24

Speaker A

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

08:47

Speaker A

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

09:03

Speaker A

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

09:18

Speaker A

программ. Ну например э для настольных приложений таким э, таким приложениями могут быть кто? Ну, там, ну, Microsoft Office, да, там есть PowerPoint, Word и так далее.

09:33

Speaker A

Вот, и какое-нибудь веб-приложение. Ну, мы её, ладно, рассматриваем на этом уровне мы рассматриваем на нашу систему просто как, э, один квадратик и знаем, какие виды пользователей с ней взаимодействуют и как это и как наша система взаимодействует с другими системами.

09:54

Speaker A

И тут нам вообще даже не важно, на [откашливается] каких языках программирования, базах данных или внутренних компонентах система устроена.

10:03

Speaker A

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

10:12

Speaker A

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

10:30

Speaker A

какие-то находятся контейнеры. Эта диаграмма называется диаграмма контейнеров. На этом уровне диаграмма показывает, из каких приложений хранилищ состоит система.

10:44

Speaker A

Например, у веб-сервиса может быть клиентское приложение, которое работает в браузере, может быть мобильное приложение, которое работает на мобильном телефоне, может быть серверное приложение и одна или даже несколько баз данных и хранилища файлов.

11:00

Speaker A

Здесь важно понимать слово контейнер. В C4 это не обязательно докер-контейнер. То есть контейнером может быть обычное десктопное приложение, мобильное приложение или база данных.

11:13

Speaker A

А вот какие-то отдельные классы на C++ или DLL-контейнеры, ну или DLL-файлы, они уже контейнерами не считаются.

11:25

Speaker A

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

11:39

Speaker A

Мы когда описываем диаграмму контейнеров, вот мы тут уже описываем, какой стек технологий может быть написан. Например, веб-клиент у нас может быть написан на JavaScript'е, серверное приложение на PHP и фреймворк Symfony, база данных там PostgreSQL и и S3-хранилище файлов.

12:01

Speaker A

Ну или S3-подобное, наверное, потому что это же наша система, то есть она внутри находится.

12:09

Speaker A

Вот если бы у нас здесь было ещё мобильное приложение, то пользователь мог бы взаимодействовать ещё и не только с веб-клиентом, но и с мобильным.

12:20

Speaker A

Следующий уровень - это уровень компонентов. Здесь мы рассматриваем уже не всю систему, а один конкретный контейнер.

12:26

Speaker A

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

12:49

Speaker A

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

12:59

Speaker A

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

13:23

Speaker A

Есть компонент, отвечающий за приём работ, который складывает их в хранилище файлов. Э-э есть компонент, проверяющий э-э отвечающий за проверку работ.

13:34

Speaker A

Э-э за выставление оценок, и результаты, допустим, записываются в базу данных. И связи здесь могут быть какие-нибудь другие, главное, чтобы мы показали, какие компоненты друг с другом есть и как они друг с другом взаимодействуют.

13:50

Speaker A

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

14:02

Speaker A

Вот, до сих пор мы с вами отдельные классы проектировали и определяли их взаи- их взаимодействие.

14:10

Speaker A

Теперь посмотрим на них как на части более крупных архитектурных компонентов. Вот э это мы можем увидеть, ну внутри диаграммы компонентов.

14:26

Speaker A

И последний уровень, здесь мы уже переходим от архитектурных компонентам к деталях, к деталям их реализации.

14:33

Speaker A

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

14:48

Speaker A

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

15:07

Speaker A

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

15:26

Speaker A

меня в репозитории, ой, и у меня на канале есть лекции, в репозитории тоже есть лекция. Вы можете сами посмотреть и вспомнить.

15:35

Speaker A

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

15:45

Speaker A

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

16:01

Speaker A

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

16:15

Speaker A

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

16:24

Speaker A

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

16:50

Speaker A

Ну ещё играет роль то, каким образом вы эти диаграммы храните у себя в репозитории.

16:56

Speaker A

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

17:05

Speaker A

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

17:14

Speaker A

Поэтому обычно используют э, инструменты вроде Mermaid'а, в котором мы в текстовом режиме описываем, какие есть классы. Вы Mermaid видели когда-нибудь?

17:28

Speaker A

Ну вот и хорошо. Э По крайней мере, если там произойдёт какой-нибудь конфликт, то человек сможет разобраться и более менее как-то взять и смержить э изменения.

17:40

Speaker A

Но тем не менее, какие-то графические инструменты вроде Draw.io или Miro они всё равно для рисования таких диаграмм могут быть полезными, потому что э, в отличие от Mermaid'а, здесь вы можете, по крайней мере, схватиться за вот эти квадратики и их

18:01

Speaker A

расположить так, чтобы было удобнее. А в случае с Mermaid'ом, ну как визуализатор вам э, их рассортирует на холсте, вот так вот и э, мучайтесь. Может быть, конечно э, в каком-нибудь с какими-нибудь плагинами подвигать у у получится, но скорее всего не очень хорошо.

18:23

Speaker A

Ну и давайте теперь рассмотрим применение диаграммы C4 для примера для описания системы сдачи и проверки учебных работ. Тут мы с вами взяли и так от десктопного приложения перешли к чему?

18:39

Speaker A

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

18:51

Speaker A

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

19:02

Speaker A

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

19:15

Speaker A

Э-э, и в система система должна эти файлы хранить, хранить результаты проверки. И давайте ещё предположим, что для входа используется университетская система э-э, аутентификации. То есть, если вы в какой-нибудь университетской системе зарегистрированы значит и в эту систему тоже можете войти.

19:38

Speaker A

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

19:51

Speaker A

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

20:05

Speaker A

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

20:21

Speaker A

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

20:40

Speaker A

Вопрос: нужно ли сейчас показывать базу данных или нет? Вот на этом уровне. А? Нам не надо. Почему не надо?

20:57

Speaker A

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

21:12

Speaker A

Э, на первом уровне, на уровне системного контекста, нас интересует взаимодействие системы с окружением, а не её внутреннее устройство. А база данных, это уже внутреннее устройство нашей системы.

21:26

Speaker A

И давайте по- посмотрим, как эта будет система выглядеть на диаграмме C4. В центре у нас находится система сдачи и проверки учебных работ.

21:36

Speaker A

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

21:53

Speaker A

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

22:17

Speaker A

Так, давайте-ка закроем. Хоп. Вот, например, если в Draw.io мы выберем, там есть такой вот пунктик C4 рядышком с UML. И вот ммм, каким образом эти как обозначаются пользователи, как обозначается система. То есть, это просто какие-то квадратики.

22:43

Speaker A

Квадратики с подписями. И вот, нас, в общем-то, э-э, здесь вот не интересует, э-э, чисто вот студент или преподаватель. Здесь на картинке это, чтобы вам красивее было, я взял красивую картинку, чтобы студент визуально от преподавателя отличался. Но на тех инструментах, где вы будете их

23:00

Speaker A

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

23:12

Speaker A

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

23:23

Speaker A

А университетская система аутентификации подтверждает нам пользователя. [откашливается] То есть, связи показывают, кто с кем взаимодействует и с какой целью. И по этой диаграмме можно понять, для чего предназначена наша система и какие у неё есть внешние зависимости.

23:41

Speaker A

Но мы по-прежнему ничего не знаем про внутренности её реализации. И для этого, потом поэтому служит следующий контекст.

23:52

Speaker A

Точнее, след- следующий уровень. Диаграмма системного контекста позволяет, э-э, понять, с каки- с кем взаимодействует наша система, но не отвечает на вопрос, как она устроена внутри.

24:07

Speaker A

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

24:20

Speaker A

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

24:32

Speaker A

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

24:52

Speaker A

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

25:02

Speaker A

Э-э. На сер- будет серверная часть, на котором будет находиться логика обработки запросов, то есть приём решений, регистрация результатов проверки и выставление оценок.

25:14

Speaker A

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

25:23

Speaker A

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

25:39

Speaker A

Это уже диаграмма контейнеров, то есть мы взяли и увеличили, как бы заглянули внутрь э-э, нашей системы. То есть просто нарисовали рядышком ещё одну диаграмму, в которой нарисовали уже есть и контейнер. Тут у нас показаны четыре контейнера.

25:54

Speaker A

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

26:27

Speaker A

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

26:43

Speaker A

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

26:59

Speaker A

[откашливается] Здесь мы не изображаем классы или методы сервера. Вот, это был бы уже другой уровень детализации.

27:07

Speaker A

Вот, но здесь мы можем показать, э, какие технологии мы используем для нашей системы. То есть, если, например, разработчик решил, э, что ему нужно исправить баг, э, на стороне веб-клиента, то ему неплохо бы знать, что он написан на TypeScript'е и

27:25

Speaker A

фреймворк React использует. А если он решил в бэкенде [откашливается] покопаться, то, допустим, у нас он на C# написан.

27:34

Speaker A

А если, э, ему нужно взаимодействовать с базой данных, он знает, что вот она э, на PostgreSQL.

27:44

Speaker A

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

27:53

Speaker A

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

28:03

Speaker A

То есть, в нашем примере всю серверную бизнес-логику, э, могло бы реализовывать одно приложение. [откашливается] И давайте сравним две получившиеся диаграммы.

28:19

Speaker A

На уровне системного контекста мы видели систему как единое целое, и нас интересовали её пользователи и внешние системы, от которых наша система зависит и границы ответственности.

28:30

Speaker A

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

28:45

Speaker A

Э-э, диаграмма контейнеров, она не раскрывает, как именно устроено серверное приложение. И для того, чтобы узнать это, нам нужен следующий уровень, диаграмма компонентов.

28:59

Speaker A

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

29:26

Speaker A

Вот, в отличие от этого сервиса, который мы рассмотрели, у нас бот состоит всего лишь из одного десктопного приложения, но значит ли это, что он как-то просто устроен внутри?

29:38

Speaker A

Конечно же, нет. Вот, давайте посмотрим на архитектуру графического редактора с помощью вот этих диаграмм.

29:49

Speaker A

На уровне системного контекста кто с нашим приложением взаимодействует? Взаимодействует пользователь, который создаёт и редактирует рисунок.

30:00

Speaker A

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

30:23

Speaker A

система, с которой э-э, с которой он бы взаимодействовал, да? И, например, [откашливается] для вас, как разработчиков графического редактора, вот вся система будет и представлять и ну вся программная система будет из графического редактора состоять. А какой-нибудь там какая-нибудь внешняя система для

30:48

Speaker A

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

31:01

Speaker A

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

31:21

Speaker A

Теперь попробуем заглянуть внутрь графического редактора и построить диаграмму контейнеров. И здесь тоже всё очень просто.

31:28

Speaker A

Фактически у нас одно десктопное приложение, написанное на C++, которое использует библиотеку SFML. Какого-то сервера, базы данных и веб-клиента у нас нету, всё выполняется в одном процессе.

31:47

Speaker A

Обратите внимание, что вот такие штуки, как SFML, э-э, Boost, что у нас там ещё?

31:53

Speaker A

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

32:18

Speaker A

PowerPoint, Excel, что-нибудь ещё, да? Outlook. Мы с вами получили контейнер диаграмму контейнеров, состоящую из одного приложения. Ну, давайте вспомним, сколько всего там внутри находится. И ещё сколько вам предстоит предстоит добавить вот в рамках последней лабы. Ну я вас, правда,

32:45

Speaker A

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

33:04

Speaker A

что-то другое писать. Вы уже рады, да? Наверное. Очень хорошо. [откашливается] И большинство па- паттернов проектирования, мы уже будем, если и упоминать, то только То есть, остальные паттерны проектирования вы самостоятельно должны будете изучить на экзамене, потому что я спрошу, даже если по ним отдельной

33:32

Speaker A

лекции в этом семестре не будет. Зато у нас будут по другим темам лекции. Например, мы с вами больше времени уделим Domain Driven Design.

33:42

Speaker A

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

33:56

Speaker A

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

34:13

Speaker A

диаграмма компонентов. То есть, э, посмотрим, что у нас есть в нашем редакторе. У нас есть пользовательский интерфейс.

34:27

Speaker A

В него входит э, окно редактирования, есть э, вложенный view, допустим, Canvas view, у кого-то может появился Timeline view, есть контроллеры.

34:36

Speaker A

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

34:56

Speaker A

Ещё од- э-э, один компонент у нас объединяет сам документ и механизмы выполнения и команд с поддержкой undo-redo.

35:04

Speaker A

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

35:23

Speaker A

Сейчас мы сгруппировали классы логически. Это не означает, что каждый компонент обязательно, э-э, реализован какой-то отдельной библиотекой или физическим модулем. Мы просто эти классы взяли и разделили.

35:35

Speaker A

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

35:51

Speaker A

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

35:59

Speaker A

Э-э, по мере усложнения вашего редактора такое разделение, ну, физическое разделение на папки будет полезно.

36:07

Speaker A

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

36:25

Speaker A

И теперь давайте добавим э-э, взаимодействие вот между теми компонентами, которые у нас есть. У нас есть пользовательский интерфейс.

36:41

Speaker A

Так? Э-э, он за приём действий пользователя э-э в модели редактирования. Модель редактирования работает с фигурами и хранит временное состояние редактирования, то есть пока вы тащите фигуру, изменяется модель редактирования.

37:04

Speaker A

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

37:24

Speaker A

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

37:37

Speaker A

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

37:59

Speaker A

[откашливается] Давайте попробуем прочитать нашу диаграмму. Например, где хранится информация о выделенных фигурах? Хранится в модели редактирования. То есть тут написано её ответственность, за что она отвечает.

38:17

Speaker A

Вот, если мы будем рисовать здесь, на диаграмме компонентов, это всё будет, конечно, выглядеть не так красиво, как Вот, у нас контейнер есть и вот контейнер, контейнер. И вот есть компонент.

38:33

Speaker A

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

38:52

Speaker A

вряд ли какие-нибудь добавите, у вас будут одни квадратики видны. Так, у меня куда-то всё перелисталось.

39:02

Speaker A

Хорошо, если нужно, например, разобраться нам с тем, как работают undo и redo, то лучше посмотреть на документы и историю команд.

39:11

Speaker A

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

39:21

Speaker A

Например, может ли изменение выделения повлиять на отображение? Конечно же может, да, то есть вот у нас э-э модель отрисовки получает э-э отображаемое состояние, ей нужно знать, что отображать.

39:54

Speaker A

А может ли ну, наверное ладно зачем риторические вопросы задавать. На что может [откашливается] повлиять документ команды, вот так вот.

40:05

Speaker A

То есть изменения, которые На предметную Вот вот Что? На предметную модель. Да, на предметную модель может поменять у нас документ и команда. То есть мы, когда э-э изменения, которые происходят вот в в этой части документа, могут изменять состояние

40:31

Speaker A

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

40:49

Speaker A

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

41:00

Speaker A

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

41:11

Speaker A

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

41:19

Speaker A

есть меняются Editor Model и Editor Shape. есть, состояние предпросмотра меняется. [откашливается] Когда пользователь кнопку мыши отпускает, что происходит? У нас Editor Model завершает операцию, создаёт команду Move Shapes Command.

41:41

Speaker A

Команда Move Shapes Command э, передаётся в документу. Внутри документа она попадает в историю Undo Redo и модифицирует и рисунок.

42:04

Speaker A

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

42:19

Speaker A

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

42:27

Speaker A

То есть, приходится как-то словами объяснять. Вот э для того, чтобы визуально показать диаграмму, ну точнее а для того, чтобы визуально показать, как компоненты взаимодействуют друг с другом используются динамическая диаграмма.

42:46

Speaker A

А, она тоже относится к чему? Ну, её можно, в принципе, э-э, к уровню компонентов тоже. То есть э-э диаграмма в динамическая диаграмма, она может применяться не только к отдельным классам, кто кого вызывает, но ещё и какой компонент к кому обращается.

43:08

Speaker A

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

43:17

Speaker A

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

43:33

Speaker A

[откашливается] Когда происходит изменение э-э ну вот состояние предварительного просмотра модель отсылает уведомление, эти уведомления получает компонент отрисовки. Он показывает фигуру во временной позиции.

43:51

Speaker A

Вот при этом сама предметная область у нас пока не меняется. Затем, когда мы завершаем перемещение, э-э модель редактирования передаёт в документ ну точнее в э-э в историю она передаёт э-э команду перемещения объекта. Команда перемещения объекта изменяет предметную модель фигуру.

44:16

Speaker A

Фигура уведомляет о перемещении модели редактирования, модели редактирования получает новое состояние. Отображает итоговую позицию. И а отображает итоговую позицию у нас уже компонент отрисовки. То есть модель изменилась, отправилось уведомление, на которое подписана отрисовка, отрисовка взяла актуальное состояние, отрисовала.

44:53

Speaker A

То есть вот таким образом можно увидеть, то, каким образом наша система изменяется во времени.

45:02

Speaker A

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

45:09

Speaker A

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

45:35

Speaker A

группы хранились. Ну, и есть классы конкретных фигур, которые унаследованы от абстрактного класса Shape. Мы в этой диаграмме намеренно ограничили область э-э, одним компонентом, чтобы программа наша не разрасталась.

45:54

Speaker A

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

46:16

Speaker A

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

46:27

Speaker A

Вот в Draw.io есть какой-то компонент. Сейчас я даже посмотрю. Он уже находится там, где UML его взяли, перетащили.

46:43

Speaker A

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

46:51

Speaker A

Это как раз то же самое, что мы и тут Так, вы руку поднимали, у вас есть вопрос да?

46:57

Speaker A

Да. Подход C4, модель C4, используется только при описании кода или может быть использован для проектирования системы?

47:07

Speaker A

Он может использоваться как это подход C4 может использоваться и при проектировании и при описании уже существующей.

47:17

Speaker A

То есть, если у вас есть какая-то сложная система, то рано или поздно вы придёте к тому, что неплохо бы это задокументировать, потому что к вам, как человеку, который лучше всех разбирается в устройстве этой системы, постоянно приходят новые люди и спрашивают: "А что

47:32

Speaker A

как у нас тут устроено?" И вы по доброте своей душевной начинаете тратить своё время и объяснять. На десятый раз вы устаёте это делать, пишете и дальше уже говорите людям: "Вот там вот сидите, смотрите.

47:45

Speaker A

Если увидели где-то какое-то несоответствие, возьмите и актуализируйте диаграмму, пришлите pull request". [кашель][откашливается] Давайте посмотрим почему архитектурная документация становится важной, когда у вас есть AI-агенты. Ну, или как там сейчас не искусственный интеллект принято говорить, а хотят, чтобы мы называли это

48:11

Speaker A

суперинтеллект, но мы будем называть называть по старинке. Представим, что теперь новую функциональность нашего редактора разрабатывает не человек, а AI-агент.

48:22

Speaker A

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

48:41

Speaker A

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

48:52

Speaker A

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

49:12

Speaker A

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

49:36

Speaker A

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

49:52

Speaker A

связан, но почему это сделано, наверное, не дойдёт. Поэтому всё равно мы в коде какие-то подсказки должны ему оставлять, и диаграмма уровня C4 - это тоже те инструменты, которые могут ему помочь.

50:07

Speaker A

Например, по диаграмме компонентов э-э, нашего редактора можно определить, где хранится выделение, кто отвечает за undo-redo и как изменяется предметная модель.

50:19

Speaker A

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

50:29

Speaker A

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

50:49

Speaker A

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

50:56

Speaker A

Не смейте это использовать при выполнении лабораторной работы. Вот, при этом, значит, операция должна поддерживать end to end redo.

51:05

Speaker A

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

51:16

Speaker A

Например, э-э, мы можем ему сказать, где лежат все C4 диаграммы, чтобы он понимал, как компоненты существуют, какие есть у нас компоненты и за что они отвечают.

51:28

Speaker A

Во-вторых, э-э, архитектурные правила можете ему передать. Например, контроллер не должен напрямую изменять предметную модель.

51:37

Speaker A

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

51:59

Speaker A

И например вы можете ему сказать, после того, как он что-то сделал, например, изучи диаграммы и архитектурные правила.

52:11

Speaker A

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

52:27

Speaker A

Проверь предположения по исходному коду, реализуй изменения и тесты. Ну, тут надо ещё добавить make no mistakes, да? Не делай ошибок.

52:34

Speaker A

Ну, ещё покрой всё это тестами. А, ну, про тесты мы ему уже сказали. Вот.

52:42

Speaker A

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

53:00

Speaker A

И давайте поговорим про то, как создавать хорошие архитектурные диаграммы. Итак, мы мы узнали, как строить архитектурные диаграммы, но достаточно ли просто нарисовать несколько прямоугольников и соединить их стрелками?

53:19

Speaker A

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

53:29

Speaker A

Э-э станет ли вам понятно, из каких систем она состоит, и нет ли тут каких-то вещей, которые вас начинают смущать? Ну, кроме вот этих вот артефактов со стрелочками.

53:48

Speaker A

Почему у нас UI сам выходит в авторизацию? Что? Почему у нас UI сам выходит?

53:54

Speaker A

Почему UI идёт напрямую в систему авторизации? Там не в Grade Service. Э-э или в Grade Service. Вот, да, сразу возникают вопросы. Правильно ли тут, во-первых, не подписаны, что тут за э-э стрелочки, да, что они означают.

54:10

Speaker A

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

54:22

Speaker A

Дальше, обратите внимание, что тут у нас смешаны м-м как бы квадратики, ну, не только квадратики ладно э-э визуальные объекты с разных уровней детализации.

54:35

Speaker A

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

54:43

Speaker A

Вот мы начинаем смотреть и искать по исходникам, а где у нас подсистема аутентификации-то? Оказывается, что её у нас в исходниках-то и нет.

54:51

Speaker A

Потому что она находится там в другом репозитории, э-э в котором хранится там ну, университетская система отдельная. У нас такого нет, у нас просто подсистема сдачи и проверки учебных работ. Тут вот Grade Service.

55:07

Speaker A

Что такое Grade Service? Grade Service это вообще внутренняя деталь э-э нашего бэкэнда, то есть система выставления оценок.

55:17

Speaker A

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

55:24

Speaker A

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

55:41

Speaker A

Вот. Кроме этого, что? У каждой диаграммы должно быть понятное назначение. Например, объяснить взаимодействие системы с окружением или же внутреннее устройство приложения. То есть на какой вопрос диаграмма отвечает? Второе, необходимо явно показывать границы.

55:56

Speaker A

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

56:13

Speaker A

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

56:27

Speaker A

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

56:50

Speaker A

Да- даже если это диаграмма, вы всё равно должны в ней как-то взять и разобраться.

56:55

Speaker A

Вот. Э-э у меня нет здесь интернета, но вы попробуйте загуглить карту токийского метро и потом карту японского метро.

57:07

Speaker A

И ой, токийского и московского метро и посмотрите какое э, из них более понятное. Ну, если не считать, что в Японии всё иероглифами пишут.

57:22

Speaker A

Вот, но там, наверное, всё запутано, да? И вот вам хотелось бы оказаться, наверное, э, увидеть перед собой ту карту, после которой ну, как вы найдёте ответы на свои вопросы, а не поймёте, что у вас что-то не в порядке

57:41

Speaker A

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

57:56

Speaker A

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

58:16

Speaker A

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

58:37

Speaker A

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

58:57

Speaker A

Или серверов. Серверов. А, база данных, которая у нас показана C4, не, точнее, не на C4, на уровне C2, да, на уровне контейнеров, как отдельный контейнер, не должна неожиданно оказаться нашим внутренним компонентом сервера. То есть тут его нет, не должно

59:18

Speaker A

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

59:35

Speaker A

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

59:42

Speaker A

Может быть, обе. И ваша задача устранить эти противоречия. Мы использовали UML-диаграммы классов, возникает закономерный вопрос.

60:00

Speaker A

Э-э, исключают ли C4 и UML друг друга? На самом деле, они не исключают друг друга. C4 предлагает способ рассматривать архитектуру на нескольких уровнях детализации и определяет, какие сущности мы показываем на каждом уровне.

60:15

Speaker A

А UML - это язык визуального моделирования с набором стандартных диаграмм и обозначений. Например, UML-диаграммы хорошо подходят для уровня кода.

60:24

Speaker A

И UML-диаграмма последовательности может использоваться для описания динамического взаимодействия компонентов, э-э, то есть на уровне C3.

60:36

Speaker A

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

61:01

Speaker A

[откашливается] И давайте ещё один вопрос посмотрим. Когда всегда ли полезно иметь э-э, архитектурные диаграммы?

61:12

Speaker A

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

61:22

Speaker A

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

61:40

Speaker A

диаграмму и скажет, наверное, в в компоненте X у вас находится ошибка. Он заглядывает в код, а там на самом деле нет никакого компонента X, потому что он уже там разбился на компоненты Y и Z, а на диаграмме это не отражено. Человек

61:56

Speaker A

потратил, там, не знаю, 1 час своей жизни. Ну или потратил там 20% дневного лимита токенов на то, чтобы э-э, сделать решение, которое на самом деле не работает.

62:08

Speaker A

Ладно, и и и и агент быстрее, наверное, на- найдёт там это несоответствие. Ну в любом случае вы создадите лишнюю работу либо человеку, либо роботу.

62:22

Speaker A

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

62:41

Speaker A

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

62:53

Speaker A

То есть если вы будете диаграммы хранить где-нибудь там на Google диске, а код у вас хранится в Git репозитории, то ваша ну, ваши диаграммы устареют ровно в тот момент, когда вы закончите работу над фичёй, запушите их и потом какой-нибудь

63:14

Speaker A

разработчик, ничего не зная про ваш э-э, локальный там Google, ну, ваш личный Google Drive, где у вас это хранится.

63:24

Speaker A

Э-э, он туда просто никаких изменений вносить не будет. Поэтому вот лучше хранить их рядышком с кодом.

63:32

Speaker A

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

63:43

Speaker A

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

63:58

Speaker A

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

64:13

Speaker A

Если вам нужно объяснить сторонней команде, как наше приложение взаимодействует с их системой. Какую нам надо выбрать?

64:22

Speaker A

Аннотацию. Ну, скорее C4. Нет, ну, понятно, что C4. Какой из уровней C4 нам нужно выбрать?

64:30

Speaker A

Тогда первый. Нам надо выбрать, да, C1 - это, э-э, системный контекст, потому что нас интересует внешнее взаимодействие.

64:40

Speaker A

Теперь вторая задача. Новый разработчик хочет понять из каких приложений и хранилищ состоит продукт. Какой уровень?

64:51

Speaker A

Третий. Компоненты. Из каких приложений и хранилищ состоит продукт? Из каких хранилищ, тогда приложение. Это C2, э-э, так, почему у меня тут написано контейнер?

65:07

Speaker A

А-а, [вздыхает] чёрт. У меня вопросы не в том порядке идут. Сейчас я Ну, вы уже подсмотрели, да?

65:24

Speaker A

Я перемешал, а в тексте не перемешал. Сейчас всё сделаю. Итак, вам надо определить, какие компоненты графического редактора отвечают за undo-redo. Вам понадобится какая диаграмма? Понадобится диаграмма компонентов.

65:44

Speaker A

Только там C3 написано, а не C3. Компоненты Блин. Что всё? Так вот бывает, ночью пишешь.

66:01

Speaker A

Да, я контейнер и код перепутал. Так. Значит, третье. Новый разработчик хочет понять, из каких [откашливается] приложений и хранилищ состоит продукт.

66:27

Speaker A

А нет. Разработчик хочет разобраться, как иерархия фигур у нас устроена. Какое Какое ему пригодится здесь?

66:41

Speaker A

Скорее всего, ему C4 Да, здесь ему при пригодится C4, э-э, уровень кода. И третье. Значит, новый разработчик хочет понять, из каких приложений и хранилищ состоит продукт.

66:56

Speaker A

Здесь контейнеры C2. Тут C2, уровень контейнеров. Итак, давайте подведём э-э итоги. Мы посмотрели на архитектуру программных систем с новой стороны.

67:27

Speaker A

Раньше мы учились проектировать классы, управлять зависимостями и применять паттерны. Теперь научились описывать результаты проектирования так, чтобы их могли понять другие разработчики. Ну, как научились? Пока узнали, как это делать, а чтобы научиться, у вас будет четвёртая лабораторная работа.

67:45

Speaker A

Ой, не [откашливается] четвёртая, а какая-то шестая. Шестая лабораторная работа у вас будет. Э, модель C4 позволяет рассматривать систему на разных уровнях, от взаимодействия с окружением до конкретных классов.

67:59

Speaker A

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

68:08

Speaker A

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

68:27

Speaker A

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

68:44

Speaker A

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

68:56

Speaker A

Есть ли у вас по каким-нибудь другим предметам ещё большие проекты? Компилятор вы пока писать не начали.

69:03

Speaker A

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

69:17

Speaker A

Вот, а на на следующих занятиях мы перейдём к новой теме, к Domain Driven Design. То есть, мы будем учиться исследовать предметную область, выделять в ней важные понятия и проектировать модели, отражающие бизнес-правила.

69:29

Speaker A

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

69:37

Speaker A

Какие у вас остались вопросы? Вроде бы всё понятно. Ну, и шестая лаба у вас, скорее всего, лайтовая будет. Вам почти ничего писать не придётся.

69:52

Speaker A

Ну хотя м-м я попрошу, чтобы вы в Mermaid их нарисовали или не в Mermaid. Давайте не в Mermaid. Давайте вы всё-таки в Draw.io их нарисуете, потому что в Mermaid вы можете попросить, чтоб вам иишка нарисовал.

70:05

Speaker A

А я хочу, чтоб вы поработали э-э не только клиентом у иишки, да, но и головой подумали. Может, вам иишка нарисует в Mermaid, а потом вы перенесёте но попутно м-м найдёте несколько ошибок. Я вот там э-э Ладно, потом я в чатик скину.

70:28

Speaker A

Только напомните мне, какие диаграммы вот иишка рисовала по э-э той модели редактора, которую вот я в своём прототипе сделал. У неё там э-э два объекта друг друга композировали, то есть э-э один объект содержал в себе второй, а второй содержал в себе первый.

70:46

Speaker A

Соответственно вот связи, которых быть вообще не может. Иногда он какие-то новые виды связи придумывал, не не те, которые приняты.

71:02

Speaker A

Вот, поэтому всё и агентам не доверяйте. Ну, во-первых, лабораторные работы вы всё равно сами должны делать и уметь пояснить.

71:10

Speaker A

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

71:22

Speaker A

Вот. Ладно, давайте тогда закончим лекцию. Всем пока.

Topics: модель C4 архитектура ПО диаграммы архитектуры документирование UML Саймон Браун контейнеры компоненты проектирование систем ИИ-агенты

Учить по этому видео

- [Карточки по этому видео](https://sozai.app/ru/tools/flashcard-maker/?from=transcript&id=94544)
- [Тест по этому видео](https://sozai.app/ru/tools/quiz-generator/?from=transcript&id=94544)
- [Кроссворд по этому видео](https://sozai.app/ru/tools/crossword-maker/?from=transcript&id=94544)
- [Филворд по этому видео](https://sozai.app/ru/tools/word-search-maker/?from=transcript&id=94544)
- [Шпаргалка по этому видео](https://sozai.app/ru/tools/study-guide-maker/?from=transcript&id=94544)

Бесплатно, составлено ИИ по этой расшифровке. Без регистрации.


---
This is the markdown twin of https://sozai.app/transcript/model-c4-raw-version/ — the same content, without the markup.
Published by SozAI (https://sozai.app). Reuse and quotation are allowed with attribution and a link back.
Machine-readable index: https://sozai.app/llms.txt · data API: https://sozai.app/api/
