DoctrineORM关联字段筛选方法详解

在文章实战开发的过程中，我们经常会遇到一些这样那样的问题，然后要卡好半天，等问题解决了才发现原来一些细节知识点还是没有掌握好。今天golang学习网就整理分享《Doctrine ORM教程：关联实体字段筛选技巧》，聊聊，希望可以帮助到正在努力赚钱的你。

本教程旨在解决如何使用Doctrine ORM，通过一个包含关联实体字段值（如城市slug）的数组，高效地筛选出主实体（如列表项）的问题。文章将详细阐述如何利用DQL的`JOIN`语句结合`IN`表达式，在单次数据库查询中完成这一复杂筛选，从而避免多余的查询和内存处理，优化数据检索性能。

场景描述与问题背景

在开发实践中，我们经常需要根据关联实体（例如一个城市的属性）来筛选主实体（例如该城市下的所有列表项）。一个常见的需求是，给定一个城市标识符（如slug）的数组，筛选出所有属于这些城市的列表项。

考虑以下两个实体：City（城市）和Listing（列表项）。 City实体包含id、name和slug字段。 Listing实体包含id、name，并通过city字段与City实体建立多对一（ManyToOne）关系，即一个Listing属于一个City。

// app/src/Entity/Listing.php
namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;

/**
 * @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;

    // ... 其他字段和方法
}

// app/src/Entity/City.php
namespace App\Entity;

use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;

/**
 * @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;

    // ... 其他字段和方法
}

我们的目标是，给定一个城市slug数组，例如 ['new_york', 'rome', 'hong_kong']，如何高效地查询出所有属于这些城市的Listing实体。

传统（低效）解决方案及其局限性

一种直观但效率较低的方法是分两步进行：

1. 首先，根据给定的slug数组查询所有对应的City实体。
2. 然后，从这些City实体中提取出它们的ID。
3. 最后，使用这些ID作为条件，通过IN表达式查询Listing实体。

代码示例（非最佳实践）：

// 在ListingRepository中
use Doctrine\DBAL\Connection;

class ListingRepository extends ServiceEntityRepository
{
    // ... 构造函数等

    /**
     * @param City[] $cities
     * @return Listing[]
     */
    public function findAllByCitiesInefficiently(array $cities): array
    {
        // 步骤2: 提取城市ID
        $citiesIds = array_map(static fn(City $city): int => $city->getId(), $cities);

        // 步骤3: 使用城市ID查询Listing
        $qb = $this->createQueryBuilder('l');
        return $qb
            ->select('l')
            ->where($qb->expr()->in('l.city', ':cities'))
            ->setParameter('cities', $citiesIds, Connection::PARAM_STR_ARRAY)
            ->getQuery()
            ->getResult();
    }

    // 假设在某个服务或控制器中先获取城市实体
    // public function someServiceMethod(array $citySlugs) {
    //     $cities = $this->cityRepository->findBy(['slug' => $citySlugs]); // 步骤1
    //     return $this->listingRepository->findAllByCitiesInefficiently($cities);
    // }
}

这种方法的缺点在于：

1. 两次数据库查询： 需要先查询City表，再查询Listing表，增加了数据库往返次数。
2. 额外的内存处理： 需要在PHP应用层循环City实体以提取ID，当城市数量庞大时，这会增加内存开销和处理时间。

最佳解决方案：利用DQL JOIN与IN表达式

Doctrine ORM提供了更优雅和高效的方式来解决这个问题，即通过DQL（Doctrine Query Language）的JOIN语句直接关联表，然后在关联表上使用IN表达式进行筛选。这种方法将所有逻辑封装在一个数据库查询中。

在ListingRepository中实现此方法的代码如下：

// app/src/Repository/ListingRepository.php
namespace App\Repository;

use App\Entity\Listing;
use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
use Doctrine\DBAL\Connection; // 引入Connection类用于参数类型

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

    /**
     * 根据城市slug数组筛选所有列表项。
     *
     * @param array $citySlugs 城市slug的数组，例如 ['new_york', 'rome']
     * @return Listing[] 返回符合条件的Listing实体数组
     */
    public function findAllByCitySlugs(array $citySlugs): array
    {
        $qb = $this->createQueryBuilder('l'); // 为Listing实体创建查询构建器，并指定别名'l'

        return $qb
            ->select('l') // 选择Listing实体
            ->join('l.city', 'c') // 关键步骤：通过Listing的'city'属性关联到City实体，并指定别名'c'
            ->where($qb->expr()->in('c.slug', ':citySlugs')) // 在关联的City实体（别名'c'）的'slug'字段上使用IN表达式
            ->setParameter('citySlugs', $citySlugs, Connection::PARAM_STR_ARRAY) // 绑定参数，使用PARAM_STR_ARRAY指示这是一个字符串数组
            ->getQuery() // 获取DQL查询对象
            ->getResult(); // 执行查询并返回结果
    }
}

代码解析：

1. $qb = $this->createQueryBuilder('l');

   • 初始化一个针对Listing实体（由l别名表示）的查询构建器。所有查询都将从Listing实体开始。

2. ->join('l.city', 'c')

   • 这是实现高效查询的核心。它指示Doctrine通过Listing实体上的city关联字段（即l.city）与City实体进行连接。
   • c是City实体在查询中的别名，允许我们引用City实体的字段。

3. ->where($qb->expr()->in('c.slug', ':citySlugs'))

   • 在WHERE子句中，我们使用$qb->expr()->in()来构建IN表达式。
   • 注意，我们现在可以直接引用关联的City实体（通过别名c）的slug字段，而不是Listing实体的字段。
   • :citySlugs是一个命名参数，用于后续绑定实际的slug数组。

4. ->setParameter('citySlugs', $citySlugs, Connection::PARAM_STR_ARRAY)

   • 将传入的$citySlugs数组绑定到:citySlugs参数。
   • Connection::PARAM_STR_ARRAY 是一个非常重要的参数类型，它告诉Doctrine这是一个字符串数组。Doctrine会负责将其正确地转换为数据库查询所需的格式（例如，IN ('new_york', 'rome')），避免SQL注入风险。

5. ->getQuery()->getResult()

   • 构建并执行DQL查询，返回符合条件的所有Listing实体数组。

优点：

• 单次数据库查询： 整个操作在一次数据库往返中完成，显著减少了网络延迟和数据库负载。
• 性能优化： 避免了PHP层面的循环和内存操作，尤其是在处理大量数据时，性能提升更为明显。
• 代码简洁性： 解决方案更符合ORM的设计哲学，代码更加简洁、易读、易维护。
• 利用数据库索引： 如果City表的slug字段有索引，数据库可以更高效地执行JOIN和IN操作。

总结

通过本教程，我们学习了如何利用Doctrine ORM的JOIN语句和IN表达式，高效地根据关联实体的特定字段数组来筛选主实体。这种方法是处理复杂关联查询时的最佳实践，它不仅提升了查询性能，还使得代码更加专业和易于管理。在未来的开发中，当遇到类似需求时，应优先考虑使用这种基于DQL JOIN的单次查询方案。

终于介绍完啦！小伙伴们，这篇关于《DoctrineORM关联字段筛选方法详解》的介绍应该让你收获多多了吧！欢迎大家收藏或分享给更多需要学习的朋友吧~golang学习网公众号也会发布文章相关知识，快来关注吧！