ZF2 - 如何侦听事件并因此触发服务？

Question

ZF2 - 如何侦听事件并因此触发服务？

rke*_*eet 4 php event-handling zend-framework2

一直在尝试学习如何实现服务，因为它们被监听器触发。曾经一直在做一个严肃的大量的阅读的最后几天里得到它的工作，但都被发现很难。因此，我认为我对事物顺序的理解可能有缺陷。

我试图开始工作的用例如下：

就在地址实体（使用 Doctrine，但这并不重要）被保存（刷新）之前，必须触发一个服务来检查地址的坐标是否设置，如果没有，创建并填充一个新的坐标实体并链接它到地址。坐标将从 Google Maps Geocoding API 获取。

将在下面展示我对事物的理解和理解方式，希望我能让自己清楚。据我所知，将分步执行以显示中间添加的代码，并告诉您哪些有效，哪些无效。

现在，我对过去几天获得的所有信息的理解是：

监听器必须注册到 ZF2 的 ServiceManager。侦听器将某些条件“附加”到（共享）EventManager。EventManager 对一个对象是唯一的，但 SharedEventManager 在应用程序中是“全局的”。

在 Address 模块的Module.php类中，我添加了以下函数：

/**
 * @param EventInterface $e
 */
public function onBootstrap(EventInterface $e)
{
    $eventManager = $e->getTarget()->getEventManager();
    $eventManager->attach(new AddressListener());
}

Run Code Online (Sandbox Code Playgroud)

这得到了工作，AddressListener 被触发。

地址监听器如下：

use Address\Entity\Address;
use Address\Service\GoogleCoordinatesService;
use Zend\EventManager\EventManagerInterface;
use Zend\EventManager\ListenerAggregateInterface;
use Zend\Stdlib\CallbackHandler;

class AddressListener implements ListenerAggregateInterface
{
    /**
     * @var CallbackHandler
     */
    protected $listeners;

    /**
     * @param EventManagerInterface $events
     */
    public function attach(EventManagerInterface $events)
    {
        $sharedEvents = $events->getSharedManager();

        // Not sure how and what order params should be. The ListenerAggregateInterface docblocks didn't help me a lot with that either, as did the official ZF2 docs. So, been trying a few things...

        $this->listeners[] = $sharedEvents->attach(GoogleCoordinatesService::class, 'getCoordinates', [$this, 'addressCreated'], 100);

        $this->listeners[] = $sharedEvents->attach(Address::class, 'entity.preFlush', [GoogleCoordinatesService::class, 'getCoordinates'], 100);
    }

    /**
     * @param EventManagerInterface $events
     */
    public function detach(EventManagerInterface $events)
    {
        foreach ($this->listeners as $index => $listener) {
            if ($events->detach($listener)) {
                unset($this->listeners[$index]);
            }
        }
    }

    public function addressCreated()
    {
        $foo = 'bar'; // This line is here to as debug break. Line is never used...
    }
}

Run Code Online (Sandbox Code Playgroud)

我期待一个监听工作作为跳板排序的石点，事情被触发的基础上，->attach()在职能function attach(...){}。但是，这似乎不起作用，因为没有触发任何内容。不是addressCreated()函数，也不getCoordinates是GoogleCoordinatesService.

上面的代码应该触发GoogleCoordinatesService函数getCoordinates。但是，该服务有一些要求，例如 Doctrine 的 EntityManager 的存在、它所关注的地址实体和配置。

为此，我创建了以下配置。

文件google.config.php（被加载，检查）

return [
    'google' => [
        'services' => [
            'maps' => [
                'services' => [
                    'geocoding' => [
                        'api_url' => 'https://maps.googleapis.com/maps/api/geocode/json?',
                        'api_key' => '',
                        'url_params' => [
                            'required' => [
                                'address',
                            ],
                            'optional' => [
                                'key'
                            ],
                        ],
                    ],
                ],
            ],
        ],
    ],
];

Run Code Online (Sandbox Code Playgroud)

而在module.config.php我注册一个厂服务

'service_manager' => [
    'factories' => [
        GoogleCoordinatesService::class => GoogleCoordinatesServiceFactory::class,
    ],
],

Run Code Online (Sandbox Code Playgroud)

