在Symfony中实现加密字段的唯一性约束

<?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=128, nullable=true)
     * @Encrypted // 这是一个加密字段
     */
    private $email;

    /**
     * @ORM\Column(type="string", length=40, unique=true, nullable=true)
     * // 注意：这里直接在数据库层面也设置了unique=true，作为双重保障
     */
    private $emailHash;

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

    public function getEmail(): ?string
    {
        // 假设你的Encrypted注解或包会自动处理解密
        return $this->email; 
    }

    public function setEmail(?string $email): self
    {
        $this->email = $email;
        // 在设置email时计算并设置emailHash
        // 使用一个“盐”来增加哈希的安全性，例如类名
        $this->emailHash = $email ? hash('sha1', $email . get_class($this)) : null;

        return $this;
    }

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

    // 注意：通常不提供直接设置emailHash的方法，因为它应该由setEmail方法自动管理
}

<?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={"email"}, // 仍然指向原始字段名
 *      repositoryMethod="findUniqueEncryptedEmail", // 指定自定义Repository方法
 *      ignoreNull=true,
 *      message="该邮箱地址已被注册。"
 * )
 */
class Foo
{
    // ... 其他字段和方法

    /**
     * @ORM\Column(type="string", length=128, nullable=true)
     * @Encrypted
     */
    private $email;

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

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

<?php

namespace App\Repository;

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

/**
 * @method Foo|null find($id, $lockMode = null, $lockVersion = null)
 * @method Foo|null findOneBy(array $criteria, array $orderBy = null)
 * @method Foo[]    findAll()
 * @method Foo[]    findBy(array $criteria, array $orderBy = null, $limit = null, $offset = null)
 */
class FooRepository extends ServiceEntityRepository
{
    private $encryptionService;

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

    /**
     * 自定义方法，用于在加密字段上执行唯一性检查。
     * UniqueEntity约束会调用此方法，并传入要检查的字段值。
     *
     * @param string $emailValue 待检查的原始（未加密）邮箱值
     * @return array 返回匹配的实体数组。如果为空，则表示唯一。
     */
    public function findUniqueEncryptedEmail(string $emailValue): array
    {
        // 1. 使用与实体字段相同的加密服务/逻辑加密输入值
        $encryptedEmail = $this->encryptionService->encrypt($emailValue);

        // 2. 查询数据库中是否存在匹配的加密值
        return $this->createQueryBuilder('f')
            ->andWhere('f.email = :encryptedEmail')
            ->setParameter('encryptedEmail', $encryptedEmail)
            ->getQuery()
            ->getResult();
    }
}