Oct 12 PDOStatement::bindParam的一个陷阱

• 本文地址: http://www.laruence.com/2012/10/16/2831.html

废话不多说, 直接看代码:

<ol><li><span class="sh_symbol"><?php</span></li><li><span class="sh_variable">$dbh</span> <span class="sh_symbol">=</span> <span class="sh_keyword">new</span> <span class="sh_function">PDO</span><span class="sh_symbol">(</span><span class="sh_string">'mysql:host=localhost;dbname=test'</span><span class="sh_symbol">,</span> <span class="sh_string">"test"</span><span class="sh_symbol">);</span></li><li> </li><li><span class="sh_variable">$query</span> <span class="sh_symbol">=</span> <span class="sh_symbol"><<<</span>QUERY</li><li>  INSERT INTO `user` <span class="sh_symbol">(</span>`username`<span class="sh_symbol">,</span> `password`<span class="sh_symbol">)</span> <span class="sh_function">VALUES</span> <span class="sh_symbol">(:</span>username<span class="sh_symbol">,</span> <span class="sh_symbol">:</span>password<span class="sh_symbol">);</span></li><li>QUERY<span class="sh_symbol">;</span></li><li><span class="sh_variable">$statement</span> <span class="sh_symbol">=</span> <span class="sh_variable">$dbh</span><span class="sh_symbol">-></span><span class="sh_function">prepare</span><span class="sh_symbol">(</span><span class="sh_variable">$query</span><span class="sh_symbol">);</span></li><li> </li><li><span class="sh_variable">$bind_params</span> <span class="sh_symbol">=</span> <span class="sh_keyword">array</span><span class="sh_symbol">(</span><span class="sh_string">':username'</span> <span class="sh_symbol">=></span> <span class="sh_string">"laruence"</span><span class="sh_symbol">,</span> <span class="sh_string">':password'</span> <span class="sh_symbol">=></span> <span class="sh_string">"weibo"</span><span class="sh_symbol">);</span></li><li><span class="sh_keyword">foreach</span><span class="sh_symbol">(</span> <span class="sh_variable">$bind_params</span> <span class="sh_keyword">as</span> <span class="sh_variable">$key</span> <span class="sh_symbol">=></span> <span class="sh_variable">$value</span> <span class="sh_symbol">)</span><span class="sh_cbracket">{</span></li><li>    <span class="sh_variable">$statement</span><span class="sh_symbol">-></span><span class="sh_function">bindParam</span><span class="sh_symbol">(</span><span class="sh_variable">$key</span><span class="sh_symbol">,</span> <span class="sh_variable">$value</span><span class="sh_symbol">);</span></li><li><span class="sh_cbracket">}</span></li><li><span class="sh_variable">$statement</span><span class="sh_symbol">-></span><span class="sh_function">execute</span><span class="sh_symbol">();</span></li></ol>

请问, 最终执行的SQL语句是什么, 上面的代码是否有什么问题?

Okey, 我想大部分同学会认为, 最终执行的SQL是:

<ol><li><span class="sh_keyword">INSERT</span> <span class="sh_keyword">INTO</span> <span class="sh_string">`user`</span> <span class="sh_symbol">(</span><span class="sh_string">`username`</span><span class="sh_symbol">,</span> <span class="sh_string">`password`</span><span class="sh_symbol">)</span> <span class="sh_keyword">VALUES</span> <span class="sh_symbol">(</span><span class="sh_string">"laruence"</span><span class="sh_symbol">,</span> <span class="sh_string">"weibo"</span><span class="sh_symbol">);</span></li></ol>

但是, 可惜的是, 你错了, 最终执行的SQL是:

<ol><li><span class="sh_keyword">INSERT</span> <span class="sh_keyword">INTO</span> <span class="sh_string">`user`</span> <span class="sh_symbol">(</span><span class="sh_string">`username`</span><span class="sh_symbol">,</span> <span class="sh_string">`password`</span><span class="sh_symbol">)</span> <span class="sh_keyword">VALUES</span> <span class="sh_symbol">(</span><span class="sh_string">"weibo"</span><span class="sh_symbol">,</span> <span class="sh_string">"weibo"</span><span class="sh_symbol">);</span></li></ol>

是不是很大的一个坑呢?

—— 如果你想自己找到原因, 那么就不要继续往下读了———

这个问题, 来自今天的一个Bug报告: #63281

究其原因, 也就是bindParam和bindValue的不同之处, bindParam要求第二个参数是一个引用变量(reference).