工厂是非常标准的 ZF2 东西，但要描绘一个完整的画面，这里是GoogleCoordinatesServiceFactory.php类。（删除评论/类型提示/等）

class GoogleCoordinatesServiceFactory implements FactoryInterface
{
    public function createService(ServiceLocatorInterface $serviceLocator, $options = [])
    {
        $serviceManager = $serviceLocator->getServiceLocator();
        $entityManager = $serviceManager->get(EntityManager::class);
        $config = $serviceManager->get('Config');

        if (isset($options) && isset($options['address'])) {
            $address = $options['address'];
        } else {
            throw new InvalidArgumentException('Must provide an Address Entity.');
        }

        return new GoogleCoordinatesService(
            $entityManager,
            $config,
            $address
        );
    }
}

Run Code Online (Sandbox Code Playgroud)

下面是GoogleCoordinatesService班级。然而，没有任何东西被触发在那里执行。由于它甚至没有被调用，我确定问题出在上面的代码中，但无法找出原因。从我阅读和尝试的内容来看，我希望类本身应该通过工厂被调用，并且getCoordinates函数应该被触发。

所以，上课。我删除了一堆标准的 getter/setter、注释、文档块和类型提示，以使其更短。

class GoogleCoordinatesService implements EventManagerAwareInterface
{
    protected $eventManager;
    protected $entityManager;
    protected $config;
    protected $address;

    /**
     * GoogleCoordinatesServices constructor.
     * @param EntityManager $entityManager
     * @param Config|array $config
     * @param Address $address
     * @throws InvalidParamNameException
     */
    public function __construct(EntityManager $entityManager, $config, Address $address)
    {    
        $this->config = $config;
        $this->address = $address;
        $this->entityManager = $entityManager;
    }

    public function getCoordinates()
    {
        $url = $this->getConfig()['api_url'] . 'address=' . $this->urlFormatAddress($this->getAddress());

        $response = json_decode(file_get_contents($url), true);

        if ($response['status'] == 'OK') {
            $coordinates = new Coordinates();
            $coordinates
                ->setLatitude($response['results'][0]['geometry']['location']['lat'])
                ->setLongitude($response['results'][0]['geometry']['location']['lng']);

            $this->getEntityManager()->persist($coordinates);

            $this->getAddress()->setCoordinates($coordinates);
            $this->getEntityManager()->persist($this->getAddress());

            $this->getEntityManager()->flush();

            $this->getEventManager()->trigger(
                'addressReceivedCoordinates',
                null,
                ['address' => $this->getAddress()]
            );
        } else {
            // TODO throw/set error/status
        }
    }

    public function urlFormatAddress(Address $address)
    {
        $string = // format the address into a string

        return urlencode($string);
    }

    public function getEventManager()
    {
        if ($this->eventManager === null) {
            $this->setEventManager(new EventManager());
        }

        return $this->eventManager;
    }

    public function setEventManager(EventManagerInterface $eventManager)
    {
        $eventManager->addIdentifiers([
            __CLASS__,
            get_called_class()
        ]);

        $this->eventManager = $eventManager;
        return $this;
    }

    // Getters/Setters for EntityManager, Config and Address
}

Run Code Online (Sandbox Code Playgroud)

因此，这是在触发某个事件时处理它的设置。现在它当然应该被触发。对于这个用例，我自己设置了一个触发器AbstractActionController（扩展了 ZF2 的AbstractActionController）。这样做：

if ($form->isValid()) {
    $entity = $form->getObject();
    $this->getEntityManager()->persist($entity);

    try {
        // Trigger preFlush event, pass along Entity. Other Listeners can subscribe to this name.
        $this->getEventManager()->trigger(
            'entity.preFlush',
            null,
            [get_class($entity) => $entity] // key = "Address\Entity\Address" for use case
        );

        $this->getEntityManager()->flush();
    } catch (\Exception $e) {
        // Error thrown
    }
    // Success stuff, like a trigger "entity.postFlush"
}

Run Code Online (Sandbox Code Playgroud)

所以是的。目前对如何让它工作有点茫然。

任何帮助将不胜感激，并希望解释“为什么”解决方案有效。这真的会帮助我制作更多这些服务:)

Answer 1

rke*_*eet 5

