Doctrine DQL：使用关联实体字段数组进行高效筛选

本教程旨在解决如何通过关联实体（如城市）的特定字段（如slug）数组来高效筛选主实体（如列表）的问题。传统上可能通过两次查询并手动处理ID数组，但更优的方法是利用Doctrine QueryBuilder的`JOIN`操作符，直接在单个DQL查询中关联实体并使用`IN`表达式进行条件筛选，从而实现更简洁、高效的数据检索。

场景描述与问题背景

在许多Web应用中，我们经常需要根据关联实体的一些属性来筛选主实体。例如，我们有一个Listing（列表）实体，它与City（城市）实体存在多对一（ManyToOne）关系。每个Listing都属于一个City。现在，我们有一个城市slug（如['new_york', 'rome', 'hong_kong']）的数组，目标是检索所有属于这些指定城市的Listing实体。

City实体包含id和slug字段：

# City
------------------
| ID | slug      |
|  1 | new_york  |
|  2 | rome      |
|  3 | hong_kong |
------------------

Listing实体包含id、name和city（关联City实体）字段：

// Listing.php
/**
 * @ORM\ManyToOne(targetEntity=City::class, inversedBy="listings")
 */
private City $city;

我们的核心需求是：给定一个城市slug数组，如何高效地获取所有匹配的Listing。

传统（但低效）的解决方案

一种常见的思路是分两步完成：

首先，根据提供的城市slug数组查询City实体，获取它们的ID。
然后，使用这些城市ID作为参数，通过IN表达式查询Listing实体。

其大致实现可能如下：

// ListingRepository.php (示例，非最佳实践)
use Doctrine\DBAL\Connection;

class ListingRepository extends ServiceEntityRepository
{
    // ...

    /**
     * @param City[] $citiesEntities
     * @return Listing[]
     */
    public function findAllByCitiesInefficient(array $citiesEntities): array
    {
        $qb = $this->createQueryBuilder('l');
        // 步骤1: 提取城市ID
        $citiesIds = $this->getCitiesIds($citiesEntities); // 假设此方法已获取City实体数组

        // 步骤2: 使用IN查询Listing
        return $qb
            ->select('l')
            ->where($qb->expr()->in('l.city', ':citiesIds'))
            ->setParameter('citiesIds', $citiesIds, Connection::PARAM_INT_ARRAY) // 使用PARAM_INT_ARRAY
            ->getQuery()
            ->getResult();
    }

    /**
     * @param City[] $cities
     * @return int[]
     */
    private function getCitiesIds(array $cities): array
    {
        return array_map(static fn(City $city): int => $city->getId(), $cities);
    }
}

这种方法的缺点在于：

需要执行至少两次数据库查询（一次获取城市ID，一次获取列表）。
需要在PHP层面进行额外的循环和数组映射操作来提取ID。
当城市数量非常大时，两次查询和PHP处理的开销会显著增加。

优化方案：利用DQL的JOIN和IN表达式

Doctrine Query Language (DQL) 提供了强大的能力，允许我们直接在查询中关联实体并基于关联实体的属性进行筛选。通过使用JOIN操作，我们可以将上述两步合并为一个高效的数据库查询。

核心思想：

在ListingRepository中，使用QueryBuilder构建查询。
通过join('l.city', 'c')将Listing实体（别名l）与City实体（别名c）关联起来。l.city表示Listing实体中的city属性，它是一个City实体对象。
在where子句中，直接对关联的City实体别名c的slug字段使用IN表达式。
将城市slug数组作为参数绑定到IN表达式中，并指定参数类型为字符串数组。

以下是实现此优化方案的示例代码：

// ListingRepository.php (最佳实践)
use Doctrine\DBAL\Connection;
use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
use Doctrine\Persistence\ManagerRegistry;

class ListingRepository extends ServiceEntityRepository
{
    public function __construct(ManagerRegistry $registry)
    {
        parent::__construct($registry, Listing::class);
    }

    /**
     * 根据城市slug数组查找所有相关的Listing实体。
     *
     * @param array $citySlugs 包含城市slug字符串的数组。
     * @return Listing[] 返回匹配的Listing实体数组。
     */
    public function findAllByCitySlugs(array $citySlugs): array
    {
        $qb = $this->createQueryBuilder('l'); // 'l' 是 Listing 实体的别名

        return $qb
            ->select('l') // 选择 Listing 实体
            ->join('l.city', 'c') // 将 Listing (l) 与其关联的 City (c) 实体连接起来
            ->where($qb->expr()->in('c.slug', ':citySlugs')) // 在关联的 City (c) 实体的 slug 字段上使用 IN 表达式
            ->setParameter('citySlugs', $citySlugs, Connection::PARAM_STR_ARRAY) // 绑定参数，指定为字符串数组类型
            ->getQuery()
            ->getResult();
    }
}

代码解析：

$this->createQueryBuilder('l'): 初始化一个针对Listing实体（别名为l）的查询构建器。
->select('l'): 指定我们希望选择Listing实体。
->join('l.city', 'c'): 这是关键步骤。它告诉Doctrine将Listing实体（通过其city属性）与City实体连接起来，并将City实体命名为别名c。Doctrine会自动处理底层的SQL JOIN语句。
->where($qb->expr()->in('c.slug', ':citySlugs')): 在WHERE子句中，我们使用QueryBuilder的表达式构建器expr()来创建IN表达式。c.slug直接引用了关联City实体（别名c）的slug字段。:citySlugs是一个命名参数。
->setParameter('citySlugs', $citySlugs, Connection::PARAM_STR_ARRAY): 绑定$citySlugs数组到:citySlugs参数。特别注意，第三个参数Connection::PARAM_STR_ARRAY至关重要。它告诉Doctrine这个参数是一个字符串数组，Doctrine会将其正确地转换为SQL的IN ('value1', 'value2', ...)格式，并确保每个值都被正确引用，防止SQL注入。如果参数是整数数组，则应使用Connection::PARAM_INT_ARRAY。
->getQuery()->getResult(): 执行查询并返回结果。

总结与注意事项

通过上述优化方案，我们成功地将多步操作合并为一次高效的数据库查询。这种方法不仅减少了数据库往返次数，还简化了PHP代码逻辑，提高了应用程序的整体性能和可维护性。

关键点回顾：

利用JOIN： 当需要基于关联实体的属性进行筛选时，始终考虑使用DQL的JOIN操作符。
IN表达式： 对于需要匹配多个值的场景，IN表达式是最佳选择。
setParameter与数组类型： 在使用数组作为IN表达式的参数时，务必使用Connection::PARAM_STR_ARRAY或Connection::PARAM_INT_ARRAY来正确处理参数绑定，确保SQL语句的正确性和安全性。

掌握这种通过JOIN和IN表达式进行高效数据筛选的技巧，对于开发高性能的Doctrine应用程序至关重要。

# php # sql注入 # sql语句 # 防止sql注入 # 字符串数组 # sql # select # 字符串 # 循环 # 对象 # this # 数据库 # 绑定 # 两次 # 是一个 # 数据库查询 # 并为 # 至关重要 # 应用程序 # 有一个 # 句中 # 这是

返回目录在线咨询

上一篇：如何通过FTP上传文件到Windows主机并管理网站内容？
下一篇：浅谈PHP表单提交(POST&GET&URL编/解码)

您的项目需求