Как работать с extension attributes в m2?

Question

[Михаил]

Каждый проект рано или поздно требует добавлять кастомные атрибуты. Например, в заказе понадобилось хранить дополнительную дату. Первое что нужно сделать - открыть документацию. В ней сказано что расширять модели возможно с помощью custom и extension attributes. Как правило, custom используются больше как атрибуты для пользователя, а extension - как системные. Создаем файл extension_attributes.xml и добавляем в него нужные атрибуты к сущностям. В нашем случае дату к модели заказа.
Итак, по документации мы все сделали и теперь можно начать пользоваться атрибутами... но они не работают. Ах да, нужно же очистить кэш. Тогда очищаем и обязательно удаляем сгенерированный код из /generated. Вроде ничего не забыли. Что же, теперь система не ругается на несуществующие атрибуты, но мы опять замечаем что опять ничего не работает.
По прошествии пары дней (у кого как), становится ясно что для обеспечения работы наших дорогих атрибутов оказывается нужно делать специальную реализацию. И опять же, самое интересное - впереди. Сделав реализацию для Repository, для чтения и записи отдельно, - а как вы думали? - внезапно оказывается что в коллекциях атрибуты... правильно, === null. Не, ну а кто любит чтобы сразу и удобно. Очевидно что не разработчики мадженты. Ничего не остается как сделать реализацию и для collection. И не забыть еще плагин afterGetExtensionAttributes. Он будет делать проверку: если атрибуты === null, то создаем их. Не спрашивайте зачем это.

После многих усилий... нет, нет и еще раз нет: ничего не будет работать если вы попробуете загрузить сущность через load в модели. Сказать что система переусложнена - ничего не сказать. Знаете, какие советы по поводу такого на SO? Предлагают загружать сущность [заказ] еще раз. Отлично, после стольких оптимизаций разработчикам приходится загружать сущности на каждом углу ради атрибутов.

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

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

Answer 1

[Code Keeper]

Для начала нужно понимать что такое EAV сущности и как они работают.
https://alanstorm.com/magento_advanced_orm_entity_...

Extesndion Attribute не что иное как eav атрибут для сущности и работать с ним можно так же как и с любым другим Eav атрибутом.

Сделав реализацию для Repository, для чтения и записи отдельно, - а как вы думали?

Что еще за отдельная реализация?

внезапно оказывается что в коллекциях атрибуты... правильно, === null. Не, ну а кто любит чтобы сразу и удобно.

Нет, методы добавить-то можно, но атрибуты могут быть не загружены что убивает всю возможность

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

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

Потому что они не знают про то как работает EAV и про addAttributeToSelect

$collection->addAttributeToSelect('unit_of_sale', 'catalog_product_entity_varchar')

Comments

[Михаил]

Вы говорите про eav-атрибуты. С ними немного другая история. Изначально речь шла о extension которые по большому счету - просто колонка в таблице сущности.

Что еще за отдельная реализация?

Отдельная реализация .
А вот нашел в доке еще.
public function afterGet

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

Так самое забавное то что они уже загружены предварительно. Если правильно помню, то они хранятся в $_data[] откуда и нужно их переносить вручную в $_extensionAttributes[] в модели сущности.

Потому что они не знают про то как работает EAV и про addAttributeToSelect

catalog_product_entity_varchar

Вы явно о custom attributes.

[Code Keeper]

Так самое забавное то что они уже загружены предварительно. Если правильно помню, то они хранятся в $_data[] откуда и нужно их переносить вручную в $_extensionAttributes[] в модели сущности.

Специально порылся в базовых моделях, ничего подобного $_extensionAttributes там и близко нет. единственное упоминание в /vendor/magento/zendframework1/library/Zend/Gdata/App/Base.php:68

а вот setExtensionAttributes достаточно много.

Вы явно о custom attributes.

Да действительно. По поводу этих атрибутов их нужно принудительно сетить и скорее всего null может быть связан с ошибкой в конфигурации, а метод afterGet это просто костыль. Нужно смотреть код и делать отладку

[Михаил]

Code Keeper, Ну что, иду запускать xdebug и покажу что есть что.

В общем, не совсем идеально, зато понятно: изначально атрибуты пусты, но значения для них уже хранятся в объекте. А хранятся потому что атрибуты (как выше я уже писал) - это дополнительные колонки в бд.
См order_date.


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

Нужно смотреть код и делать отладку

Нужно.

метод afterGet это просто костыль

Маджента, собственно, и сама костыльна. Хотя и имеет много крутого.

[Code Keeper]

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

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

Я уже писал custom это для eav сущности, а это не только продукты, а так же customer, customer_adress, order, quote, category. Если сущность flat, то данные в нее грузятся все по умолчaнию потому как реализован active record.