已经研究了一段时间，但设法弄清楚为什么它不起作用。我将Listeners附加到EventManagers，但应该将它们附加到SharedEventManager. 这是因为我在中有触发器（在这种情况下）AbstractActionController，因此它们EventManager在实例化时都会创建自己的（因为它们是唯一的）。

几天来我一直在纠结这一切，但这篇文章对我帮助最大，或者它只是让我在问题中的原始研究和随后的反复试验+调试中获得了成功。

在代码下面，按工作顺序排列。随着代码的出现，我将尝试解释我如何理解它的工作原理。如果我在某个时候弄错了，我希望有人纠正我。

首先，我们需要一个Listener，一个注册组件和事件以“监听”它们以触发的类。（它们侦听某些（命名）对象以触发某些事件）

人们很快意识到几乎每个 Listener 都需要$listeners = [];和detach(EventManagerInterface $events){...}函数。所以我创建了一个AbstractListener类。

namespace Mvc\Listener;

use Zend\EventManager\EventManagerInterface;
use Zend\EventManager\ListenerAggregateInterface;

/**
 * Class AbstractListener
 * @package Mvc\Listener
 */
abstract class AbstractListener implements ListenerAggregateInterface
{
    /**
     * @var array
     */
    protected $listeners = [];

    /**
     * @param EventManagerInterface $events
     */
    public function detach(EventManagerInterface $events)
    {
        foreach ($this->listeners as $index => $listener) {
            if ($events->detach($listener)) {
                unset($this->listeners[$index]);
            }
        }
    }
}

Run Code Online (Sandbox Code Playgroud)

在上面提到的关于必须使用SharedEventManagerand 和AbstractListenercreated 的实现之后，这个AddressListener类就这样结束了。

namespace Address\Listener;

use Address\Event\AddressEvent;
use Admin\Address\Controller\AddressController;
use Mvc\Listener\AbstractListener;
use Zend\EventManager\EventManagerInterface;

/**
 * Class AddressListener
 * @package Address\Listener
 */
class AddressListener extends AbstractListener
{
    /**
     * @param EventManagerInterface $events
     */
    public function attach(EventManagerInterface $events)
    {
        $sharedManager = $events->getSharedManager();
        $sharedManager->attach(AddressController::class, 'entity.postPersist', [new AddressEvent(), 'addCoordinatesToAddress']);
    }
}

Run Code Online (Sandbox Code Playgroud)

将事件附加到EventManager与的主要区别SharedEventManager在于后者侦听特定类以发出触发器。在这种情况下，它将侦听AddressController::class发出 trigger entity.postPersist。在“听到”它被触发后，它会调用一个回调函数。在这种情况下，使用此数组参数注册：[new AddressEvent(), 'addCoordinatesToAddress']，这意味着它将使用类AddressEvent和函数addCoordinatesToAddress。

要测试这是否有效，如果您正在使用此答案，您可以在您自己的控制器中创建触发器。我在一直工作addAction的AbstractActionController，它获取由被叫addAction的AddressController。在上面监听器的触发器下面：

if ($form->isValid()) {
    $entity = $form->getObject();

    $this->getEntityManager()->persist($entity);

    $this->getEventManager()->trigger(
        'entity.postPersist',
        $this,
        [get_class($entity) => $entity]
    );

    try {
        $this->getEntityManager()->flush();
    } catch (\Exception $e) {
        // Error stuff
    }
    // Remainder of function
}

Run Code Online (Sandbox Code Playgroud)

在->trigger()上述代码中示出了以下参数的使用功能：

'entity.postPersist' - 这是事件名称
$this - 这是调用事件的“组件”或对象。在这种情况下，它将是Address\Controller\AddressController
[get_class($entity) => $entity] - 这些是与这个Event对象一起发送的参数。它会让你有可用$event->getParams()[Address::class]的$entity价值。

前两个参数将触发SharedEventManager. 为了测试是否一切正常，可以修改 Listener 的附加函数。

将其修改为这个并在 Listener 中创建一个函数，以便您可以看到它的工作：

public function attach(EventManagerInterface $events)
{
    $sharedManager = $events->getSharedManager();
    $sharedManager->attach(AddressController::class, 'entity.postPersist', [$this, 'test']);
}

public function test(Event $event)
{
    var_dump($event);
    exit;
}

