Doctrine原生SQL与存储过程：弃用方法后的最佳实践

当doctrine中调用原生sql或存储过程时，`fetchallassociative()`和`execute`方法已被弃用。本文将详细介绍如何利用`resultsetmapping`结合`addscalarresult()`和`getarrayresult()`，作为现代、推荐的替代方案，安全高效地执行查询并获取关联数组结果，无需进行完整的实体映射。

理解方法弃用与现代实践

在Doctrine的较新版本中，直接使用Connection对象的execute()和fetchAllAssociative()等方法来执行原生SQL并获取结果集，尤其是在处理存储过程时，已被标记为弃用。这是因为Doctrine ORM旨在提供一个更统一、更健壮的查询接口，特别是对于原生SQL，它希望开发者能够明确地定义结果集的映射方式。

新的推荐方法是利用EntityManager的createNativeQuery()方法结合ResultSetMapping。这种方式不仅提供了更强大的结果集映射能力，也更好地融入了Doctrine ORM的整体架构，使得查询的意图更加清晰，并且能够更好地利用ORM的参数绑定等特性。

使用 ResultSetMapping 处理原生SQL结果

即使不打算将结果映射到完整的实体对象，ResultSetMapping依然是处理原生SQL结果的强大工具。对于仅需获取关联数组（类似于旧版fetchAllAssociative()）的场景，我们可以利用addScalarResult()方法来定义结果集中的标量字段。

存了个图

视频图片解析/字幕/剪辑，视频高清保存/图片源图提取

17

查看详情

核心组件解析：

1. ResultSetMapping: 这是一个用于描述原生SQL查询结果集结构的对象。它告诉Doctrine如何将数据库返回的列映射到PHP数组或对象中的字段。
2. addScalarResult(string $columnName, string $fieldName):
   • $columnName: 数据库中实际的列名。
   • $fieldName: 在最终PHP结果数组中对应的键名。 这个方法用于将数据库中的单个列映射为结果集中的一个标量值。
3. createNativeQuery(string $sql, ResultSetMapping $rsm):
   • $sql: 要执行的原生SQL字符串，可以包含参数占位符。
   • $rsm: 之前定义的ResultSetMapping对象。 这个方法从EntityManager创建一个NativeQuery对象，它是执行原生SQL的入口。
4. setParameters(array $parameters): 用于安全地绑定查询参数，防止SQL注入。
5. getArrayResult(): 执行查询并以关联数组的数组形式返回结果。每个内层数组代表一行数据，其键名由addScalarResult()中定义的$fieldName决定。

实践示例：调用带参数的存储过程

假设我们有一个存储过程spWithParams，它接受一个参数并返回一些结果。以下是如何使用现代Doctrine方法调用它并获取关联数组的示例：

<?php

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

class MyRepository
{
    private EntityManagerInterface $entityManager;

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

    /**
     * 调用存储过程并获取标量结果的关联数组
     *
     * @param string $paramValue 存储过程的参数值
     * @return array 存储过程返回的关联数组结果
     */
    public function callStoredProcedure(string $paramValue): array
    {
        // 1. 定义ResultSetMapping
        // 假设存储过程返回一个名为 'my_database_column' 的列
        $rsm = new ResultSetMapping();
        $rsm->addScalarResult('my_database_column', 'myField');
        // 如果存储过程返回多个列，可以添加更多 addScalarResult 调用
        // $rsm->addScalarResult('another_db_column', 'anotherField');

        // 2. 构造原生查询
        // 使用命名参数 ':param' 来传递参数
        $sql = 'CALL spWithParams(:param)';
        $query = $this->entityManager->createNativeQuery($sql, $rsm);

        // 3. 绑定查询参数
        $query->setParameters([
            ':param' => $paramValue
        ]);

        // 4. 执行查询并获取结果
        $results = $query->getArrayResult();

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

        return $results;
    }
}

// 示例用法 (在控制器或服务中)
// $myRepository = new MyRepository($entityManager); // $entityManager 是 Doctrine 的 EntityManager 实例
// $data = $myRepository->callStoredProcedure('test');
// print_r($data);

注意事项与最佳实践

• 参数绑定: 始终使用setParameters()方法来绑定查询参数，而不是直接将参数拼接到SQL字符串中。这可以有效防止SQL注入攻击。
• 明确的列映射: addScalarResult()要求你明确指定数据库中的列名以及希望在结果数组中使用的字段名。这使得代码更具可读性和可维护性。
• 多列映射: 如果存储过程返回多列，你需要为每一列调用addScalarResult()来定义其映射关系。
• 错误处理: 在实际应用中，应该添加适当的错误处理机制，例如try-catch块来捕获数据库操作可能抛出的异常。
• 性能考量: 对于非常庞大或复杂的存储过程，原生SQL的性能通常优于ORM构建的查询。但请注意，频繁调用原生SQL可能会失去ORM带来的一些优势，如缓存和数据一致性管理。
• 类型转换: ResultSetMapping默认会尝试根据数据库类型进行一些基本的类型转换。如果需要更复杂的类型处理，可能需要在获取结果后手动进行。

总结

尽管fetchAllAssociative()和execute方法在Doctrine中已被弃用，但通过ResultSetMapping结合addScalarResult()和createNativeQuery()、getArrayResult()，我们仍然能够以一种现代、安全且灵活的方式，在不进行完整实体映射的前提下，调用原生SQL或存储过程并获取所需的关联数组结果。这种方法不仅符合Doctrine的推荐实践，也为未来的扩展和维护提供了更好的基础。

以上就是Doctrine原生SQL与存储过程：弃用方法后的最佳实践的详细内容，更多请关注php中文网其它相关文章！