Symfony6中Doctrine EntityListener为何无法触发？

我在Symfony 6.3环境下，依据官方文档实现了一个Doctrine EntityListener，用于在实体保存前计算额外数据，代码如下：

<?php
namespace App\EventListener;

use App\Entity\Simulation;
use App\Goflex\Simulator;
use Doctrine\Bundle\DoctrineBundle\Attribute\AsEntityListener;
use Doctrine\ORM\Events;

#[AsEntityListener(event: Events::preUpdate, method: 'consolidate', entity: Simulation::class)]
class SimulationConsolidator
{
    private function consolidate(Simulation $simulation, $event): void
    {
        // for debugging purpose
        throw new \Exception("test"); 
        // My logic...
        $simulation->setXxxxx();
    }
}

控制器能够正常保存实体，代码如下：

// ...
class SimulationController extends AbstractController
{
    // ...
    public function save(Simulation $simulation, Request $request, EntityManagerInterface $em): Response
    {
        $success = true;
        $errorMsg = null;

        try {
            $form = $this->createForm(SimulationType::class, $simulation);
            $form->handleRequest($request);
            if ($form->isSubmitted()) {
                if(true !== $form->isValid()) {
                    foreach($form->getErrors(true) as $error) {
                        $errorMsg .= $error->getMessage()."\n";
                    }
                }
                else {
                    $em->persist($simulation);
                    $em->flush();
                }
            }
        } catch (\Exception $exception) {
            $success = false;
            $errorMsg = $exception->getMessage();
        }

        return $this->json([
            'success' => $success,
            'errorMsg' => $errorMsg,
        ]);
    }
}

我尝试在services.yaml中声明该监听器：

services:
    App\EventListener\SimulationConsolidator:
        tags:
            -
                name: 'doctrine.orm.entity_listener'
                event: 'preUpdate'
                entity: 'App\Entity\Simulation'
                method: 'consolidate'

却出现错误：Entity Listener "App\EventListener\SimulationConsolidator#consolidate()" in "App\Entity\Simulation" was already declared, but it must be declared only once.

这说明监听器已被注册，但始终未触发——至少应该抛出"test"异常才对，请问为何该监听器无法触发？

1. 重复注册引发冲突 #

你同时使用了#[AsEntityListener]注解和services.yaml中的标签配置，导致监听器被重复注册触发错误。Symfony 6.3中，#[AsEntityListener]注解已能自动完成监听器注册，无需再手动在配置文件中添加标签。

2. 方法权限不符合要求 #

你的consolidate方法是private权限，Doctrine无法调用私有方法作为实体监听器，必须将方法权限改为public。

3. preUpdate事件的触发条件 #

preUpdate事件仅在实体已有字段值发生变化时触发：

• 若编辑现有实体，需确保表单提交的数据确实修改了实体的字段；
• 若创建新实体（首次持久化），preUpdate不会触发，此时需改用prePersist事件，或同时监听两个事件。

修正后的代码示例 #

修正监听器类 #

<?php
namespace App\EventListener;

use App\Entity\Simulation;
use Doctrine\Bundle\DoctrineBundle\Attribute\AsEntityListener;
use Doctrine\ORM\Events;
use Doctrine\ORM\Event\PreUpdateEventArgs;

#[AsEntityListener(event: Events::preUpdate, method: 'consolidate', entity: Simulation::class)]
// 如需监听新实体创建，添加以下注解
// #[AsEntityListener(event: Events::prePersist, method: 'consolidate', entity: Simulation::class)]
class SimulationConsolidator
{
    // 修改为public权限，并使用类型化的事件参数
    public function consolidate(Simulation $simulation, PreUpdateEventArgs $event): void
    {
        throw new \Exception("test"); 
        // My logic...
        $simulation->setXxxxx();
        // 若在preUpdate中修改了字段，需手动通知Doctrine更新变更集
        // $event->getEntityManager()->getUnitOfWork()->recomputeSingleEntityChangeSet($event->getClassMetadata(), $simulation);
    }
}

移除重复配置 #

删除services.yaml中关于SimulationConsolidator的标签配置，保留基础服务注册即可：

services:
    App\EventListener\SimulationConsolidator: ~

验证触发逻辑 #

编辑已有实体时，确保至少修改一个字段值，调用$em->flush()后，preUpdate事件会触发，监听器中的异常会被控制器捕获并返回对应错误信息。

内容的提问来源于stack exchange，提问作者Loïc Pennamen