Непоследовательное поведение слушателя сущности Доктрины - PullRequest
Новая
       19

Непоследовательное поведение слушателя сущности Доктрины

0 голосов
/ 13 сентября 2018

Я создаю небольшое приложение, используя Symfony 4 & Doctrine. Существуют пользователи (сущности пользователя), и они владеют каким-то содержимым, называемым таблицами радиосвязи (сущность RadioTable). Таблицы радиосвязи содержат радиостанции (объект RadioStation). RadioStation.radioTableId связан с RadioTable (много к одному), а RadioTable.ownerId связан с пользователем (много к одному).

Может быть, я должен заметить, что это мой первый проект с SF.

Объекты настраиваются с помощью аннотаций, таким образом: 

<?php 

namespace App\Entity;

/**
 * @ORM\Entity(repositoryClass="App\Repository\UserRepository")
 */
class User implements UserInterface, \Serializable, EncoderAwareInterface
{
    /**
     * @ORM\OneToMany(targetEntity="App\Entity\RadioTable", mappedBy="owner", orphanRemoval=true)
     */
    private $radioTables;

    /**
     * @ORM\Column(type="date")
     */
    private $lastActivityDate;
}

// -----------------

namespace App\Entity;

/**
 * @ORM\Entity(repositoryClass="App\Repository\RadioTableRepository")
 * @ORM\EntityListeners({"App\EventListener\RadioTableListener"})
 */
class RadioTable
{
    /**
     * @ORM\ManyToOne(targetEntity="App\Entity\User", inversedBy="radioTables")
     * @ORM\JoinColumn(nullable=false, onDelete="cascade")
     */
    private $owner;

    /**
     * @ORM\Column(type="datetime")
     */
    private $lastUpdateTime;
}

// -----------------

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Entity(repositoryClass="App\Repository\RadioStationRepository")
 * @ORM\EntityListeners({"App\EventListener\RadioStationListener"})
 */
class RadioStation
{
    /**
     * @ORM\ManyToOne(targetEntity="App\Entity\RadioTable")
     * @ORM\JoinColumn(nullable=false, onDelete="cascade")
     */
    private $radioTable;
}

Мне нужно обновить $lastUpdateTime в правильном объекте RadioTable при добавлении, удалении или изменении радиостанций. Кроме того, мне нужно обновить $lastActivityDate владельца таблицы радио (класс пользователя), когда таблица радио создается, удаляется или обновляется. Я пытаюсь добиться этого с помощью прослушивателей сущностей: 

<?php

namespace App\EventListener;

class RadioStationListener
{
    /**
     * @PreFlush
     * @PreRemove
     */
    public function refreshLastUpdateTimeOfRadioTable(RadioStation $radioStation)
    {
        $radioStation->getRadioTable()->refreshLastUpdateTime();
    }
}

// -----------------------------

namespace App\EventListener;

class RadioTableListener
{
    /**
     * @PreFlush
     * @PreRemove
     */
    public function refreshLastActivityDateOfUser(RadioTable $radioTable, PreFlushEventArgs $args)
    {
        $radioTable->getOwner()->refreshLastActivityDate();

        /* hack */
        $args->getEntityManager()->flush($radioTable->getOwner());
        /* hack */
    }
}

(В refresh*() методах я просто создаю новый экземпляр \DateTime для правильного поля сущности.)

Я столкнулся с проблемой. Когда я пытался обновить / удалить / создать радиостанции, прослушиватель RadioStation работал правильно, и соответствующий класс RadioTable был успешно обновлен. Но когда я попытался обновить таблицу радиосвязи, класс User был обновлен, но Doctrine не сохранил его в базе данных.

Я был сбит с толку, потому что структура кода в этих прослушивателях сущностей очень похожа.

Частично я нашел причину проблемы. Очевидно, что только владелец может изменять свои собственные таблицы радиосвязи, и пользователь должен войти в систему, чтобы изменить их. Я использую компонент безопасности от Symfony для поддержки механизма входа в систему.

Когда я временно взломал код контроллера для отключения Security и попытался обновить таблицу радиосвязи как анонимную, прослушиватель объекта RadioTable работал правильно, а объект User был успешно изменен и сохранен в базе данных .

Чтобы решить проблему, мне нужно вручную поговорить с менеджером сущностей Doctrine и вызвать flush() с сущностью пользователя в качестве аргумента (без аргументов я делаю бесконечный цикл). Эта строка отмечена /* hack */ комментарием.

После этой длинной истории я хочу задать вопрос: ПОЧЕМУ я должен это сделать? ПОЧЕМУ я должен вручную вызвать flush() для объекта «Пользователь», но только если используется компонент безопасности и пользователь вошел в систему?

1 Ответ

0 голосов
/ 17 сентября 2018

Я решил проблему.

Doctrine обрабатывает объекты в указанном порядке. Во-первых, вновь созданные объекты (запланированные для INSERT) имеют приоритет. Затем сохраненные сущности (запланированные для ОБНОВЛЕНИЯ) обрабатываются в том же порядке, в котором они были извлечены из базы данных. Изнутри прослушивателя сущностей я не могу предсказать или обеспечить выполнение предпочтительного порядка.

Когда я пытаюсь обновить дату последней активности пользователя в прослушивателе сущности RadioTable, изменения, внесенные в сущность пользователя, не сохраняются. Это потому, что на очень ранней стадии компонент безопасности загружает мой объект User из БД и , а затем Symfony подготавливает объект RadioTable для контроллера (например, с помощью преобразователя параметров).

Чтобы решить эту проблему, мне нужно сказать Doctrine для пересчета набора изменений сущности пользователя. Вот что я сделал.

Я создал небольшую черту для моих слушателей сущности: 

<?php

namespace App\EventListener\EntityListener;

use Doctrine\Common\EventArgs;

trait EntityListenerTrait
{
    // There is need to manually enforce update of associated entities,
    // for example when User entity is modified inside RadioTable entity event.
    // It's because associations are not tracked consistently inside Doctrine's events.
    private function forceEntityUpdate(object $entity, EventArgs $args): void
    {
        $entityManager = $args->getEntityManager();

        $entityManager->getUnitOfWork()->recomputeSingleEntityChangeSet(
            $entityManager->getClassMetadata(get_class($entity)),
            $entity
        );
    }
}

Внутри слушателей сущностей я делаю это: 

<?php

namespace App\EventListener\EntityListener;

use App\Entity\RadioTable;
use Doctrine\Common\EventArgs;
use Doctrine\ORM\Mapping\PreFlush;
use Doctrine\ORM\Mapping\PreRemove;

class RadioTableListener
{
    use EntityListenerTrait;

    /**
     * @PreFlush
     * @PreRemove
     */
    public function refreshLastActivityDateOfUser(RadioTable $radioTable, EventArgs $args): void
    {
        $user = $radioTable->getOwner();

        $user->refreshLastActivityDate();
        $this->forceEntityUpdate($user, $args);
    }
}

Есть другое решение. Можно вызвать $entityManager->flush($user), но он работает правильно только для ОБНОВЛЕНИЙ, генерирует бесконечный цикл для ВСТАВКИ. Чтобы избежать бесконечного цикла, можно проверить $unitOfWork->isScheduledForInsert($radioTable).

Это решение хуже, поскольку оно генерирует дополнительные транзакции и запросы SQL.

...