README

这个库为您提供了编写查询的新方法。通过使用规范模式，您将获得高度可重用的小的规范类。

编写Doctrine查询的问题在于它很快就会变得混乱。当您的应用程序增长时，您的Doctrine存储库将有20个以上的函数。所有这些函数都使用长而复杂的QueryBuilder调用。您还会发现您正在使用大量的参数来调用同一个方法以适应不同的用例。

在与Kacper Gunia在Sound of Symfony播客讨论如何正确测试您的Doctrine存储库之后，我们（Kacper和Tobias）决定创建这个库。我们受到了Benjamin Eberlei在博客文章中的想法的启发。

为什么我们需要这个库？

您可能想知道我们为什么要创建这个库。您的实体存储库按原样工作得很好，对吧？

但如果您的一个朋友打开您的一个存储库类，他/她可能会发现代码并不像您想象的那么完美。实体存储库有变得混乱的倾向。可能出现的问题包括

函数过多（如findActiveUser、findActiveUserWithPicture、findUserToEmail等）
一些函数有太多的参数
代码重复
难以测试

解决方案的要求

该解决方案应具备以下功能

易于测试
易于扩展、存储和运行
可重用代码
单一责任原则
隐藏ORM的实现细节。（这听起来可能有点吹毛求疵，然而它会导致客户端代码不断重复进行查询构建工作。）

实际差异

这是一个如何使用库的示例。假设您想获取一些广告并关闭它们。我们应该选择所有endDate在过去的广告。如果endDate为null，则将其设置为startDate之后的4周。

// Not using the lib
$qb = $this->em->getRepository('HappyrRecruitmentBundle:Advert')
    ->createQueryBuilder('r');

return $qb->where('r.ended = 0')
    ->andWhere(
        $qb->expr()->orX(
            'r.endDate < :now',
            $qb->expr()->andX(
                'r.endDate IS NULL',
                'r.startDate < :timeLimit'
            )
        )
    )
    ->setParameter('now', new \DateTime())
    ->setParameter('timeLimit', new \DateTime('-4weeks'))
    ->getQuery()
    ->getResult();

// Using the lib
$spec = Spec::andX(
    Spec::eq('ended', 0),
    Spec::orX(
        Spec::lt('endDate', new \DateTime()),
        Spec::andX(
            Spec::isNull('endDate'),
            Spec::lt('startDate', new \DateTime('-4weeks'))
        )
    )
);

return $this->em->getRepository('HappyrRecruitmentBundle:Advert')->match($spec);

是的，看起来几乎一样。但后者是可重用的。假设您想要另一个查询来获取应该关闭的广告，但只针对特定公司。

Doctrine规范

class AdvertsWeShouldClose extends BaseSpecification
{
    public function getSpec()
    {
        return Spec::andX(
            Spec::eq('ended', 0),
            Spec::orX(
                Spec::lt('endDate', new \DateTime()),
                Spec::andX(
                    Spec::isNull('endDate'),
                    Spec::lt('startDate', new \DateTime('-4weeks'))
                )
            )
        );
    }
}

class OwnedByCompany extends BaseSpecification
{
    private $companyId;

    public function __construct(Company $company, $dqlAlias = null)
    {
        parent::__construct($dqlAlias);
        $this->companyId = $company->getId();
    }

    public function getSpec()
    {
        return Spec::andX(
            Spec::join('company', 'c'),
            Spec::eq('id', $this->companyId, 'c')
        );
    }
}

class SomeService
{
    /**
     * Fetch Adverts that we should close but only for a specific company
     */
    public function myQuery(Company $company)
    {
        $spec = Spec::andX(
            new AdvertsWeShouldClose(),
            new OwnedByCompany($company)
        );

        return $this->em->getRepository('HappyrRecruitmentBundle:Advert')->match($spec);
    }
}

QueryBuilder

如果您只是使用QueryBuilder来做同样的事情，它看起来会是这样

class AdvertRepository extends EntityRepository
{
    protected function filterAdvertsWeShouldClose($qb)
    {
        return $qb
            ->andWhere('r.ended = 0')
            ->andWhere(
                $qb->expr()->orX(
                    'r.endDate < :now',
                    $qb->expr()->andX('r.endDate IS NULL', 'r.startDate < :timeLimit')
                )
            )
            ->setParameter('now', new \DateTime())
            ->setParameter('timeLimit', new \DateTime('-4weeks'))
        ;
    }

    protected function filterOwnedByCompany($qb, Company $company)
    {
        return $qb
            ->join('company', 'c')
            ->andWhere('c.id = :company_id')
            ->setParameter('company_id', $company->getId())
        ;
    }

    public function myQuery(Company $company)
    {
        $qb = $this->em->getRepository('HappyrRecruitmentBundle:Advert')->createQueryBuilder('r');
        $this->filterAdvertsWeShouldClose($qb)
        $this->filterOwnedByCompany($qb, $company)

        return $qb->getQuery()->getResult();
    }
}

QueryBuilder实现的缺点是

您只能在AdvertRepository中使用过滤器filterOwnedByCompany和filterAdvertsWeShouldClose。
您不能使用And/Or/Not构建树。例如，您想要每个广告，但不包括那些由$company拥有的广告。在这种情况下，无法重用filterOwnedByCompany()。
由于API的创建方式，QueryBuilder的不同部分的过滤无法组合在一起。假设我们有一个filterGroupsForApi()调用，无法将其与另一个调用filterGroupsForPermissions()组合。相反，重用此代码将导致第三个方法filterGroupsForApiAndPermissions()。

继续阅读

您可以查看一些使用示例，或者了解如何创建您自己的规范。

primasoftware / doctrine-specification

维护者

详细信息