如何阻止Symfony4的EventListener因关联实体更新修改Api实体

这个问题的核心是：当你更新关联的Score实体时，Doctrine会加载关联的Api实体，你的Subscriber会在preUpdate/postLoad事件中被误触发，导致ApiKey被重复加密/解密，进而在CLI循环场景下出现数据不一致、调用外部API失败的问题。下面是两种针对性的解决方案：

方案一：通过变更集判断是否需要加密（针对preUpdate事件） #

在preUpdate事件中，我们可以借助Doctrine的UnitOfWork获取实体的变更集，只有当Api实体的apiKey字段确实被主动修改时，才执行加密逻辑。这样就能彻底避免关联实体更新时误触发加密操作。

修改你的ApiSubscriber中的index方法，针对preUpdate场景添加变更集检查：

public function index(LifecycleEventArgs $args) {
    $entity = $args->getObject();
    if (!$entity instanceof Api) {
        return;
    }

    // 针对preUpdate事件，检查apiKey是否真的被修改了
    $eventName = $args->getEventName();
    if ($eventName === 'preUpdate') {
        $uow = $args->getEntityManager()->getUnitOfWork();
        $changeSet = $uow->getEntityChangeSet($entity);
        // 只有当apiKey字段存在变更时，才执行加密
        if (!isset($changeSet['apiKey'])) {
            return;
        }
    }

    $apiSecret = $entity->getApiKey();
    $encodedSecret = $this->encryption->encrypt($apiSecret);
    if($encodedSecret['success']) {
        $entity->setApiKey($encodedSecret['encodedString']);
        $entity->setIv($encodedSecret['iv']);
        // 如果是preUpdate，需要手动更新变更集，让Doctrine识别新的修改
        if ($eventName === 'preUpdate') {
            $uow->recomputeSingleEntityChangeSet(
                $args->getEntityManager()->getClassMetadata(get_class($entity)),
                $entity
            );
        }
    }
}

关键说明：

• getEntityChangeSet会返回实体中所有被修改的字段列表，我们只在apiKey有主动变更时才执行加密逻辑。
• 在preUpdate中修改实体字段后，必须调用recomputeSingleEntityChangeSet，否则Doctrine不会把这次修改同步到数据库。

方案二：给Api实体添加解密标记，避免重复解密（针对postLoad事件） #

每次加载Api实体时postLoad都会触发，如果重复解密已经解密过的apiKey，会导致数据乱码或错误。我们可以给Api实体添加一个非持久化属性来标记解密状态：

首先修改Api实体：

class Api {
    // ... 原有属性和方法

    /**
     * 标记是否已解密apiKey，不需要持久化到数据库
     */
    private $isDecrypted = false;

    public function isDecrypted(): bool {
        return $this->isDecrypted;
    }

    public function setDecrypted(bool $decrypted): void {
        $this->isDecrypted = $decrypted;
    }
}

然后修改postLoad方法：

public function postLoad(LifecycleEventArgs $args) {
    $entity = $args->getObject();
    if ($entity instanceof Api && !$entity->isDecrypted()) {
        $apiSecret = $entity->getApiKey();
        $iv = $entity->getIv();
        $encodedSecret = $this->encryption->decrypt($apiSecret, $iv);
        $entity->setApiKey($encodedSecret);
        $entity->setDecrypted(true); // 标记已解密，避免重复操作
    }
}

这样，即使Api实体因为关联操作被多次加载，也只会执行一次解密操作，不会出现重复解密导致的数据错误。

额外优化：分离加密/解密状态（更健壮的方案） #

为了彻底避免加密和解密状态混淆，建议给Api实体拆分两个属性：一个存储数据库中的加密值（比如$encryptedApiKey），一个存储解密后的值（$apiKey，不需要持久化）。这种方式能更清晰地管理数据状态，进一步降低逻辑出错的概率。

修改后的Api实体核心代码：

class Api {
    /**
     * @ORM\Column(type="string", length=400, nullable=true)
     */
    private $encryptedApiKey; // 存储加密后的值，持久化到数据库

    /**
     * 解密后的apiKey，不需要持久化
     */
    private $apiKey;

    // ... 其他属性和方法

    public function getApiKey() {
        if ($this->apiKey === null && $this->encryptedApiKey !== null) {
            // 延迟解密，当需要获取时才执行解密操作
            $this->apiKey = $this->encryption->decrypt($this->encryptedApiKey, $this->getIv());
        }
        return $this->apiKey;
    }

    public function setApiKey($apiKey): void {
        $this->apiKey = $apiKey;
        // 不需要立即加密，在prePersist/preUpdate时统一处理
    }

    // 新增操作加密值的方法，供Subscriber使用
    public function getEncryptedApiKey(): ?string {
        return $this->encryptedApiKey;
    }

    public function setEncryptedApiKey(?string $encryptedApiKey): void {
        $this->encryptedApiKey = $encryptedApiKey;
    }
}

之后只需调整Subscriber中的逻辑，针对encryptedApiKey进行加密操作即可，彻底分离了加密存储和业务使用的状态，从根源上避免重复加密的问题。

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