Deep Dive in Magento DI

Deep dive in
Magento DI
Maksym Grom

Немного обо мне
Максим Гром Tech Lead in ZFort
3 года с Magento 2
6 лет преподавал в ХАИ
MailMaximGrom@gmail.com
Веду 2 канала на youtube:
Maksym Grom / WebDev. GromMax
47

Что полезного?
План доклада

Наследование ∉ киты ООП
Композиция - мейнстрим (не только в M2)
Private > Protected
Interface > Abstract Class
VirtualType, Plugin > Rewrite, Preference
Что полезного? 49

Увидеть новый уровень SOLIDности кода
S - один класс одна задача
O - все можно расширить
L - чистый конструктор
I - композиция интерфейсов - мейнстрим
D - проси интерфейс, а не реализацию
Что полезного? 50

DI в M2
Немного основ

DI это когда
Что дает DI для M2?
● Все объекты создаются из Inversion of Control
(IoC) Container
● IoC Container владеет конфигурацией каждого
класса в системе
● Объект просит зависимость через конструктор,
а IoC решает что туда передать
52

DI недостатки
● Создание дерева зависимостей при создании объекта
● Медленное создание объекта при медленном
конструкторе в зависимости
● Накладные расходы из-за рефлексии
● Обслуживание конфигурации (У M2 все есть -> xml)
Что дает DI для M2? 53

ObjectManager - IoC

Декларативная xml схема композиции

xsi:type
Простые типы: string, boolean, number
Опциональный параметр: null

xsi:type =”const”
Внедрит константу класса как параметр

xsi:type =”array”
Позволяет строить дерево параметров

xsi:type =”init_parameter”
Внедрит $_SERVER[$key]

xsi:type =”object”
Создаст shared инстанс класса и внедрит

Биндинг интерфейсов к реализациям (SOLID)

Перехват публичных методов. Plugins (SOLID)

Запуск приложения с разными настройками
Initial
app/etc/di.xml
Global
[vendor]/[module]/etc/di.xml
Area
[vendor]/[module]/etc/[area]/di.xml
frontend, adminhtml, webapi_rest,
webapi_soap, crontab, graphql

Как работает DI
Немного основ

Bootstrap App -> app/etc/di.xml
Как работает DI?
Загрузить initial di.xml
(app/etc/di.xml)
ObjectManager::configure($di)
MagentoFrameworkObjectManagerConfigConfig
Подготовка di в php
Создать App
65

Решить для какой area этот процесс
bin/magento http
/rest
Di
global
Di
global
cron:run
Di
crontab
Area
crontab
cli /?wsdl /admin /
Di
webapi_rest
Area
webapi_rest
Di
frontend
Area
frontend
Di
adminhtml
Area
adminhtml
Di
webapi_soap
Area
webapi_soap
Cron Job Rest Service Soap Service Action
Как работает DI? 66

ObjectManager -> create or get (Shared)
create($type, $arguments) get($type)
Cached?
Create type
Return object
Cache type
getPreference
true
false

Create type
create($type, $args)
$params = resolveParams($type)
$params === null
return new $type()
$args = resolveArguments($params, $args)
return create($type, $args)
Если аргумент object то создаем
через ObjectManager
Если shared то через get,
иначе через create (рекурсия)

Результат в M2. Single Public Method Classes
Тип класса Публичные методы
Actions dispatch
Factory create
Observer execute
Service execute
Repository* get, getById, save, getList, delete

Результат в M2
● Запускаются все конструкторы*, потом
методы
● Медленный конструктор - плохо
● Data Transfer Object (DTO) без
конструктора

Ограничения DI
ObjectManager::configure

Ограничения MagentoFrameworkObjectManagerConﬁgConﬁg
array_replace переопределяет параметры
Ограничения DI
Start from class config
trim(class, ‘’) isset(args[class])
Обновить аргументы через array_replace
true
72

Задача, добавить грид в админку
ProjectBlogetcadminhtmldi.xml
В любом гриде в админке ошибка
Невозможно создать [name]_data_source
В чем проблема?
Ограничения DI 73

ProjectBlogetcadminhtmldi.xml
CollectionFactory
Собирается как global di.xml

Ограничения MagentoFrameworkObjectManagerConfigConfig
MyClass === MyClass
issue #21193 #21796
Start from class config
trim(class, ‘’) isset(args[class])
Обновить аргументы через array_replace
true

ProjectBlogetcdi.xml
Не используйте слеш перед именем
класса!

Virtual Type
Жизнь без
наследования

Переиспользуй классы
MagentoFrameworkPricingPricePool
Virtual type 78

Регистрируй в DI новый тип
Заменяй аргументы конструктора
Virtual type 79

Внедряй новый тип на место старого
Virtual type 80

Или получай через ObjectManager
Или внедряй как Block
Или внедряй как ViewModel
Virtual type 81

Примечание
● VirtualType может быть создан из VirtualType
● Параметры конструктора type и virtualType
склеиваются через array_replace
● Для класса типа Pool нужно обеспечить
возможность склейки типов
Virtual type 82

Pool, склеиваем массив в конструкторе Virtual type 83

Задача
● Загрузить список продуктов
● Продукты конкретной категории
● Если категория anchor, то загрузить продукты
дочерних категорий
Virtual type 84

Наши пожелания
● Создать как можно меньше кода
● Не создавать новые API сервисы
● В идеале использовать
MagentoCatalogApiProductRepositoryInterface
● Не использовать ProductCollection как
зависимость в своем коде
Virtual type 85

Посмотрим что есть в ProductRepository Virtual type 86

Изучим что за ProductCollectionProcessor
Фильтры - то что нужно
Virtual type 87

FilterProcessor
Ура! Есть место и пример класса для
внедрения
Virtual type 88

