Maksym Grom gives a talk on Magento DI at Magento Meetup Kharkiv.

1. Deep dive in
Magento DI
Maksym Grom

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

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

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

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

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

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

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

9. ObjectManager - IoC
Что дает DI для M2? 54

10. Декларативная xml схема композиции
Что дает DI для M2? 55

11. xsi:type
Простые типы: string, boolean, number
Опциональный параметр: null
Что дает DI для M2? 56

12. xsi:type =”const”
Внедрит константу класса как параметр
Что дает DI для M2? 57

13. xsi:type =”array”
Позволяет строить дерево параметров
Что дает DI для M2? 58

14. xsi:type =”init_parameter”
Внедрит $_SERVER[$key]
Что дает DI для M2? 59

15. xsi:type =”object”
Создаст shared инстанс класса и внедрит
Что дает DI для M2? 60

16. Биндинг интерфейсов к реализациям (SOLID)
Что дает DI для M2? 61

17. Перехват публичных методов. Plugins (SOLID)
Что дает DI для M2? 62

18. Запуск приложения с разными настройками
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 для M2? 63

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

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

21. Решить для какой 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

22. ObjectManager -> create or get (Shared)
create($type, $arguments) get($type)
Cached?
Create type
Return object
Cache type
getPreference
true
false
Как работает DI? 67

23. 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 (рекурсия)
Как работает DI? 68

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

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

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

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

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

29. Задача, добавить грид в админку
ProjectBlogetcadminhtmldi.xml
CollectionFactory
Собирается как global di.xml
Ограничения DI 74

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

31. Задача, добавить грид в админку
ProjectBlogetcdi.xml
Не используйте слеш перед именем
класса!
Ограничения DI 76

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

48. Plugins

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

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

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

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

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

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

55. Factory

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

57. Magento создаст фабрику автоматически
по наличию постфикса Factory
Factory. Набрать массив интерфейсных моделей 102

58. Factory без хардкода
Factory. Набрать массив интерфейсных моделей 103

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

60. Proxy

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

62. Добавим зависимости
Proxy. CLI, загрузка продукта SKU TEST 107

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

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

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

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

67. 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

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

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

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

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

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

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

74. Выводы

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

76. Что почитать
- https://devdocs.magento.com/guides/v2.3/extension-dev-guide/build/di-xml-file.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

77. Q&A