
本文针对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来访问,则可以这样定义:
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;
}
}注意事项与总结
- 数据库列名与映射: 确保addScalarResult()中第一个参数$columnName与数据库中存储过程返回的实际列名完全匹配。大小写敏感性取决于你的数据库配置。
- 灵活性: 这种方法非常灵活,你可以根据存储过程返回的不同列定义多个addScalarResult(),以构建复杂的数组结构。
- 性能: 对于不需要实体对象、仅需原始数据的场景,使用getArrayResult()通常比getResult()(用于实体对象)更高效,因为它避免了额外的对象实例化和ORM开销。
- 错误处理: 与所有数据库操作一样,建议在实际应用中加入适当的错误处理机制,例如try-catch块来捕获DBALException或ORMException。
- 替代execute(): 在此方案中,NativeQuery对象的getArrayResult()方法内部已经包含了执行查询的逻辑,因此不再需要单独调用execute()方法。
通过采用ResultSetMapping和createNativeQuery,开发者可以优雅地处理Doctrine中的原生SQL查询和存储过程调用,避免使用弃用方法,并确保代码的现代化和可维护性。这种方法提供了一个清晰且强大的接口,用于在不涉及实体映射的情况下获取结构化的数组结果。










