Magento 2 事件列表以及如何使用它们

在这篇文章中，我们将向您展示如何在 Magento 2 中使用事件。但首先我们需要了解事件和观察者。 Magento 2 中的事件和观察者实现基于发布-订阅模式。 使用事件和观察者，您可以运行自定义代码来响应特定的 Magento事件甚至自定义事件。

Magento 中的事件是什么？

当触发某些操作时，事件由模块分派。 除了它自己的事件之外，Magento 还允许您创建可以在您的代码中调度的自己的事件。 当一个事件被调度时，它可以将数据传递给任何被配置为观察该事件的观察者。

Magento 中的观察者是什么？

观察者是某种类型的 Magento 类，可以影响一般行为、性能或更改业务逻辑。 每当事件管理器调度它们配置为观察的事件时，就会执行观察者。

现在我们了解了术语，让我们将它们投入使用！

1.创建event.xml文件

您可以为不同的区域创建event.xml文件：

• 全局区： app/code/Simi/HelloWorld/etc/events.xml
• 前端区： app/code/Simi/HelloWorld/etc/frontend/events.xml
• 管理区： app/code/Simi/HelloWorld/etc/adminhtml/events.xml

 <?xml 版本="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <event name="my_module_event_before">
        <observer name="myObserverName" instance="MyCompany\MyModule\Observer\MyObserver" />
    </事件>
    <事件名称="my_module_event_after">
        <observer name="myObserverName" instance="MyCompany\MyModule\Observer\AnotherObserver" />
    </事件>
</配置>

2.创建观察者类

要创建观察者，您必须将类文件放在<module-root>/Observer目录下。 你的观察者类应该实现Magento\Framework\Event\ObserverInterface并定义它的执行函数。

下面是一个基本的观察者类结构的例子：

 命名空间 MyCompany\MyModule\Observer；

使用 Magento\Framework\Event\ObserverInterface；

MyObserver 类实现 ObserverInterface
{
  公共函数 __construct()
  {
    // 观察者初始化代码...
    // 你可以使用依赖注入来获取这个观察者可能需要的任何类。
  }

  公共函数执行（\Magento\Framework\Event\Observer $observer）
  {
    // 观察者执行代码...
  }
}

观察者的强大功能之一是它们能够在事件被调度时使用传递给事件的参数。

下面是一个观察者获取事件分发时传入的数据的示例：

 命名空间 MyCompany\MyModule\Observer；

使用 Magento\Framework\Event\ObserverInterface；

类 AnotherObserver 实现 ObserverInterface
{
  公共函数 __construct()
  {
    // 观察者初始化代码...
    // 你可以使用依赖注入来获取这个观察者可能需要的任何类。
  }

  公共函数执行（\Magento\Framework\Event\Observer $observer）
  {
    $myEventData = $observer->getData('myEventData');
    // 额外的观察者执行代码...
  }
}

订阅事件

可以将观察者配置为观察 eve​​nts.xml 文件中的某些事件。

观察者 xml 元素具有以下属性：

• name (required) -- 事件定义的观察者的名字。
• instance (required) -- 观察者的完全限定类名。
• disabled - 确定此观察者是否处于活动状态。 默认值为假。
• shared – 决定班级的生活方式。 默认为真。

下面是一个如何分配观察者来观察某些事件的例子：

 <?xml 版本="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <event name="my_module_event_before">
        <observer name="myObserverName" instance="MyCompany\MyModule\Observer\MyObserver" />
    </事件>
    <事件名称="my_module_event_after">
        <observer name="myObserverName" instance="MyCompany\MyModule\Observer\AnotherObserver" />
    </事件>
</配置>

请注意，每个事件定义的观察者名称必须是唯一的。 在同一个事件定义中不能有两个同名的观察者以避免覆盖。

3.调度事件

可以使用Magento\Framework\Event\Manager类调度事件。 这个类可以通过在你的构造函数中定义依赖来通过依赖注入获得。

要分派事件，请调用事件管理器类的分派函数，并为它提供您要分派的事件的名称以及您希望提供给观察者的数据数组。

以下示例向您展示了如何分派带有和不带有数据数组的事件。

 命名空间 MyCompany\MyModule;

使用 Magento\Framework\Event\ManagerInterface 作为 EventManager；

我的班级
{
  /**
   * @var 事件管理器
   */
  私人 $eventManager;

  公共函数 __construct(EventManager $eventManager)
  {
    $this->eventManager = $eventManager;
  }

  公共功能某事（）
  {
    $事件数据=空；
    // 代码...
    $this->eventManager->dispatch('my_module_event_before');
    // 更多设置 $eventData 的代码...
    $this->eventManager->dispatch('my_module_event_after', ['myEventData' => $eventData]);
  }
}

Magento 2 事件列表

也可以看看：

如何在 Magento 2 中启用开发者模式

如何在 Magento 2 中获取产品图片 URL