让我们把上面的代码的foreach拆开, 也就是这个foreach:

<ol><li><span class="sh_symbol"><?php</span></li><li><span class="sh_keyword">foreach</span><span class="sh_symbol">(</span> <span class="sh_variable">$bind_params</span> <span class="sh_keyword">as</span> <span class="sh_variable">$key</span> <span class="sh_symbol">=></span> <span class="sh_variable">$value</span> <span class="sh_symbol">)</span><span class="sh_cbracket">{</span></li><li>    <span class="sh_variable">$statement</span><span class="sh_symbol">-></span><span class="sh_function">bindParam</span><span class="sh_symbol">(</span><span class="sh_variable">$key</span><span class="sh_symbol">,</span> <span class="sh_variable">$value</span><span class="sh_symbol">);</span></li><li><span class="sh_cbracket">}</span></li></ol>

相当于:

<ol><li><span class="sh_symbol"><?php</span></li><li><span class="sh_comment">//第一次循环</span></li><li><span class="sh_variable">$value</span> <span class="sh_symbol">=</span> <span class="sh_variable">$bind_params</span><span class="sh_symbol">[</span><span class="sh_string">":username"</span><span class="sh_symbol">];</span></li><li><span class="sh_variable">$statement</span><span class="sh_symbol">-></span><span class="sh_function">bindParam</span><span class="sh_symbol">(</span><span class="sh_string">":username"</span><span class="sh_symbol">,</span> <span class="sh_symbol">&</span><span class="sh_variable">$value</span><span class="sh_symbol">);</span> <span class="sh_comment">//此时, :username是对$value变量的引用</span></li><li> </li><li><span class="sh_comment">//第二次循环</span></li><li><span class="sh_variable">$value</span> <span class="sh_symbol">=</span> <span class="sh_variable">$bind_params</span><span class="sh_symbol">[</span><span class="sh_string">":password"</span><span class="sh_symbol">];</span> <span class="sh_comment">//oops! $value被覆盖成了:password的值</span></li><li><span class="sh_variable">$statement</span><span class="sh_symbol">-></span><span class="sh_function">bindParam</span><span class="sh_symbol">(</span><span class="sh_string">":password"</span><span class="sh_symbol">,</span> <span class="sh_symbol">&</span><span class="sh_variable">$value</span><span class="sh_symbol">);</span></li></ol>

所以, 在使用bindParam的时候, 尤其要注意和foreach联合使用的这个陷阱. 那么正确的作法呢?

1. 不要使用foreach, 而是手动赋值

<ol><li><span class="sh_symbol"><?php</span></li><li><span class="sh_variable">$statement</span><span class="sh_symbol">-></span><span class="sh_function">bindParam</span><span class="sh_symbol">(</span><span class="sh_string">":username"</span><span class="sh_symbol">,</span> <span class="sh_variable">$bind_params</span><span class="sh_symbol">[</span><span class="sh_string">":username"</span><span class="sh_symbol">]);</span> <span class="sh_comment">//$value是引用变量了</span></li><li><span class="sh_variable">$statement</span><span class="sh_symbol">-></span><span class="sh_function">bindParam</span><span class="sh_symbol">(</span><span class="sh_string">":password"</span><span class="sh_symbol">,</span> <span class="sh_variable">$bind_params</span><span class="sh_symbol">[</span><span class="sh_string">":password"</span><span class="sh_symbol">]);</span></li></ol>

2. 使用bindValue代替bindParam, 或者直接在execute中传递整个参数数组.

3. 使用foreach和reference(不推荐, 原因参看:微博)

<ol><li><span class="sh_symbol"><?php</span></li><li><span class="sh_keyword">foreach</span><span class="sh_symbol">(</span> <span class="sh_variable">$bind_params</span> <span class="sh_keyword">as</span> <span class="sh_variable">$key</span> <span class="sh_symbol">=></span> <span class="sh_symbol">&</span><span class="sh_variable">$value</span> <span class="sh_symbol">)</span> <span class="sh_cbracket">{</span> <span class="sh_comment">//注意这里</span></li><li>    <span class="sh_variable">$statement</span><span class="sh_symbol">-></span><span class="sh_function">bindParam</span><span class="sh_symbol">(</span><span class="sh_variable">$key</span><span class="sh_symbol">,</span> <span class="sh_variable">$value</span><span class="sh_symbol">);</span></li><li><span class="sh_cbracket">}</span></li></ol>

最后, 展开了说, 对于要求参数是引用, 并且有滞后处理的函数, 都要在使用foreach的时候, 谨慎!