Symfony 6.4中#[AsEntityListener]的PostFlush事件无法触发问题

问题场景 #

使用Symfony 6.4开发时，将EntityListener的YAML服务定义替换为PHP属性后，PreUpdate/PostUpdate事件能正常触发，但PostFlush事件始终不执行。

原有YAML服务配置 #

App\Listener\Task\TaskCompletedListener:
    tags:
        - { name: doctrine.event_listener, event: postFlush }
        - { name: doctrine.event_listener, event: preUpdate }

转换后的Listener类代码 #

<?php

namespace App\Listener\Task;

use App\Entity\Task\Task;
use App\Entity\Task\TaskUserLog;
use App\Entity\User\User;
use Doctrine\Bundle\DoctrineBundle\Attribute\AsEntityListener;
use Doctrine\ORM\Event\PostFlushEventArgs;
use Doctrine\ORM\Event\PreUpdateEventArgs;
use Doctrine\ORM\Events;
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;

#[AsEntityListener(event: Events::preUpdate, method: 'preUpdate', entity: Task::class)]
#[AsEntityListener(event: Events::postFlush, method: 'postFlush', entity: Task::class)]
class TaskCompletedListener
{
    private $taskUserLog = null;
  
    private TokenStorageInterface $tokenStorage;

    public function __construct(TokenStorageInterface $tokenStorage)
    {
        $this->tokenStorage = $tokenStorage;
    }

    public function preUpdate(Task $task, PreUpdateEventArgs $args)
    {
        if($args->hasChangedField('lastCompletionDate')){
            $taskUserLog = new TaskUserLog();
            /** @var User $user */
            $user = $this->tokenStorage->getToken()->getUser();
            $taskUserLog->setUser($user);
            $taskUserLog->setTask($task);
            $this->taskUserLog = $taskUserLog;
        }
    }

    public function postFlush(Task $task, PostFlushEventArgs $event)
    {
        if(!is_null($this->taskUserLog)) {
            $em = $event->getObjectManager();
            $em->persist($this->taskUserLog);
            $this->taskUserLog = null;
            $em->flush();
        }
    }
}

补充：Doctrine配置（doctrine.yaml） #

doctrine:
    dbal:
        driver:   pdo_mysql
        host:     "%database_host%"
        port:     "%database_port%"
        dbname:   "%database_name%"
        user:     "%database_user%"
        password: "%database_password%"
        charset:  UTF8
    orm:
        auto_generate_proxy_classes: "%kernel.debug%"
        entity_managers:
            default:
                mappings:
                    App:
                        is_bundle: false
                        type: attribute
                        dir: '%kernel.project_dir%/src/Entity'
                        prefix: 'App\Entity'
                        alias: App
                naming_strategy: doctrine.orm.naming_strategy.underscore
                auto_mapping: true
                query_cache_driver:
                    type: service
                    id: doctrine.cache.memcached
                result_cache_driver:
                    type: service
                    id: doctrine.cache.memcached
                filters:
                    softdeleteable:
                        class: Gedmo\SoftDeleteable\Filter\SoftDeleteableFilter
                        enabled: true
                dql:
                    string_functions:
                        MONTH: DoctrineExtensions\Query\Mysql\Month
                        YEAR: DoctrineExtensions\Query\Mysql\Year
                        DAY: DoctrineExtensions\Query\Mysql\Day
                        DATE: DoctrineExtensions\Query\Mysql\Date
                        GROUP_CONCAT: DoctrineExtensions\Query\Mysql\GroupConcat

问题根源 #

postFlush是全局EntityManager事件，不属于特定实体的生命周期事件，不能用#[AsEntityListener]绑定到某个实体（entity: Task::class）：

1. #[AsEntityListener]仅针对与实体直接关联的生命周期事件（如preUpdate、postUpdate），这些事件触发时会传递对应的实体实例。
2. postFlush是针对整个EntityManager的全局事件，触发时不会传递实体实例，之前的方法签名里写Task $task会导致Doctrine无法正确调用该方法，直接跳过执行。

解决方案 #

方案一：拆分使用正确的PHP属性 #

保留实体事件的#[AsEntityListener]，同时用#[AsDoctrineListener]注册全局的postFlush事件，并修正方法签名：

1. 导入需要的属性类：

use Doctrine\Bundle\DoctrineBundle\Attribute\AsDoctrineListener;

2. 修改类的属性和postFlush方法：

#[AsEntityListener(event: Events::preUpdate, method: 'preUpdate', entity: Task::class)]
#[AsDoctrineListener(event: Events::postFlush, connection: 'default')]
class TaskCompletedListener
{
    // ... 原有构造函数和preUpdate方法不变

    // 移除第一个参数Task $task
    public function postFlush(PostFlushEventArgs $event)
    {
        if(!is_null($this->taskUserLog)) {
            $em = $event->getObjectManager();
            $em->persist($this->taskUserLog);
            $this->taskUserLog = null;
            $em->flush();
        }
    }
}

方案二：保留部分YAML配置 #

如果不想修改代码结构，可以保留原有YAML中postFlush的标签配置，只保留PHP属性里的preUpdate绑定，两种方式混用也能正常触发事件。

关键注意点 #

• 区分实体生命周期事件和全局EntityManager事件：前者用#[AsEntityListener]，后者用#[AsDoctrineListener]（或YAML标签）。
• 全局事件的方法签名不能包含实体参数，否则会因参数不匹配导致事件不执行。

内容的提问来源于stack exchange，提问作者BePi