如何将令牌存储作为参数传递给 Symfony 3.4 中的事件监听器

Posted 2023-02-16

【中文标题】如何将令牌存储作为参数传递给 Symfony 3.4 中的事件监听器

【英文标题】：How do I pass Token Storage as a param to an Event Listener in Symfony 3.4

【发布时间】：2018-08-24 17:02:03

【问题描述】：

我已经在 Symfony 3.4 中成功设置了一个实体事件监听器。我在一个单独的包的 Resources/config/services.yml 中注册了这样的服务：

services:
    resource.listener:
        class: Company\ResourceManagementBundle\EventListener\Entity\ResourceUpdateListener
            arguments: ["@security.token_storage"]
            tags:
            -  name: doctrine.event_listener, event: preUpdate, method: preUpdate 
            -  name: doctrine.event_listener, event: postUpdate, method: postUpdate 

我还在Entity中添加了必要的代码：

/**
 * @ORM\EntityListeners(
 *    "Company\ResourceManagementBundle\EventListener\Entity\ResourceUpdateListener"
 * )
 */
class Resource implements UserInterface

然后在我的事件侦听器中，我创建了一个以令牌存储作为唯一参数的构造函数，并使用 TokenStorageInterface 进行类型提示。这是我的事件监听器：

namespace Company\ResourceManagementBundle\EventListener\Entity;

use Company\ResourceManagementBundle\Service\UserNoteLogger;
use Doctrine\ORM\Event\LifecycleEventArgs;
use Doctrine\ORM\Event\PreUpdateEventArgs;
use Symfony\Component\Security\Csrf\TokenStorage\TokenStorageInterface;

class ResourceUpdateListener

    protected $fields;
    private $token_storage;

    function __construct(TokenStorageInterface $token_storage)
    
        $this->token_storage = $token_storage;
    

    public function preUpdate(Resource $resource, PreUpdateEventArgs $args)
    
        $entity = $args->getEntity();
        if ($entity instanceof Resource) 
            $changes = $args->getEntityChangeSet();
        
        return $this->setFields($entity, $args);
    
    public function postUpdate(Resource $resource, LifecycleEventArgs $args)
    
        $entity = $args->getEntity();
        $hasChanged = false;
        if ($entity instanceof Resource) 
            foreach ($this->fields as $field => $detail) 
                if($detail[0] == null) 
                    //continue;
                 else 
                    $hasChanged = true;
                
            
            if ($hasChanged == true) 

                $userNoteLog = new UserNoteLogger($args->getEntityManager(), $this->token_storage);
                $comment = "The resource, " . $resource->getFullName() . ", was changed by the user, " . $this->token_storage->getToken()->getUser()->getFullName();
                $userNoteLog->logNote($comment, $resource);
            
        
    
    public function setFields($entity, LifecycleEventArgs $eventArgs)
    
        $this->fields = array_diff_key(
            $eventArgs->getEntityChangeSet(),
            [ 'modified'=>0 ]
        );
        return true;
    

这是我收到的错误：

类型错误：传递给 Company\ResourceManagementBundle\EventListener\Entity\ResourceUpdateListener::__construct() 的参数 1 必须实现接口 Symfony\Component\Security\Csrf\TokenStorage\TokenStorageInterface，没有给出，在 /var/www/sites 中调用/sentient02/vendor/doctrine/doctrine-bundle/Mapping/ContainerAwareEntityListenerResolver.php 在第 83 行

只要构造函数中存在Token Storage参数，这个错误就不会消失。

如果您查看上面的 EventListener 代码，我会尝试在更新期间每次实体更改时记录信息，并且此信息需要知道登录用户的名称。

【参考方案1】：

服务定义看起来还可以，但默认情况下，EntityListener 注解只支持空构造函数。

见Doctrine documentation：

实体监听器可以是任何类，默认情况下它应该是一个类 使用无参数构造函数。

这里稍微澄清一下：

Doctrine Event Listener

为所有实体调用（通常 在执行任何操作之前需要像 $entity instanceof MyClass 这样的测试）

Doctrine Entity Listener

用于简单案例，仅在一个实体上调用。

在您的代码中，您似乎编写了一个通用的学说侦听器，但将其用作实体侦听器。

此外，您已经使用doctrine.event_listener 标记将您的服务声明为一个常见的原则事件（EntityListener 必须具有doctrine.orm.entity_listener 标记。）

总之，只要把@ORM\EntityListeners这个注解删掉就可以了。

请注意，要在更新实体时获取更改，可以使用 onFlush 事件。这是一个非常有用的示例unitOfWork，用于获取一个包含所有将在计划更新中更改的字段的数组。

  /**
   * @param OnFlushEventArgs $args
   */
  public function onFlush(OnFlushEventArgs $args)
  
      $entityManager = $args->getEntityManager();
      $unitOfWork = $entityManager->getUnitOfWork();

      // Get all updates scheduled entities in the unit of work.
      foreach ($unitOfWork->getScheduledEntityUpdates() as $entity) 

          if ($entity instanceof Resource) 

              dump( $unitOfWork->getEntityChangeSet($entity) );
              // In this array, you'll have only fields and values that will be update.
              // TODO : your stuff.
          
      
  

【参考方案2】：

尝试将autowire: true 放入您的services.yml：

services:
    # default configuration for services in *this* file
    _defaults:
        autowire: true      # Automatically injects dependencies in your services.
        autoconfigure: true # Automatically registers your services as commands, event subscribers, etc.
        public: false       # Allows optimizing the container by removing unused services; this also means
                            # fetching services directly from the container via $container->get() won't work.
                            # The best practice is to be explicit about your dependencies anyway.

查看文档https://symfony.com/doc/current/service_container/3.3-di-changes.html。