0

0

Doctrine原生SQL与存储过程调用:弃用方法的现代化实践

花韻仙語

花韻仙語

发布时间:2025-11-05 14:19:00

|

664人浏览过

|

来源于php中文网

原创

Doctrine原生SQL与存储过程调用:弃用方法的现代化实践

本文针对doctrine中`fetchallassociative()`和`execute`方法在原生sql及存储过程调用场景下的弃用问题,提供了一套现代化的解决方案。通过结合`resultsetmapping`的标量结果映射功能与`createnativequery`及`getarrayresult()`方法,开发者可以高效、清晰地执行原生查询并获取数组形式的结果,无需进行实体映射,从而确保代码的兼容性和可维护性。

在Doctrine ORM的早期版本中,开发者常常使用Connection对象的prepare()方法配合execute()和fetchAllAssociative()来执行原生SQL查询或调用存储过程,以获取非实体映射的数组结果。然而,随着Doctrine版本的迭代,这些方法已被标记为弃用,鼓励开发者采用更符合ORM设计哲学且功能更强大的替代方案。当我们需要调用存储过程或执行复杂原生SQL,并且只希望获取原始的、非实体映射的数组结果时,尤其需要一套现代化的方法来替代这些弃用的功能。

弃用方法的背景与挑战

原始代码示例展示了这种常见的模式:

// 弃用方法示例
$sql = 'CALL spWithParams(:param)';
$stmt = $this->getEntityManager()->getConnection()->prepare($sql);
$stmt->execute([":param"=>"test"]);
print_r($stmt->fetchAllAssociative());

这段代码通过prepare()创建一个Statement对象,然后使用execute()执行,并最终通过fetchAllAssociative()获取关联数组形式的结果。当这些方法被弃用后,直接使用它们会导致代码警告,并可能在未来的Doctrine版本中完全移除,从而影响应用的稳定性。

现代化解决方案:ResultSetMapping与createNativeQuery

Doctrine提供了一套更为健壮和灵活的机制来处理原生SQL查询,即通过ResultSetMapping结合EntityManager的createNativeQuery()方法。这种方法不仅解决了弃用问题,还提供了更清晰的结果集映射能力,即使对于不映射到实体的情况也同样适用。

核心思想是使用ResultSetMapping来定义查询结果中每个列的类型和在最终数组中的键名,特别是对于标量结果(即非实体、非关联的简单数据列)。

步骤一:定义结果集映射 (ResultSetMapping)

ResultSetMapping对象允许你精确地指定数据库查询结果中的列如何映射到你的PHP数组。对于标量结果,我们使用addScalarResult()方法。

addScalarResult(string $columnName, string $fieldName)

  • $columnName: 这是数据库中实际的列名,或者是存储过程返回结果集中的列名。
  • $fieldName: 这是你希望在最终PHP数组中使用的键名。

例如,如果你的存储过程返回一个名为my_database_column的列,而你希望在PHP中将其作为myField来访问,则可以这样定义:

VidAU
VidAU

VidAU AI 是一款AI驱动的数字人视频创作平台,旨在简化视频内容创作流程

下载
use Doctrine\ORM\Query\ResultSetMapping;

$rsm = new ResultSetMapping();
$rsm->addScalarResult('my_database_column', 'myField');
// 如果存储过程返回多个列,可以继续添加
// $rsm->addScalarResult('another_db_column', 'anotherField');

步骤二:创建原生查询 (createNativeQuery)

一旦定义了ResultSetMapping,就可以使用EntityManager的createNativeQuery()方法来创建一个NativeQuery对象。

createNativeQuery(string $sql, ResultSetMapping $rsm)

  • $sql: 你的原生SQL语句或存储过程调用语句。
  • $rsm: 上一步创建的ResultSetMapping对象。
$query = $this->getEntityManager()->createNativeQuery(
    'CALL spWithParams(:param)',
    $rsm
);

步骤三:设置参数并执行查询 (setParameters & getArrayResult)

与旧方法类似,你可以使用setParameters()方法来绑定查询参数。

执行查询并获取结果时,不再使用fetchAllAssociative(),而是使用getArrayResult()。getArrayResult()方法会根据你在ResultSetMapping中定义的规则,将查询结果组织成一个关联数组的集合。

$query->setParameters([":param" => "test"]);
$results = $query->getArrayResult();

完整示例代码

结合上述步骤,以下是调用存储过程并获取数组结果的完整现代化代码:

entityManager = $entityManager;
    }

    /**
     * 调用存储过程并获取标量结果
     *
     * @param string $paramValue 存储过程参数
     * @return array 结果数组
     */
    public function callStoredProcedureWithScalarResult(string $paramValue): array
    {
        // 1. 定义结果集映射
        $rsm = new ResultSetMapping();
        // 假设存储过程返回一个名为 'my_database_column' 的列
        // 我们将其映射到 PHP 数组中的 'myField' 键
        $rsm->addScalarResult('my_database_column', 'myField');
        // 如果存储过程返回多个列,可以继续添加:
        // $rsm->addScalarResult('another_db_column', 'anotherField');

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

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

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

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

        return $results;
    }
}

注意事项与总结

  1. 数据库列名与映射: 确保addScalarResult()中第一个参数$columnName与数据库中存储过程返回的实际列名完全匹配。大小写敏感性取决于你的数据库配置。
  2. 灵活性: 这种方法非常灵活,你可以根据存储过程返回的不同列定义多个addScalarResult(),以构建复杂的数组结构。
  3. 性能: 对于不需要实体对象、仅需原始数据的场景,使用getArrayResult()通常比getResult()(用于实体对象)更高效,因为它避免了额外的对象实例化和ORM开销。
  4. 错误处理: 与所有数据库操作一样,建议在实际应用中加入适当的错误处理机制,例如try-catch块来捕获DBALException或ORMException。
  5. 替代execute(): 在此方案中,NativeQuery对象的getArrayResult()方法内部已经包含了执行查询的逻辑,因此不再需要单独调用execute()方法。

通过采用ResultSetMapping和createNativeQuery,开发者可以优雅地处理Doctrine中的原生SQL查询和存储过程调用,避免使用弃用方法,并确保代码的现代化和可维护性。这种方法提供了一个清晰且强大的接口,用于在不涉及实体映射的情况下获取结构化的数组结果。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2788

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1687

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1548

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

1036

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1485

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1256

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1569

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1307

2023.11.13

菜鸟裹裹入口以及教程汇总
菜鸟裹裹入口以及教程汇总

本专题整合了菜鸟裹裹入口地址及教程分享,阅读专题下面的文章了解更多详细内容。

0

2026.01.22

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 9.2万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 9.9万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号