Правильная архитектура моделей Yii2?

Question

[Константин Марченко]

Все привет и хороших наступающих выходных! (на карантине :D)
Однако не могу не задать вопрос.

Вопрос в правильном построении иерархии моделей (объект работы с таблицей). Есть раздел common/models и есть frontend/models. Я выстраивал их так. Допустим есть какой нибудь раздел ну пусть это будет раздел Договора, у него есть своя таблица в базе и естественно созданная модель-объект для работы с ней - Registry. В данном случае расположение её будет по пути /frontend/models/Registry(папка)/Registry. Тоесть находясь в разделе договоров, мы работаем с этой моделью.

Но вот пришло время в каком нибудь другом месте сайта, к примеру в разделе Отчеты обратиться ИЛИ даже поработать с таблицей договоров (обычно к примеру подсчитать кол-во договоров за месяц). Вот тут вопрос, как лучше сделать, подключать модель Registry из раздела договоров, тоесть - /frontend/models/Registry(папка)/Registry или же создавать отдельную модель в разделе Отчетов (frontend\models\Reports\Registry) ?

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

Я сейчас решил сделать так: создать скажем так общую модель в разделе common\models\Registry. В ней только выборка и будет находиться функции к примеру подсчетов или определенных выборок БЕЗ записи в базу, только выборка.

И подключать эту модель уже в тех местах где нужно, на примере выше в разделе Отчеты подключу уже модель так /common/models/Registry.

Правильно ли я делаю?

Answer 1

[Максим]

Model – это весь доменный слой (Domain Model). Доменный слой работает только с доменной логикой. В доменный слой входит не только модель Active Record, но и другие классы, например сервисы. В Yii2 принято называть моделью то, что наследуется от класса Model. Но сами модели в действительности являются сущностями (Entity). Разберитесь с этим.

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

Для чтения данных мы можем выделить ReadModel. Она может выдавать данные в виде массивов которые получают из SQL запросов, QueryBuider или AR. На примере CRUD это R. В итоге мы имеем чистый доменный слой, а другие слои могут быть связаны друг с другом в модулях.

Пример такой архитектуры можно посмотреть тут.

Мои ответы на схожую тему:
1. Архитектура приложения. Как сделать независимые модули (сервисы)?
2. Смысл модулей в Yii2?

Comments

[Константин Марченко]

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

[Константин Марченко]

И еще не понятно на примере Дмитрия по созданию интернет магазина, я так понимаю все модели в папке shop так же применяются и в админке? тоесть в /backend? Я думал в админке надо отделять как минимум

[Максим]

Константин Марченко, верно

[Максим]

Константин Марченко, Дмитрий свой модуль Shop вынес в корень проекта. Но вы везде в проекте можете разделять папками: Model/Shop/Product.php

Backend это не только может быть админка. Просто в Yii так часто делают.

[Константин Марченко]

Максим, ок, если помните то что ранее я задавал вопросы по поводу построение вложенности путей. Так вот напомню, у меня может быть два направления - Пользователь может быть юридическим лицом или физическим. Могу ли я сделать разделение таким образом. В корне проекта создаю папку models, в ней уже создаю папки:
/models/Admin
/models/Phys (все что связано с физическим лицом)
/models/Legal (все что связано с юридическим лицом)

И внутри этих папок для каждого направления уже определять сущности, формы и прочие модельки?

[Максим]

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

Model/CRM

controllers/admin/crm
controllers/auth
controllers/legal
controllers/phys

[Константин Марченко]

Максим, эм, не совсем тут понял....
так чтоли?

/models/Entities/Phys
/models/Entities/Legals

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

[Константин Марченко]

Максим, аа погодите...
Вот так:
/phys/Entities.....
/legal/Entities....

?

[Максим]

Доменный слой/Модуль/сущности
Доменный слой/Модуль/сервисы
Доменный слой/Модуль/варианты использования

Model/CRM/Entity/Legal
Model/CRM/Entity/Phys

Model/CRM/Entity/Legal/Legal.php
Model/CRM/Entity/Legal/Contact.php

Model/CRM/UseCase/Handler.php

Model/CRM/Service/Legal/Avatar.php

Model/CRM/Service/PasswordHasher.php

[Константин Марченко]

/models/Site/Entities/Phys
/models/Site/Entities/Legal
?
где site это модуль
Верно?

[Константин Марченко]

Максим,

Дмитрий свой модуль Shop вынес в корень проекта. Но вы везде в проекте можете разделять папками: Model/Shop/Product.php

Backend это не только может быть админка. Просто в Yii так часто делают.

Вы имеете ввиду так же разделять в /common/models backend/models и /frontend/models ?

[Максим]

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

[Константин Марченко]

Максим, Что вы подразумеваете под фразой - Доменный слой ? И второе это что вы подразумеваете под путем Model/CRM/ ? Или это вы просто как абривиатуру написали?

[Максим]

Константин Марченко, архитектура advanced избыточна. Поэтому Дмитрий вынес все, кроме контроллеров и поисковых моделей в отдельную папку в корне. Я бы тоже помоветовал отказаться от Advanced. Так как у вас сейчас три приложения. Это избыточно. ПодходиТ для высоконапряжённых проектов. В остальном он лишний. Но вы можете взять за правило и все хранить в common.

[Максим]

Константин Марченко, почитайте что такое доменный слой))

https://m.habr.com/ru/post/61524/

https://yandex.ru/images/touch/search?text=ddd&sou...

https://deworker.pro/edu/series/interactive-site/d...
https://deworker.pro/edu/series/interactive-site/a...

[Константин Марченко]

Максим,

common/models/Entity/Legal
common/models/Entity/Phys

common/models/Entity/Legal/Legal.php
common/models/Entity/Legal/Contact.php

common/models/UseCase/Handler.php

common/models/Service/Legal/Avatar.php

common/models/Service/PasswordHasher.php

Я правильно понял?

[Максим]

Константин Марченко, да. Можете так)