Magento 2 中的 Event 和观察者详解

在 Magento 2 的开发中，Event（事件）和观察者（Observer）是非常强大的机制，它们可以帮助开发者实现松耦合的系统架构，提高代码的可维护性和可扩展性。

一、Event 和观察者的基本概念

（一）Event 的定义与作用
在 Magento 2 中，Event 是一种在特定操作发生时触发的通知机制。这些操作可以是用户的行为，如下单、登录等，也可以是系统内部的操作，如数据库更新、缓存清除等。

当一个 Event 被触发时，系统会通知所有注册了该 Event 的观察者。观察者可以根据 Event 的类型和参数执行特定的操作，如发送邮件、更新数据库、记录日志等。

（二）观察者的定义与作用
观察者是一个实现了特定接口的类，它用于监听和响应特定的 Event。当一个 Event 被触发时，Magento 2 会自动调用所有注册了该 Event 的观察者的方法，执行相应的操作。

观察者可以根据 Event 的类型和参数进行不同的操作，从而实现对系统行为的定制和扩展。

二、Magento 2 中 Event 的类型

（一）系统内置 Event
Magento 2 中有很多内置的 Event，这些 Event 涵盖了系统的各个方面。例如，当一个订单被创建时，会触发 “sales_order_place_after” Event；当一个产品被保存时，会触发 “catalog_product_save_after” Event。

开发者可以通过注册观察者来监听这些内置 Event，实现对系统行为的定制和扩展。

（二）自定义 Event
除了系统内置的 Event 外，开发者还可以根据自己的需求创建自定义 Event。自定义 Event 可以在特定的操作发生时触发，通知观察者执行相应的操作。

例如，开发者可以创建一个 “custom_event_after_product_import” Event，在产品导入完成后触发该 Event，通知观察者进行相应的处理。

三、创建和注册观察者

（一）创建观察者类
要创建一个观察者，首先需要创建一个实现了特定接口的类。在 Magento 2 中，观察者类需要实现 “Magento\Framework\Event\ObserverInterface” 接口。

以下是一个简单的观察者类的示例：

收起

php

复制

<?php

namespace Vendor\Module\Observer;

use Magento\Framework\Event\Observer;
use Magento\Framework\Event\ObserverInterface;

class CustomObserver implements ObserverInterface
{
    public function execute(Observer $observer)
    {
        // 在这里实现观察者的逻辑
        return $this;
    }
}

在这个示例中，“execute” 方法是观察者的主要逻辑所在。当对应的 Event 被触发时，Magento 2 会自动调用这个方法，并传递一个 “Observer” 对象作为参数。

（二）注册观察者
创建了观察者类后，需要将其注册到 Magento 2 的系统中，以便在对应的 Event 被触发时能够被调用。

在 Magento 2 中，可以通过在模块的 “etc/events.xml” 文件中注册观察者。以下是一个注册观察者的示例：

收起

xml

复制

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <event name="custom_event">
        <observer name="vendor_module_custom_observer" instance="Vendor\Module\Observer\CustomObserver"/>
    </event>
</config>

在这个示例中，我们注册了一个名为 “vendor_module_custom_observer” 的观察者，用于监听 “custom_event” Event。当 “custom_event” Event 被触发时，Magento 2 会自动调用 “Vendor\Module\Observer\CustomObserver” 类的 “execute” 方法。

四、示例展示

（一）发送邮件通知的观察者
假设我们要在一个订单被创建后发送一封邮件通知给管理员。我们可以通过创建一个观察者来实现这个功能。

创建观察者类

收起

php

复制

<?php

namespace Vendor\Module\Observer;

use Magento\Framework\Event\Observer;
use Magento\Framework\Event\ObserverInterface;
use Magento\Framework\Mail\Template\TransportBuilder;
use Magento\Store\Model\StoreManagerInterface;

class OrderCreatedObserver implements ObserverInterface
{
    protected $transportBuilder;
    protected $storeManager;

    public function __construct(
        TransportBuilder $transportBuilder,
        StoreManagerInterface $storeManager
    ) {
        $this->transportBuilder = $transportBuilder;
        $this->storeManager = $storeManager;
    }

    public function execute(Observer $observer)
    {
        $order = $observer->getEvent()->getOrder();
        // 发送邮件通知
        $transport = $this->transportBuilder
            ->setTemplateIdentifier('order_created_notification')
            ->setTemplateOptions([
                'area' => \Magento\Framework\App\Area::AREA_ADMINHTML,
                'store' => $this->storeManager->getStore()->getId()
            ])
            ->setTemplateVars([
                'order' => $order
            ])
            ->setFrom('general')
            ->addTo('admin@example.com')
            ->getTransport();
        $transport->sendMessage();
        return $this;
    }
}

