本文旨在提供一种高效的方法，利用doctrine orm在关联实体中通过一个字段值数组来筛选主实体列表。针对给定城市slug数组查询其所有相关listing的场景，我们将详细阐述如何通过直接join关联表并结合`in`操作符，避免多余的查询和数据处理步骤，从而优化查询性能和代码简洁性。
Doctrine ORM中基于关联实体字段数组进行查询
在开发Web应用程序时，我们经常会遇到需要根据关联实体（如城市）的特定属性（如城市slug）来筛选主实体（如列表项）的需求。本教程将介绍如何在Doctrine ORM中高效地实现这一目标，特别是当筛选条件是一个包含多个值的数组时。
场景描述
假设我们有两个实体：Listing（列表项）和City（城市）。一个Listing属于一个City，这是一种多对一（ManyToOne）的关系。City实体有一个slug字段，用于存储城市的唯一标识符，例如new_york、rome等。
我们的目标是：给定一个包含城市slug字符串的数组，例如 ['new_york', 'rome', 'hong_kong']，我们需要查询所有属于这些指定城市的Listing实体。
实体结构示例
City 实体:
/**
* @ORM\Entity(repositoryClass=CityRepository::class)
* @ORM\Table(name="cities", schema="app")
*/
class City
{
/**
* @ORM\Id
* @ORM\GeneratedValue()
* @ORM\Column(type="integer")
*/
private int $id;
/** @ORM\Column(type="string", length=255, nullable=false) */
private string $name;
/** @ORM\Column(type="string", length=255, nullable=false) */
private string $slug;
/** @ORM\OneToMany(targetEntity=Listing::class, mappedBy="city") */
private Collection $listings;
// ... getters and setters
}Listing 实体:
/**
* @ORM\Entity(repositoryClass=ListingRepository::class)
* @ORM\Table(name="listings", schema="app")
*/
class Listing
{
/**
* @ORM\Id
* @ORM\GeneratedValue()
* @ORM\Column(type="integer")
*/
private int $id;
/** @ORM\Column(type="string", length=255, nullable=false) */
private string $name;
/** @ORM\ManyToOne(targetEntity=City::class, inversedBy="listings") */
private City $city;
// ... getters and setters
}传统但低效的方法
一种常见的、但效率不高的方法是分两步完成：
- 首先，根据提供的城市slug数组查询所有对应的City实体。
- 然后，从这些City实体中提取它们的ID。
- 最后，使用这些ID作为条件，查询Listing实体。
这种方法的代码示例如下：
// 在 CityRepository 中
public function findCitiesBySlugs(array $slugs): array
{
return $this->createQueryBuilder('c')
->where('c.slug IN (:slugs)')
->setParameter('slugs', $slugs, Connection::PARAM_STR_ARRAY)
->getQuery()
->getResult();
}
// 在 ListingRepository 中
public function findAllByCities(array $cities): array
{
$citiesIds = array_map(static fn(City $city): int => $city->getId(), $cities);
if (empty($citiesIds)) {
return []; // 避免空数组导致SQL错误
}
$qb = $this->createQueryBuilder('l');
return $qb
->select('l')
->where($qb->expr()->in('l.city', ':cities'))
->setParameter('cities', $citiesIds, Connection::PARAM_INT_ARRAY) // 使用PARAM_INT_ARRAY
->getQuery()
->getResult();
}
// 使用示例
$citySlugs = ['new_york', 'rome'];
$cities = $cityRepository->findCitiesBySlugs($citySlugs);
$listings = $listingRepository->findAllByCities($cities);这种方法的缺点在于：
- 需要执行至少两次数据库查询（一次查询城市，一次查询列表项）。
- 在PHP层面需要额外的循环来提取城市ID，增加了内存和CPU开销，尤其当城市数量庞大时。
- 整体代码逻辑不够简洁，可读性稍差。
高效且推荐的方法：使用JOIN和IN
Doctrine ORM允许我们通过DQL（Doctrine Query Language）或QueryBuilder直接在查询中进行关联（JOIN）操作。我们可以利用这一点，将Listing实体与City实体连接起来，然后直接在City实体的slug字段上使用IN条件进行筛选。
这种方法仅需一次数据库查询，大大提高了效率。
实现代码
在ListingRepository中，添加如下方法：
use Doctrine\ORM\QueryBuilder;
use Doctrine\DBAL\Connection; // 引入Connection类，用于参数类型
class ListingRepository extends ServiceEntityRepository
{
// ... 其他方法
/**
* 根据城市slug数组查询所有相关的Listing实体。
*
* @param array $citySlugs 城市slug的数组，例如 ['new_york', 'rome']
* @return Listing[]
*/
public function findAllByCitySlugs(array $citySlugs): array
{
if (empty($citySlugs)) {
return []; // 如果城市slug数组为空，则直接返回空结果
}
$qb = $this->createQueryBuilder('l'); // 'l' 是 Listing 实体的主别名
return $qb
->select('l') // 选择 Listing 实体
->join('l.city', 'c') // 将 Listing 实体与关联的 City 实体连接，'c' 是 City 的别名
->where($qb->expr()->in('c.slug', ':cities')) // 在 City 实体的 slug 字段上使用 IN 条件
->setParameter('cities', $citySlugs, Connection::PARAM_STR_ARRAY) // 设置参数，指定为字符串数组类型
->getQuery() // 获取查询对象
->getResult(); // 执行查询并返回结果
}
}代码解析
- $qb = $this->createQueryBuilder('l');: 创建一个新的QueryBuilder实例，并为Listing实体指定别名l。
- ->select('l'): 指定我们要查询并返回的是Listing实体。
- ->join('l.city', 'c'): 这是关键一步。它执行一个内部连接（INNER JOIN），将Listing实体（别名l）通过其city属性与City实体连接起来，并为City实体指定别名c。这样，我们就可以在where子句中引用City的字段了。
- ->where($qb->expr()->in('c.slug', ':cities')): 构建WHERE条件。$qb->expr()->in()方法用于生成SQL的IN表达式。我们在这里检查City实体的slug字段（c.slug）是否包含在名为:cities的参数中。
-
->setParameter('cities', $citySlugs, Connection::PARAM_STR_ARRAY): 设置查询参数。
- 'cities'：参数名称，与where子句中的:cities对应。
- $citySlugs：实际的城市slug数组。
- Connection::PARAM_STR_ARRAY：非常重要！ 这个参数类型提示Doctrine将$citySlugs数组正确地转换为SQL的IN子句格式（例如'new_york', 'rome'），并确保每个元素都被视为字符串。如果数组元素是整数，则应使用Connection::PARAM_INT_ARRAY。
- ->getQuery()->getResult(): 执行查询并返回结果集，通常是一个Listing实体数组。
优势总结
- 单次数据库查询： 避免了多次数据库往返，显著提升了性能。
- 代码简洁性： 将复杂的逻辑封装在一个方法中，提高了代码的可读性和维护性。
- ORM的强大功能： 充分利用了Doctrine ORM的QueryBuilder和DQL的强大功能，以面向对象的方式处理数据库查询。
- 减少PHP层开销： 无需在PHP应用层进行额外的数据处理（如提取ID），减轻了服务器负担。
结论
当需要在Doctrine ORM中基于关联实体的多个字段值进行筛选时，使用JOIN操作符结合IN条件是最高效和推荐的方法。它不仅能够简化代码，更能显著优化数据库查询性能，为应用程序带来更好的响应速度和用户体验。务必注意在setParameter时指定正确的参数类型（如Connection::PARAM_STR_ARRAY或Connection::PARAM_INT_ARRAY），以确保Doctrine能够正确处理数组参数。
