Symfony DI:与Doctrine事件订阅者

时间:2016-09-29 12:00:48

标签: php symfony dependency-injection doctrine-orm

为了重构有关故障单通知系统的代码,我创建了一个Doctrine监听器:

final class TicketNotificationListener implements EventSubscriber
{
    /**
     * @var TicketMailer
     */
    private $mailer;

    /**
     * @var TicketSlackSender
     */
    private $slackSender;

    /**
     * @var NotificationManager
     */
    private $notificationManager;

    /**
     * We must wait the flush to send closing notification in order to
     * be sure to have the latest message of the ticket.
     *
     * @var Ticket[]|ArrayCollection
     */
    private $closedTickets;

    /**
     * @param TicketMailer        $mailer
     * @param TicketSlackSender   $slackSender
     * @param NotificationManager $notificationManager
     */
    public function __construct(TicketMailer $mailer, TicketSlackSender $slackSender, NotificationManager $notificationManager)
    {
        $this->mailer = $mailer;
        $this->slackSender = $slackSender;
        $this->notificationManager = $notificationManager;

        $this->closedTickets = new ArrayCollection();
    }

    // Stuff...
}

目标是在使用Doctrine SQL通过邮件,Slack和内部通知创建或更新Ticket或TicketMessage实体时发送通知。

我已经与Doctrine存在循环依赖问题,所以我从事件args中注入了实体管理器:

class NotificationManager
{
    /**
     * Must be set instead of extending the EntityManagerDecorator class to avoid circular dependency.
     *
     * @var EntityManagerInterface
     */
    private $entityManager;

    /**
     * @var NotificationRepository
     */
    private $notificationRepository;

    /**
     * @var RouterInterface
     */
    private $router;

    /**
     * @param RouterInterface $router
     */
    public function __construct(RouterInterface $router)
    {
        $this->router = $router;
    }

    /**
     * @param EntityManagerInterface $entityManager
     */
    public function setEntityManager(EntityManagerInterface $entityManager)
    {
        $this->entityManager = $entityManager;
        $this->notificationRepository = $this->entityManager->getRepository('AppBundle:Notification');
    }

    // Stuff...
}

经理从TicketNotificationListener

注入
public function postPersist(LifecycleEventArgs $args)
{
    // Must be lazy set from here to avoid circular dependency.
    $this->notificationManager->setEntityManager($args->getEntityManager());
    $entity = $args->getEntity();
}

Web应用程序正在运行,但是当我尝试运行像doctrine:database:drop这样的命令时,我得到了这个:

[Symfony\Component\DependencyInjection\Exception\ServiceCircularReferenceException]                                                                                                                                                                                            
  Circular reference detected for service "doctrine.dbal.default_connection", path: "doctrine.dbal.default_connection -> mailer.ticket -> twig -> security.authorization_checker -> security.authentication.manager -> fos_user.user_provider.username_email -> fos_user.user_manager".

但这与供应商服务有关。

如何解决这个问题?为什么我只在cli上出现此错误?

感谢。

2 个答案:

答案 0 :(得分:5)

最近有同样的体系结构问题,假设您使用Doctrine 2.4+,最好的办法就是不使用EventSubscriber(触发所有事件),但使用EntityListeners你提到的两个实体。

假设两个实体的行为应该相同,您甚至可以创建一个侦听器并为两个实体配置它。注释如下所示:

/** 
* @ORM\Entity()
* @ORM\EntityListeners({"AppBundle\Entity\TicketNotificationListener"})
*/
class TicketMessage

此后,您可以创建TicketNotificationListener类,并让服务定义执行其余操作:

app.entity.ticket_notification_listener:
    class: AppBundle\Entity\TicketNotificationListener
    calls:
        - [ setDoctrine, ['@doctrine.orm.entity_manager'] ]
        - [ setSlackSender, ['@app.your_slack_sender'] ]
    tags:
        - { name: doctrine.orm.entity_listener }

您可能甚至不需要实体管理器,因为实体本身可以通过postPersist方法直接使用:

/**
 * @ORM\PostPersist()
 */
public function postPersist($entity, LifecycleEventArgs $event)
{
    $this->slackSender->doSomething($entity);
}

有关Doctrine实体监听器的更多信息:http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/events.html#entity-listeners

答案 1 :(得分:4)

恕我直言,你在这里混合了两个不同的概念:

  • 域名事件(例如TicketWasClosed
  • Doctrine的生命周期事件(例如PostPersist

Doctrine的事件系统旨在挂钩持久化流程,处理与保存到数据库和从数据库加载直接相关的内容。它不应该用于其他任何事情。

对我来说,你想要发生的事情似乎是:

  

关闭故障单后,发送通知。

这与Doctrine或一般的持久性无关。您需要的是另一个专门用于域事件的事件系统。

您仍然可以使用Doctrine中的EventManager,但请确保创建第二个用于域事件的实例。

您还可以使用其他内容。例如Symfony的EventDispatcher。如果您正在使用Symfony框架,同样适用于此:不要使用Symfony的实例,为域事件创建自己的实例。

我个人喜欢SimpleBus,它使用对象作为事件而不是字符串(对象为"参数")。它还遵循消息总线和中间件模式,它们提供了更多的自定义选项。

PS:关于域事件,有很多非常好的文章。谷歌是你的朋友:)

示例

通常,域事件在对它们执行操作时会记录在实体本身中。所以Ticket实体将有一个方法:

public function close()
{
    // insert logic to close ticket here

    $this->record(new TicketWasClosed($this->id));
}

这可以确保实体对其状态和行为负全部责任,保护其不变量。

当然,我们需要一种方法将记录的域事件从实体中取出:

/** @return object[] */
public function recordedEvents()
{
    // return recorded events
}

从这里我们可能想要两件事:

  • 将这些事件收集到一个调度程序/发布者中。
  • 仅在成功交易后发送/发布这些事件。

使用Doctrine ORM,您可以订阅Doctrine的OnFlush事件的监听器,该事件将在刷新的所有实体(收集域事件)上调用recordedEvents(),并{{ 1}}可以将这些传递给调度员/发布者(仅在成功时)。

SimpleBus提供了DoctrineORMBridge来提供此功能。