Doctrine ORM 深入解析：扩展 DQL 与自定义 AST 遍历器-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00638/article/details/148416375

Doctrine ORM 深入解析：扩展 DQL 与自定义 AST 遍历器

orm Doctrine Object Relational Mapper (ORM) 项目地址: https://gitcode.com/gh_mirrors/or/orm

理解 DQL 与 AST 的基本概念

Doctrine ORM 中的 DQL（Doctrine Query Language）是一种专有的 SQL 方言，它用实体名称和字段替代了传统的表和列。DQL 允许开发者使用面向对象的方式编写数据库查询，然后由 ORM 将其转换为底层数据库的 SQL 语句。

在 Doctrine 1 中，DQL 没有使用真正的解析器实现，这使得用户无法修改 DQL。而在 Doctrine ORM 中，DQL 通过真正的解析器处理，将 DQL 语句转换为抽象语法树（AST），然后生成相应的 SQL 语句。这个过程是确定性的，因此 Doctrine 可以缓存生成的 SQL，将解析过程的性能开销降至零。

自定义树遍历器的类型

在 DQL 解析过程中，我们可以通过两种类型的自定义树遍历器进行扩展：

输出遍历器（Output Walker）：负责实际生成 SQL 语句，每个查询只有一个输出遍历器。Doctrine 提供了默认的 SqlWalker 实现。
树遍历器（Tree Walker）：可以有多个，不能直接生成 SQL，但可以在 SQL 生成前修改 AST。

实际应用场景

自定义遍历器的典型应用包括：

为分页器生成计数查询
生成特定数据库厂商的 SQL 语法
为特定实体添加额外的 WHERE 条件（如 ACL、国家特定内容等）
美化 SQL 输出用于调试

实战案例一：通用分页计数查询

在博客系统中，我们可能有如下查询：

SELECT p, c, a FROM BlogPost p JOIN p.category c JOIN p.author a WHERE ...

要实现分页，我们需要计算匹配条件的博文总数。手动编写计数查询会很繁琐，我们可以使用树遍历器自动转换。

实现方案

首先创建一个分页工具类：

class Paginate
{
    static public function count(Query $query)
    {
        $countQuery = clone $query;
        $countQuery->setHint(Query::HINT_CUSTOM_TREE_WALKERS, [
            'DoctrineExtensions\Paginate\CountSqlWalker'
        ]);
        $countQuery->setFirstResult(null)->setMaxResults(null);
        return $countQuery->getSingleScalarResult();
    }
}

然后实现计数遍历器：

class CountSqlWalker extends TreeWalkerAdapter
{
    public function walkSelectStatement(SelectStatement $AST)
    {
        // 查找根实体
        foreach ($this->_getQueryComponents() as $dqlAlias => $qComp) {
            if ($qComp['parent'] === null && $qComp['nestingLevel'] == 0) {
                $parent = $qComp;
                $parentName = $dqlAlias;
                break;
            }
        }

        // 创建路径表达式指向主键
        $pathExpression = new PathExpression(
            PathExpression::TYPE_STATE_FIELD | PathExpression::TYPE_SINGLE_VALUED_ASSOCIATION, 
            $parentName,
            $parent['metadata']->getSingleIdentifierFieldName()
        );
        
        // 替换选择表达式为计数查询
        $AST->selectClause->selectExpressions = [
            new SelectExpression(
                new AggregateExpression('count', $pathExpression, true), 
                null
            )
        ];
    }
}

这个遍历器会查找查询中的根实体，并将其替换为对该实体主键的计数查询。注意这仅适用于单主键实体。

实战案例二：生成厂商特定 SQL

不同数据库系统有各自的优化特性。我们可以通过自定义输出遍历器来利用这些特性。

MySQL 的 SQL_NO_CACHE 实现

首先设置查询提示：

$query = $m->createQuery($dql);
$query->setHint(Query::HINT_CUSTOM_OUTPUT_WALKER, 'DoctrineExtensions\Query\MysqlWalker');
$query->setHint("mysqlWalker.sqlNoCache", true);

然后实现 MySQL 特定的遍历器：

class MysqlWalker extends SqlWalker
{
    public function walkSelectClause($selectClause)
    {
        $sql = parent::walkSelectClause($selectClause);
        
        if ($this->getQuery()->getHint('mysqlWalker.sqlNoCache') === true) {
            $sql = $selectClause->isDistinct 
                ? str_replace('SELECT DISTINCT', 'SELECT DISTINCT SQL_NO_CACHE', $sql)
                : str_replace('SELECT', 'SELECT SQL_NO_CACHE', $sql);
        }
        
        return $sql;
    }
}

这个遍历器会在 SELECT 语句中添加 SQL_NO_CACHE 提示，避免 MySQL 使用查询缓存。