Внедряем свой класс для фильтра
Ключ важен!
Virtual type 89

Осталось реализовать фильтр
$collection умеет делать такую фильтрацию
Virtual type 90

Можно пользоваться
Virtual type 91

VirtualType. Вывод
● Это экземпляр базового класса
● Идеально для композиции
● Массивы в конструкторе замещаются
полностью
● Можно создать через ObjectManager
● VirtualType можно сделать из VirtualType
Virtual type 92

Plugin регистрируется в di.xml
Перехватывает любой публичный метод
Класс плагина не нужно наследовать
Plugin это shared объект
Plugins 94

Как DI решает кого плагинить (dev mode)
Начало
Сканировать методы
before[MetodName]
around[...], after[...]
Есть плагины в
цепочке
Завершить для этого класса
Вычислить цепочку родителей
(классы, интерфейсы)
Генерировать Interceptor
Подготовить конфиг
очередности вызовов для
методов
Этот
класс
Final?
Сортировать плагины
Подменить класс на Interceptor
true
false true
false
Plugins 95

Очередность вызова плагинов
Plugins 96

Around может прерывать цепочку вызовов Plugins 97

Plugins не работают для
Static method
- Должен быть создан класс через ObjectManager
Private method
- Не наследуются в Interceptor
Protected method
- Нарушение SOLID принципов (use preference)
VirtualType - новый объект, а не класс
- Плагинится класс
Plugins 98

Plugins. Вывод
● Используй на классы другого модуля
● Делай stateless plugin - shared object
● Before plugin для подмены входных параметров
● After plugin для подмены результата
● Around plugin > preference
● Используй на Interface > Class
Plugins 99

Задача подготовить массив моделей из CSV
Модель другого модуля с интерфейсом
Интерфейс с пометкой @api, модель нет
● Через конструктор можно получить только
один объект или shared
● Через new нельзя создавать интерфейсы
● Классы без @api могут быть удалены - проблема
обновлений
Factory. Набрать массив интерфейсных моделей 101

Magento создаст фабрику автоматически
по наличию постфикса Factory

Factory без хардкода

Factory. Вывод
● Нужно создавать объекты? Используй
Factory
● Factory - пример класса без хардкода
● Генерация Factory гарантирует
однотипность этого подхода
Factory 104

Задача сделать CLI, работающую с frontend area
И загрузить продукт со SKU “Test”
Vendor/Module/etc/di.xml
Proxy. CLI, загрузка продукта SKU TEST 106

Добавим зависимости

Инициализируем area и di в начале метода execute
1. Активирует area для специальных случаев (загрузка
сессии)
2. Подключает DI для area

Проблема. ProductRepository создан в конструкторе
1. Обращение к БД в конструкторе CLI
2. Создание класса до готовности DI (1-2-3 -> 2-1-3)

Подменяем класс на Proxy
Proxy - отложенная загрузка класса. При первом запросе к
proxy объекту будет создан исходный объект.
Назначайте Proxy только через di.xml

Integration Test
Начало
Очистка тестовой
DB
bin/magento setup:upgrade
Запуск тестов на новой БД
Создает ConsoleListInterface
Создает все объекты команд
Для каждой команды строится
дерево зависимостей
-Запрос к БД ломает наполнение БД
-ResourceModel делает запрос к БД
-Repository внедряет ResourceModel
Proxy 111

Repository 1-3 ломает запуск тестов
ConsoleListInterface
CLI #1
CLI #2 CLI #3
CLI #4
Service #1
Repository #2
Repository #3Service #2
Repository #1 Service #3
Proxy 112

Proxy обрывает дерево зависимостей
CLI #1
CLI #2 CLI #3
CLI #4
Service #1
Repository #2
Proxy 113

S#2 -> R#2 ломает тесты, добавим прокси
CLI #1
CLI #2 CLI #3
CLI #4
Service #1
Repository #2
Proxy 114

S#1 -> R#1 новая связь, ломает тесты
CLI #1
CLI #2 CLI #3
CLI #4
Service #1
Repository #2
Proxy 115

S#1 -> R#1 опять PROXY :(. Может есть выход?
CLI #1
CLI #2 CLI #3
CLI #4
Service #1
Repository #2
Proxy 116

Внедряй на 1 CLI 1 Service + Proxy
CLI #1
CLI #2 CLI #3 CLI #4
Service #1
Repository #2
CLI Service #2CLI Service #1
CLI Service #4
CLI Service #3
Proxy 117

Proxy. Вывод
● Всегда проксируй зависимости CLI
● Минимизируй количество зависимостей CLI
● Используй Proxy для медленного
конструктора
Proxy 118

Выводы в целом
● Создавай объекты через Factory
● Медленный конструктор - плохо (Proxy)
● Используй композицию вместо наследования
● Используй чужой код через VirtualType
● Инициализируй сервис через конструктор
● Расширяй сервисы через Plugin
120

Что почитать
- https://devdocs.magento.com/guides/v2.3/extension-dev-guide/build/di-xml-ﬁle.html
- https://devdocs.magento.com/guides/v2.3/extension-dev-guide/factories.html
- https://devdocs.magento.com/guides/v2.3/extension-dev-guide/proxies.html
- https://devdocs.magento.com/guides/v2.3/extension-dev-guide/code-generation.html
- https://alanstorm.com/magento_2_object_manager_virtual_types/
- https://devdocs.magento.com/guides/v2.3/extension-dev-guide/attributes.html
- https://devdocs.magento.com/guides/v2.3/extension-dev-guide/searching-with-repositories.html
121

Deep Dive in Magento DI

More Related Content

What's hot (20)

Similar to Deep Dive in Magento DI (20)

More from Magecom UK Limited (20)

Deep Dive in Magento DI