Run Code Online (Sandbox Code Playgroud)

最后，为了确保上述内容确实有效，监听器必须注册到EventManager. 这发生在模块文件中的onBootstrap函数中Module.php（在这种情况下为地址）。注册如下。

public function onBootstrap(MvcEvent $e)
{
    $eventManager = $e->getApplication()->getEventManager();
    $eventManager->attach(new AddressListener());
}

Run Code Online (Sandbox Code Playgroud)

如果调试的代码addAction中AbstractActionController，看到它通过触发器，下次你在是test功能，那么你的作品监听。

上面的代码还暗示AddressListener该类可用于附加多个侦听器。所以，你也可以为注册的东西entity.prePersist，entity.preFlush，entity.postFlush和其他任何你能想到的。

接下来，将 Listener 恢复到开始时的状态（恢复attach函数并删除test函数）。

我还注意到几乎每个Event处理类都需要能够设置和获取EventManager. 因此，为此我创建了一个AbstractEvent类，如下所示。

namespace Mvc\Event;

use Zend\EventManager\EventManager;
use Zend\EventManager\EventManagerAwareInterface;
use Zend\EventManager\EventManagerInterface;

abstract class AbstractEvent implements EventManagerAwareInterface
{
    /**
     * @var EventManagerInterface
     */
    protected $events;

    /**
     * @param EventManagerInterface $events
     */
    public function setEventManager(EventManagerInterface $events)
    {
        $events->setIdentifiers([
            __CLASS__,
            get_class($this)
        ]);

        $this->events = $events;
    }

    /**
     * @return EventManagerInterface
     */
    public function getEventManager()
    {
        if (!$this->events) {
            $this->setEventManager(new EventManager());
        }

        return $this->events;
    }
}

Run Code Online (Sandbox Code Playgroud)

老实说，我不太清楚为什么我们在setEventManager函数中设置了 2 个标识符。但足以说明它用于为事件注册回调。（如果有人愿意提供它，这可以使用更多/详细的解释）

在AddressListener我们试图调用类的addCoordinatesToAddress函数AddressEvent。所以我们将不得不创建它，我像下面那样做。

namespace Address\Event;

use Address\Entity\Address;
use Address\Service\GoogleGeocodingService;
use Country\Entity\Coordinates;
use Mvc\Event\AbstractEvent;
use Zend\EventManager\Event;
use Zend\EventManager\Exception\InvalidArgumentException;

class AddressEvent extends AbstractEvent
{
    public function addCoordinatesToAddress(Event $event)
    {
        $params = $event->getParams();
        if (!isset($params[Address::class]) || !$params[Address::class] instanceof Address) {

            throw new InvalidArgumentException(__CLASS__ . ' was expecting param with key ' . Address::class . ' and value instance of same Entity.');
        }

        /** @var Address $address */
        $address = $params[Address::class];

        if (!$address->getCoordinates() instanceof Coordinates) {
            /** @var GoogleGeocodingService $geocodingService */
            $geocodingService = $event->getTarget()->getEvent()->getApplication()->getServiceManager()->get(GoogleGeocodingService::class);
            $geocodingService->addCoordinatesToAddress($address);
        }

        $params = compact('address');
        $this->getEventManager()->trigger(__FUNCTION__, $this, $params);
    }
}

Run Code Online (Sandbox Code Playgroud)

在上面你可以看到，首先我们检查我们期望的参数是否已经与Event $event参数一起传递。我们知道我们应该期待什么以及密钥应该有什么名字，所以我们明确地检查。

接下来我们检查接收到的AddressEntity 对象是否已经有一个Coordinates与之关联的对象，如果没有，我们调用一个 Service 来实现它。

后if()声明已经用完，我们火另一个trigger。我们传递这个Event对象和参数。这最后一步不是必需的，但如果您希望链接事件，则可以很方便。

在问题中，我提到了一个用例。上面的代码使Service( GoogleGeocodingService) 能够通过它的要求并结合工厂的配置，它是通过 Zend Magic 与ServiceManager.

未修改将新Coordinates对象添加到现有Address对象的代码，因此我不会将其作为答案的一部分，您可以在问题中找到。

归档时间：	8 年，9 月前
查看次数：	1666 次
最近记录：	8 年，9 月前