从PDO预处理语句中获取原始SQL查询字符串
-
03-07-2019 - |
题
有没有办法在预准备语句上调用PDOStatement :: execute()时获取原始SQL字符串?出于调试目的,这将非常有用。
解决方案
我假设您的意思是您想要最终的SQL查询,并将参数值插入其中。我知道这对调试很有用,但它不是预处理语句的工作方式。参数不与客户端的预准备语句组合,因此PDO永远不应该访问与其参数结合的查询字符串。
执行prepare()时,SQL语句将发送到数据库服务器,执行execute()时会单独发送参数。 MySQL的通用查询日志确实显示了在执行()后插值的最终SQL。以下是我的常规查询日志的摘录。我从mysql CLI运行查询,而不是从PDO运行查询,但原理是相同的。
081016 16:51:28 2 Query prepare s1 from 'select * from foo where i = ?'
2 Prepare [2] select * from foo where i = ?
081016 16:51:39 2 Query set @a =1
081016 16:51:47 2 Query execute s1 using @a
2 Execute [2] select * from foo where i = 1
如果设置PDO属性PDO :: ATTR_EMULATE_PREPARES,您也可以获得所需内容。在此模式下,PDO将参数插入到SQL查询中,并在执行()时发送整个查询。 这不是真正准备好的查询。您将通过在execute()之前将变量插入SQL字符串来规避准备好的查询的好处。
来自@afilina的评论:
不,文本SQL查询不与执行期间的参数相结合。所以PDO没有任何东西可以告诉你。
在内部,如果使用PDO :: ATTR_EMULATE_PREPARES,PDO会在执行准备和执行之前复制SQL查询并将参数值插入其中。但是PDO不公开这个修改过的SQL查询。
PDOStatement对象有一个属性$ queryString,但是这只在PDOStatement的构造函数中设置,并且在用参数重写查询时它不会更新。
PDO要求他们公开重写的查询是一个合理的功能请求。但即使这样也不会给你“完整”的查询,除非您使用PDO :: ATTR_EMULATE_PREPARES。
这就是为什么我展示了使用MySQL服务器的通用查询日志的上述解决方法,因为在这种情况下,甚至在服务器上重写具有参数占位符的准备好的查询,并将参数值重新填充到查询字符串中。但这只能在日志记录期间完成,而不是在查询执行期间完成。
其他提示
/**
* Replaces any parameter placeholders in a query with the value of that
* parameter. Useful for debugging. Assumes anonymous parameters from
* $params are are in the same order as specified in $query
*
* @param string $query The sql query with parameter placeholders
* @param array $params The array of substitution parameters
* @return string The interpolated query
*/
public static function interpolateQuery($query, $params) {
$keys = array();
# build a regular expression for each parameter
foreach ($params as $key => $value) {
if (is_string($key)) {
$keys[] = '/:'.$key.'/';
} else {
$keys[] = '/[?]/';
}
}
$query = preg_replace($keys, $params, $query, 1, $count);
#trigger_error('replaced '.$count.' keys');
return $query;
}
我修改了方法以包括处理像WHERE IN(?)这样的语句的数组输出。
更新:刚添加了检查NULL值和重复的$ params,因此不会修改实际的$ param值。
伟大的工作bigwebguy,谢谢!
/**
* Replaces any parameter placeholders in a query with the value of that
* parameter. Useful for debugging. Assumes anonymous parameters from
* $params are are in the same order as specified in $query
*
* @param string $query The sql query with parameter placeholders
* @param array $params The array of substitution parameters
* @return string The interpolated query
*/
public function interpolateQuery($query, $params) {
$keys = array();
$values = $params;
# build a regular expression for each parameter
foreach ($params as $key => $value) {
if (is_string($key)) {
$keys[] = '/:'.$key.'/';
} else {
$keys[] = '/[?]/';
}
if (is_string($value))
$values[$key] = "'" . $value . "'";
if (is_array($value))
$values[$key] = "'" . implode("','", $value) . "'";
if (is_null($value))
$values[$key] = 'NULL';
}
$query = preg_replace($keys, $values, $query);
return $query;
}
PDOStatement有一个公共属性$ queryString。它应该是你想要的。
我刚刚注意到PDOStatement有一个未记录的方法debugDumpParams(),您可能也想看一下。
可能有点晚了,但现在有 PDOStatement :: debugDumpParams
直接转储预准备语句包含的信息 输出。它将提供正在使用的SQL查询的数量 使用的参数(Params),参数列表及其名称, 键入(paramtype)作为整数,它们的键名或位置,以及 在查询中的位置(如果PDO驱动程序支持, 否则,它将是-1)。
您可以在官方php文档上找到更多信息
示例:
<?php
/* Execute a prepared statement by binding PHP variables */
$calories = 150;
$colour = 'red';
$sth = $dbh->prepare('SELECT name, colour, calories
FROM fruit
WHERE calories < :calories AND colour = :colour');
$sth->bindParam(':calories', $calories, PDO::PARAM_INT);
$sth->bindValue(':colour', $colour, PDO::PARAM_STR, 12);
$sth->execute();
$sth->debugDumpParams();
?>
Mike添加了更多代码 - 遍历值以添加单引号
/**
* Replaces any parameter placeholders in a query with the value of that
* parameter. Useful for debugging. Assumes anonymous parameters from
* $params are are in the same order as specified in $query
*
* @param string $query The sql query with parameter placeholders
* @param array $params The array of substitution parameters
* @return string The interpolated query
*/
public function interpolateQuery($query, $params) {
$keys = array();
$values = $params;
# build a regular expression for each parameter
foreach ($params as $key => $value) {
if (is_string($key)) {
$keys[] = '/:'.$key.'/';
} else {
$keys[] = '/[?]/';
}
if (is_array($value))
$values[$key] = implode(',', $value);
if (is_null($value))
$values[$key] = 'NULL';
}
// Walk the array to see if we can add single-quotes to strings
array_walk($values, create_function('&$v, $k', 'if (!is_numeric($v) && $v!="NULL") $v = "\'".$v."\'";'));
$query = preg_replace($keys, $values, $query, 1, $count);
return $query;
}
我花了很多时间根据自己的需要研究这种情况。这个和其他几个SO线程对我帮助很大,所以我想分享我想出的东西。
虽然在排除故障时访问插值查询字符串是一个重要的好处,但我们希望能够仅维护某些查询的日志(因此,为此目的使用数据库日志并不理想)。我们还希望能够在任何给定时间使用日志重新创建表的条件,因此,我们需要确保插值字符串被正确转义。最后,我们希望将此功能扩展到我们的整个代码库,尽可能少地重写(截止日期,营销等等;你知道它是怎样的)。
我的解决方案是扩展默认PDOStatement对象的功能以缓存参数化值(或引用),并且在执行语句时,使用PDO对象的功能在注入参数时正确地转义参数到查询字符串。然后,我们可以绑定执行语句对象的方法并记录当时执行的实际查询(或至少忠实于再现)。
正如我所说,我们不想修改整个代码库来添加此功能,因此我们覆盖默认的 bindParam()
和 bindValue()
方法在PDOStatement对象中,执行我们对绑定数据的缓存,然后调用 parent :: bindParam()
或parent :: bindValue()
。这使我们现有的代码库能够继续正常运行。
最后,当调用 execute()
方法时,我们执行插值并将结果字符串作为新属性 E_PDOStatement-&gt; fullQuery
提供。可以输出此信息以查看查询,或者,例如,写入日志文件。
扩展以及安装和配置说明可在github上找到:
https://github.com/noahheck/E_PDOStatement
<强>声明强>:结果 显然,正如我所提到的,我写了这个扩展。因为它是在这里的许多线程的帮助下开发的,所以我想在这里发布我的解决方案以防其他任何人遇到这些线程,就像我一样。
您可以扩展PDOStatement类以捕获有界变量并将其存储以供以后使用。然后可以添加两个方法,一个用于变量清理(debugBindedVariables),另一个用于打印带有这些变量的查询(debugQuery):
class DebugPDOStatement extends \PDOStatement{
private $bound_variables=array();
protected $pdo;
protected function __construct($pdo) {
$this->pdo = $pdo;
}
public function bindValue($parameter, $value, $data_type=\PDO::PARAM_STR){
$this->bound_variables[$parameter] = (object) array('type'=>$data_type, 'value'=>$value);
return parent::bindValue($parameter, $value, $data_type);
}
public function bindParam($parameter, &$variable, $data_type=\PDO::PARAM_STR, $length=NULL , $driver_options=NULL){
$this->bound_variables[$parameter] = (object) array('type'=>$data_type, 'value'=>&$variable);
return parent::bindParam($parameter, $variable, $data_type, $length, $driver_options);
}
public function debugBindedVariables(){
$vars=array();
foreach($this->bound_variables as $key=>$val){
$vars[$key] = $val->value;
if($vars[$key]===NULL)
continue;
switch($val->type){
case \PDO::PARAM_STR: $type = 'string'; break;
case \PDO::PARAM_BOOL: $type = 'boolean'; break;
case \PDO::PARAM_INT: $type = 'integer'; break;
case \PDO::PARAM_NULL: $type = 'null'; break;
default: $type = FALSE;
}
if($type !== FALSE)
settype($vars[$key], $type);
}
if(is_numeric(key($vars)))
ksort($vars);
return $vars;
}
public function debugQuery(){
$queryString = $this->queryString;
$vars=$this->debugBindedVariables();
$params_are_numeric=is_numeric(key($vars));
foreach($vars as $key=>&$var){
switch(gettype($var)){
case 'string': $var = "'{$var}'"; break;
case 'integer': $var = "{$var}"; break;
case 'boolean': $var = $var ? 'TRUE' : 'FALSE'; break;
case 'NULL': $var = 'NULL';
default:
}
}
if($params_are_numeric){
$queryString = preg_replace_callback( '/\?/', function($match) use( &$vars) { return array_shift($vars); }, $queryString);
}else{
$queryString = strtr($queryString, $vars);
}
echo $queryString.PHP_EOL;
}
}
class DebugPDO extends \PDO{
public function __construct($dsn, $username="", $password="", $driver_options=array()) {
$driver_options[\PDO::ATTR_STATEMENT_CLASS] = array('DebugPDOStatement', array($this));
$driver_options[\PDO::ATTR_PERSISTENT] = FALSE;
parent::__construct($dsn,$username,$password, $driver_options);
}
}
然后你可以使用这个继承的类来调试purpouses。
$dbh = new DebugPDO('mysql:host=localhost;dbname=test;','user','pass');
$var='user_test';
$sql=$dbh->prepare("SELECT user FROM users WHERE user = :test");
$sql->bindValue(':test', $var, PDO::PARAM_STR);
$sql->execute();
$sql->debugQuery();
print_r($sql->debugBindedVariables());
导致
SELECT user FROM users WHERE user ='user_test'
阵列( [:test] =&gt; user_test )
解决方案是自愿在查询中输入错误并打印错误消息:
//Connection to the database
$co = new PDO('mysql:dbname=myDB;host=localhost','root','');
//We allow to print the errors whenever there is one
$co->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
//We create our prepared statement
$stmt = $co->prepare("ELECT * FROM Person WHERE age=:age"); //I removed the 'S' of 'SELECT'
$stmt->bindValue(':age','18',PDO::PARAM_STR);
try {
$stmt->execute();
} catch (PDOException $e) {
echo $e->getMessage();
}
标准输出:
SQLSTATE [42000]:语法错误或访问冲突:[...]在第1行'ELECT * FROM Person WHERE age = 18'附近
重要的是要注意它只打印查询的前80个字符。
提到的$ queryString属性可能只返回传入的查询,而不用参数替换它们的值。在.Net中,我有查询执行程序的catch部分对参数进行简单的搜索替换,并使用它们提供的值,以便错误日志可以显示用于查询的实际值。您应该能够枚举PHP中的参数,并将参数替换为其指定的值。
有点相关......如果您只是想清理特定变量,可以使用 PDO ::报价。例如,如果您遇到像CakePHP这样的有限框架,则要搜索多个部分LIKE条件:
$pdo = $this->getDataSource()->getConnection();
$results = $this->find('all', array(
'conditions' => array(
'Model.name LIKE ' . $pdo->quote("%{$keyword1}%"),
'Model.name LIKE ' . $pdo->quote("%{$keyword2}%"),
),
);
我需要在bind param之后记录完整的查询字符串,所以这是我代码中的一部分。希望,每个人都有同样的问题是有用的。
/**
*
* @param string $str
* @return string
*/
public function quote($str) {
if (!is_array($str)) {
return $this->pdo->quote($str);
} else {
$str = implode(',', array_map(function($v) {
return $this->quote($v);
}, $str));
if (empty($str)) {
return 'NULL';
}
return $str;
}
}
/**
*
* @param string $query
* @param array $params
* @return string
* @throws Exception
*/
public function interpolateQuery($query, $params) {
$ps = preg_split("/'/is", $query);
$pieces = [];
$prev = null;
foreach ($ps as $p) {
$lastChar = substr($p, strlen($p) - 1);
if ($lastChar != "\\") {
if ($prev === null) {
$pieces[] = $p;
} else {
$pieces[] = $prev . "'" . $p;
$prev = null;
}
} else {
$prev .= ($prev === null ? '' : "'") . $p;
}
}
$arr = [];
$indexQuestionMark = -1;
$matches = [];
for ($i = 0; $i < count($pieces); $i++) {
if ($i % 2 !== 0) {
$arr[] = "'" . $pieces[$i] . "'";
} else {
$st = '';
$s = $pieces[$i];
while (!empty($s)) {
if (preg_match("/(\?|:[A-Z0-9_\-]+)/is", $s, $matches, PREG_OFFSET_CAPTURE)) {
$index = $matches[0][1];
$st .= substr($s, 0, $index);
$key = $matches[0][0];
$s = substr($s, $index + strlen($key));
if ($key == '?') {
$indexQuestionMark++;
if (array_key_exists($indexQuestionMark, $params)) {
$st .= $this->quote($params[$indexQuestionMark]);
} else {
throw new Exception('Wrong params in query at ' . $index);
}
} else {
if (array_key_exists($key, $params)) {
$st .= $this->quote($params[$key]);
} else {
throw new Exception('Wrong params in query with key ' . $key);
}
}
} else {
$st .= $s;
$s = null;
}
}
$arr[] = $st;
}
}
return implode('', $arr);
}
我知道这个问题有点旧,但是,我很久以前就使用过这段代码了(我使用了@ chris-go的响应),现在,这些代码已经过时了,用PHP 7.2
我会发布这些代码的更新版本(主要代码的信用来自 @bigwebguy , @mike 和 @ chris-go ,所有这些问题的答案):
/**
* Replaces any parameter placeholders in a query with the value of that
* parameter. Useful for debugging. Assumes anonymous parameters from
* $params are are in the same order as specified in $query
*
* @param string $query The sql query with parameter placeholders
* @param array $params The array of substitution parameters
* @return string The interpolated query
*/
public function interpolateQuery($query, $params) {
$keys = array();
$values = $params;
# build a regular expression for each parameter
foreach ($params as $key => $value) {
if (is_string($key)) {
$keys[] = '/:'.$key.'/';
} else {
$keys[] = '/[?]/';
}
if (is_array($value))
$values[$key] = implode(',', $value);
if (is_null($value))
$values[$key] = 'NULL';
}
// Walk the array to see if we can add single-quotes to strings
array_walk($values, function(&$v, $k) { if (!is_numeric($v) && $v != "NULL") $v = "\'" . $v . "\'"; });
$query = preg_replace($keys, $values, $query, 1, $count);
return $query;
}
注意代码的更改是在array_walk()函数上,用匿名函数替换create_function。这使得这些优秀的代码功能与PHP 7.2兼容(并希望未来的版本)。
您可以使用 sprintf(str_replace('?','&quot;%s&quot;',$ sql),... $ params);
以下是一个例子:
function mysqli_prepared_query($link, $sql, $types='', $params=array()) {
echo sprintf(str_replace('?', '"%s"', $sql), ...$params);
//prepare, bind, execute
}
$link = new mysqli($server, $dbusername, $dbpassword, $database);
$sql = "SELECT firstname, lastname FROM users WHERE userage >= ? AND favecolor = ?";
$types = "is"; //integer and string
$params = array(20, "Brown");
if(!$qry = mysqli_prepared_query($link, $sql, $types, $params)){
echo "Failed";
} else {
echo "Success";
}
请注意,这仅适用于PHP&gt; = 5.6
Mike的回答在您使用“重复使用”之前一直有效。绑定值。
例如:
SELECT * FROM `an_modules` AS `m` LEFT JOIN `an_module_sites` AS `ms` ON m.module_id = ms.module_id WHERE 1 AND `module_enable` = :module_enable AND `site_id` = :site_id AND (`module_system_name` LIKE :search OR `module_version` LIKE :search)
迈克的回答只能先取代:搜索而不是第二次。
因此,我重写了他的答案,使用可以正确重复使用的多个参数。
public function interpolateQuery($query, $params) {
$keys = array();
$values = $params;
$values_limit = [];
$words_repeated = array_count_values(str_word_count($query, 1, ':_'));
# build a regular expression for each parameter
foreach ($params as $key => $value) {
if (is_string($key)) {
$keys[] = '/:'.$key.'/';
$values_limit[$key] = (isset($words_repeated[':'.$key]) ? intval($words_repeated[':'.$key]) : 1);
} else {
$keys[] = '/[?]/';
$values_limit = [];
}
if (is_string($value))
$values[$key] = "'" . $value . "'";
if (is_array($value))
$values[$key] = "'" . implode("','", $value) . "'";
if (is_null($value))
$values[$key] = 'NULL';
}
if (is_array($values)) {
foreach ($values as $key => $val) {
if (isset($values_limit[$key])) {
$query = preg_replace(['/:'.$key.'/'], [$val], $query, $values_limit[$key], $count);
} else {
$query = preg_replace(['/:'.$key.'/'], [$val], $query, 1, $count);
}
}
unset($key, $val);
} else {
$query = preg_replace($keys, $values, $query, 1, $count);
}
unset($keys, $values, $values_limit, $words_repeated);
return $query;
}
preg_replace对我不起作用,当binding_超过9时,binding_1和binding_10被替换为str_replace(后面留下0),所以我向后做了替换:
public function interpolateQuery($query, $params) {
$keys = array();
$length = count($params)-1;
for ($i = $length; $i >=0; $i--) {
$query = str_replace(':binding_'.(string)$i, '\''.$params[$i]['val'].'\'', $query);
}
// $query = str_replace('SQL_CALC_FOUND_ROWS', '', $query, $count);
return $query;
}
希望有人觉得它很有用。