注册观察者
在模块的 “etc/events.xml” 文件中注册观察者：

收起

xml

复制

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <event name="sales_order_place_after">
        <observer name="vendor_module_order_created_observer" instance="Vendor\Module\Observer\OrderCreatedObserver"/>
    </event>
</config>

（二）记录日志的观察者
假设我们要在一个产品被保存后记录一条日志。我们可以通过创建一个观察者来实现这个功能。

创建观察者类

收起

php

复制

<?php

namespace Vendor\Module\Observer;

use Magento\Framework\Event\Observer;
use Magento\Framework\Event\ObserverInterface;
use Psr\Log\LoggerInterface;

class ProductSavedObserver implements ObserverInterface
{
    protected $logger;

    public function __construct(LoggerInterface $logger)
    {
        $this->logger = $logger;
    }

    public function execute(Observer $observer)
    {
        $product = $observer->getEvent()->getProduct();
        // 记录日志
        $this->logger->info('Product saved: '. $product->getName());
        return $this;
    }
}

注册观察者
在模块的 “etc/events.xml” 文件中注册观察者：

收起

xml

复制

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <event name="catalog_product_save_after">
        <observer name="vendor_module_product_saved_observer" instance="Vendor\Module\Observer\ProductSavedObserver"/>
    </event>
</config>

五、注意事项与最佳实践

（一）避免过度依赖 Event 和观察者
虽然 Event 和观察者是非常强大的机制，但过度依赖它们可能会导致系统的复杂性增加。在使用 Event 和观察者时，应该根据实际需求进行合理的设计，避免过度使用。

（二）确保观察者的性能
观察者的执行时间应该尽量短，以免影响系统的性能。如果观察者的执行时间较长，可以考虑将其执行过程异步化，或者使用队列等机制来提高系统的性能。

（三）文档记录 Event 和观察者
为了方便其他开发者理解和维护系统，应该对系统中使用的 Event 和观察者进行文档记录。文档记录应该包括 Event 的触发条件、观察者的作用和执行逻辑等信息。

六、与其他 Magento 2 特性的结合

（一）与插件（Plugin）结合
Event 和观察者可以与插件结合使用，实现更强大的功能。例如，可以在插件中触发一个 Event，通知观察者执行特定的操作，从而实现对系统行为的定制和扩展。

（二）与依赖注入结合
在观察者的构造函数中，可以使用依赖注入来获取其他对象的实例，从而实现更复杂的功能。例如，可以注入一个邮件发送对象，在观察者中发送邮件通知。

七、性能影响与优化

（一）性能考虑
Event 和观察者的使用可能会对系统性能产生一定的影响。当一个 Event 被触发时，系统需要遍历所有注册了该 Event 的观察者，并调用它们的方法。如果观察者的数量较多或者执行时间较长，可能会影响系统的性能。

（二）优化策略
为了减少 Event 和观察者对系统性能的影响，可以采取以下优化策略：

减少观察者的数量：只注册必要的观察者，避免不必要的观察者注册。
优化观察者的执行逻辑：确保观察者的执行时间尽量短，避免在观察者中执行复杂的操作。
使用异步执行：如果观察者的执行时间较长，可以考虑将其执行过程异步化，避免影响系统的性能。

八、总结与展望

Event 和观察者是 Magento 2 中非常强大的机制，它们可以帮助开发者实现松耦合的系统架构，提高代码的可维护性和可扩展性。通过合理地使用 Event 和观察者，并结合其他 Magento 2 的特性，可以实现更加灵活和强大的系统功能。

在未来，随着 Magento 2 的不断发展，Event 和观察者的功能可能会进一步增强和扩展。开发者可以期待更多的内置 Event 和更灵活的观察者注册方式，为 Magento 2 的开发带来更多的便利。

Magento 2 中的 Event 和观察者详解

发表回复取消回复

最新文章

模块实战：前端路由和控制器

模块实战：Model、ResourceModel、Collection

模块实战：InstallSchema 脚本

Magento 2 中的 Event 和观察者详解

发表回复 取消回复

最新文章

模块实战：前端路由和控制器

模块实战：Model、ResourceModel、Collection

模块实战：InstallSchema 脚本

发表回复取消回复