在Symfony中对加密字段应用UniqueEntity约束的策略

<?php

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
use App\Annotation\Encrypted; // 假设你的加密注解是这个

/**
 * @ORM\Entity(repositoryClass="App\Repository\FooRepository")
 * @UniqueEntity(
 *      fields={"emailHash"}, // 对哈希字段应用唯一性约束
 *      ignoreNull=true,
 *      message="该邮箱地址已被注册。"
 * )
 */
class Foo
{
    /**
     * @ORM\Id()
     * @ORM\GeneratedValue()
     * @ORM\Column(type="integer")
     */
    private $id;

    /**
     * @ORM\Column(type="string", length=255, nullable=true)
     * @Encrypted // 原始字段被加密
     */
    private $email;

    /**
     * @ORM\Column(type="string", length=40, nullable=true, unique=true) // 哈希字段，通常也设置为唯一索引
     */
    private $emailHash;

    public function getId(): ?int
    {
        return $this->id;
    }

    public function getEmail(): ?string
    {
        return $this->email;
    }

    public function setEmail(?string $email): self
    {
        $this->email = $email;
        // 在设置email时，同步生成并设置emailHash
        // 使用SHA1哈希，并加入类名作为盐，增加安全性
        $this->emailHash = $email ? hash('sha1', $email . get_class($this)) : null;

        return $this;
    }

    public function getEmailHash(): ?string
    {
        return $this->emailHash;
    }

    // 注意：emailHash的setter通常不需要对外暴露，因为它应该由setEmail方法内部管理
    // public function setEmailHash(string $emailHash): self
    // {
    //     $this->emailHash = $emailHash;
    //     return $this;
    // }
}

<?php

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
use App\Annotation\Encrypted;
use App\Repository\DemoRepository; // 确保导入你的Repository

/**
 * @ORM\Entity(repositoryClass=DemoRepository::class)
 * @UniqueEntity(
 *      fields={"example"},
 *      repositoryMethod="findUniqueEncryptedExample", // 指定自定义Repository方法
 *      ignoreNull=true,
 *      message="该示例值已被使用。"
 * )
 */
class Demo
{
    /**
     * @ORM\Id()
     * @ORM\GeneratedValue()
     * @ORM\Column(type="integer")
     */
    private $id;

    /**
     * @ORM\Column(type="text", nullable=true)
     * @Encrypted
     */
    private $example;

    // ... getter和setter ...
}

<?php

namespace App\Repository;

use App\Entity\Demo;
use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
use Doctrine\Persistence\ManagerRegistry;
use App\Service\EncryptionService; // 假设你有一个加密服务

/**
 * @method Demo|null find($id, $lockMode = null, $lockVersion = null)
 * @method Demo|null findOneBy(array $criteria, array $orderBy = null)
 * @method Demo[]    findAll()
 * @method Demo[]    findBy(array $criteria, array $orderBy = null, $limit = null, $offset = null)
 */
class DemoRepository extends ServiceEntityRepository
{
    private $encryptionService; // 注入你的加密服务

    public function __construct(ManagerRegistry $registry, EncryptionService $encryptionService)
    {
        parent::__construct($registry, Demo::class);
        $this->encryptionService = $encryptionService;
    }

    /**
     * 自定义方法，用于检查加密字段的唯一性
     *
     * @param string $plainValue 待验证的原始值
     * @param mixed $entity 当前正在验证的实体实例 (可选，用于排除自身)
     * @return array|null 如果找到匹配项，返回一个包含匹配实体的数组，否则返回null
     */
    public function findUniqueEncryptedExample(string $plainValue, $entity = null): ?array
    {
        if (null === $plainValue) {
            return null; // 如果值为null，不进行检查
        }

        // 1. 使用你的加密服务将原始值加密
        $encryptedValue = $this->encryptionService->encrypt($plainValue); // 假设你的加密服务有encrypt方法

        // 2. 构建查询，查找数据库中是否存在与加密值匹配的记录
        $qb = $this->createQueryBuilder('d')
                   ->andWhere('d.example = :encryptedValue')
                   ->setParameter('encryptedValue', $encryptedValue);

        // 3. 如果是更新操作，需要排除当前实体自身
        if ($entity && $entity->getId()) {
            $qb->andWhere('d.id != :id')
               ->setParameter('id', $entity->getId());
        }

        $result = $qb->getQuery()->getResult();

        // UniqueEntity期望返回一个非空数组表示找到重复，空数组或null表示唯一
        return empty($result) ? null : $result;
    }
}