Doctrine原生SQL调用存储过程：弃用方法替代及标量结果处理

本文旨在解决doctrine中调用存储过程时`fetchallassociative()`和`execute`方法被弃用的问题。针对需要获取标量结果而非完整实体映射的场景，我们将详细介绍如何利用`resultsetmapping`结合`addscalarresult()`方法定义标量字段，并通过`createnativequery()`和`getarrayresult()`执行原生sql查询，从而实现高效、现代化的数据检索，确保代码的兼容性和可维护性。

Doctrine原生SQL查询中的方法弃用与现代化替代方案

在Doctrine ORM中，当开发者需要执行原生SQL查询，特别是调用数据库存储过程时，可能会遇到一些方法被弃用的情况，例如Statement::execute()和Statement::fetchAllAssociative()。这些方法的弃用促使我们寻找更符合Doctrine设计哲学且更具前瞻性的替代方案。对于仅需获取存储过程返回的标量结果（即非实体对象）的场景，Doctrine提供了基于ResultSetMapping的强大机制来优雅地处理。

虽然ResultSetMapping常用于将原生SQL结果映射到Doctrine实体，但它同样能够灵活地处理标量结果，这正是解决上述弃用问题的关键。通过明确指定返回结果的字段及其类型，我们可以避免直接使用已弃用的方法，并获得结构清晰的数组结果。

推荐方案：使用ResultSetMapping处理标量结果

Doctrine推荐的做法是使用ResultSetMapping来定义查询结果的结构，即使这些结果不是为了映射到ORM实体。对于存储过程返回的标量数据，我们可以利用addScalarResult()方法来明确指定每一个返回的数据库列及其在PHP数组中对应的键名。

核心思路：

火龙果写作

用火龙果，轻松写作，通过校对、改写、扩展等功能实现高质量内容生产。

106

查看详情

1. 创建ResultSetMapping实例： 实例化ResultSetMapping对象，用于描述预期结果集的结构。
2. 添加标量结果映射： 使用$rsm-youjiankuohaophpcnaddScalarResult('数据库列名', 'PHP数组键名')为存储过程返回的每个列进行映射。
3. 创建原生查询： 使用EntityManager::createNativeQuery()方法，传入原生SQL语句和配置好的ResultSetMapping。
4. 设置查询参数： 通过Query::setParameters()方法安全地绑定SQL参数。
5. 执行查询并获取结果： 调用Query::getArrayResult()方法执行查询并获取一个由关联数组组成的数组作为结果。

示例代码

以下代码演示了如何调用一个带有参数的存储过程spWithParams，并获取其返回的标量结果：

<?php

use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\Query\ResultSetMapping;

class MyService
{
    private EntityManagerInterface $entityManager;

    public function __construct(EntityManagerInterface $entityManager)
    {
        $this->entityManager = $entityManager;
    }

    /**
     * 调用存储过程并获取标量结果
     *
     * @param string $param 存储过程参数
     * @return array 存储过程返回的标量结果数组
     */
    public function callStoredProcedureWithScalarResult(string $param): array
    {
        // 1. 创建 ResultSetMapping 实例
        $rsm = new ResultSetMapping();

        // 2. 添加标量结果映射
        // 假设存储过程返回一个名为 'my_database_column' 的列
        // 我们将其映射到 PHP 数组中的 'myField' 键
        $rsm->addScalarResult('my_database_column', 'myField');
        // 如果存储过程返回多个列，可以继续添加
        // $rsm->addScalarResult('another_db_column', 'anotherField');

        // 3. 创建原生查询
        $query = $this->entityManager->createNativeQuery(
            'CALL spWithParams(:param)', // 存储过程调用语句
            $rsm                         // 传入 ResultSetMapping
        );

        // 4. 设置查询参数
        $query->setParameters([
            ':param' => $param
        ]);

        // 5. 执行查询并获取结果
        // getArrayResult() 返回一个由关联数组组成的数组
        $results = $query->getArrayResult();

        /*
         * 预期的 $results 结构示例:
         * [
         *   ['myField' => 'foo'],
         *   ['myField' => 'bar']
         * ]
         */

        return $results;
    }
}

// 假设在某个控制器或命令行中调用
// $service = new MyService($entityManager);
// $data = $service->callStoredProcedureWithScalarResult('testValue');
// print_r($data);

代码解释：

• $rsm->addScalarResult('my_database_column', 'myField');：这是关键一步。它告诉Doctrine，存储过程返回的结果集中有一个名为my_database_column的列，在最终的PHP数组中，这个列的值应该通过键myField来访问。
• $this->entityManager->createNativeQuery('CALL spWithParams(:param)', $rsm);：创建了一个原生查询对象。第一个参数是实际的SQL语句，第二个参数是定义结果结构的ResultSetMapping对象。
• $query->setParameters([':param' => $param]);：安全地绑定参数，防止SQL注入。
• $query->getArrayResult();：执行查询并以数组形式返回结果。每个结果行都是一个关联数组，其键名由addScalarResult中定义的PHP数组键名决定。

注意事项

• 列名匹配： addScalarResult()的第一个参数必须与存储过程实际返回的数据库列名（或别名）完全匹配。如果存储过程返回的列没有明确的名称，或者名称不固定，可能需要在存储过程内部为结果列设置别名，以便Doctrine能够正确映射。
• 结果结构： getArrayResult()总是返回一个二维数组，即使存储过程只返回一行或一列数据。如果结果为空，它将返回一个空数组。
• 灵活性： 这种方法不仅适用于存储过程，也适用于任何需要执行原生SQL并获取标量结果的场景。
• 与实体映射的区别： 尽管使用了ResultSetMapping，但addScalarResult()是专门用于标量结果的。如果需要将结果映射到完整的Doctrine实体，则应使用addEntityResult()等方法，并确保实体元数据与查询结果匹配。
• 错误处理： 在实际应用中，应加入适当的异常处理机制来捕获数据库操作可能出现的错误。

总结

通过采用ResultSetMapping结合addScalarResult()和getArrayResult()的方法，我们可以优雅地替代Doctrine中已弃用的fetchAllAssociative()和execute等方法，以现代化、安全且结构化的方式处理原生SQL查询和存储过程的标量结果。这种方案不仅提升了代码的兼容性和可维护性，也与Doctrine ORM的整体设计理念保持一致，是处理此类需求的推荐实践。

以上就是Doctrine原生SQL调用存储过程：弃用方法替代及标量结果处理的详细内容，更多请关注php中文网其它相关文章！