最近做的一個需求,要通過PHP調用cURL,以multipart/form-data
格式上傳文件。踩坑若干,夠一篇文章了。
重要警告
沒事不要讀PHP的官方中文文檔!版本跟不上坑死你!
不同版本PHP之間cURL的區別
PHP的cURL支持通過給CURL_POSTFIELDS
傳遞關聯數組(而不是字符串)來生成multipart/form-data
的POST請求。
傳統上,PHP的cURL支持通過在數組數據中,使用“@
+文件全路徑”的語法附加文件,供cURL讀取上傳。這與命令行直接調用cURL程序的語法是一致的:
curl_setopt(ch, CURLOPT_POSTFIELDS, array( 'file' => '@'.realpath('p_w_picpath.png'), )); equals $ curl -F "file=@/absolute/path/to/p_w_picpath.png" <url>
但PHP從5.5開始引入了新的CURLFile類用來指向文件。CURLFile類也可以詳細定義MIME類型、文件名等可能出現在multipart/form-data數據中的附加信息。PHP推薦使用CURLFile替代舊的@
語法:
curl_setopt(ch, CURLOPT_POSTFIELDS, [ 'file' => new CURLFile(realpath('p_w_picpath.png')), ]);
PHP 5.5另外引入了CURL_SAFE_UPLOAD
選項,可以強制PHP的cURL模塊拒絕舊的@
語法,僅接受CURLFile式的文件。5.5的默認值爲false,5.6的默認值爲true。
但是坑的一點在於:@
語法在5.5就已經被打了deprecated,在5.6中就直接被刪除了(會產生 ErorException: The usage of the @filename
API for file uploading is deprecated. Please use the CURLFile class instead)。
對於PHP 5.6+而言,手動設置CURL_SAFE_UPLOAD
爲false是毫無意義的。根本不是字面意義理解的“設置成false,就能開啓舊的unsafe的方式”——舊的方式已經作爲廢棄語法徹底不存在了。PHP 5.6+ == CURLFile only,不要有任何的幻想。
我的部署環境是5.4(僅@
語法),但開發環境是5.6(僅CURLFile)。都沒有壓在5.5這個兩者都支持過渡版本上,結果就是必須寫出帶有環境判斷的兩套代碼。
現在問題來了……(挖掘機滾遠點!)
環境判斷:小心魔法數字!
我見過這種環境判斷的代碼:
if (version_compare(phpversion(), '5.4.0') >= 0)
我對這種代碼的評價只有一個字:屎。
這個判斷掉入了典型的魔法數字陷阱。版本號莫名其妙的出現在代碼之中,不查半天PHP手冊和更新歷史,很難明白作者被卡在了哪個功能的變更上。
代碼應該回歸本源。我們的實際需求其實是:有CURLFile就優先採用,沒有再退化到傳統@
語法。那麼代碼就來了:
if (class_exists('\CURLFile')) { $field = array('fieldname' => new \CURLFile(realpath($filepath))); } else { $field = array('fieldname' => '@' . realpath($filepath)); }
建議明確指定的退化選項
從可靠的角度,推薦指定CURL_SAFE_UPLOAD
的值,明確告知php是容忍還是禁止舊的@
語法。注意在低版本PHP中CURLOPT_SAFE_UPLOAD
常量本身可能不存在,需要判斷:
if (class_exists('\CURLFile')) { curl_setopt($ch, CURLOPT_SAFE_UPLOAD, true); } else { if (defined('CURLOPT_SAFE_UPLOAD')) { curl_setopt($ch, CURLOPT_SAFE_UPLOAD, false); } }
cURL選項設置的順序
不管是curl_setopt()
單發還是curl_setopt_array()
批量,cURL的選項總是設置一個生效一個,而設置好的選項立刻就會影響cURL在設置後續選項時的行爲。
例如CURLOPT_SAFE_UPLOAD
就和CURLOPT_POSTFIELDS
的行爲有關。如果先設置CURLOPT_POSTFIELDS
再設置CURLOPT_SAFE_UPLOAD
,那麼後者的約束作用就不會生效。因爲設置前者時cURL就已經把數據實際的識讀處理完畢了!
cURL有那麼幾個選項存在這種坑,務必小心。還好這種存在“依賴關係”的選項不多,機制也不復雜,簡單處理即可。我的方法是先批量設置所有的選項,然後直到curl_exec()
的前一刻才用curl_setopt()
單發設置CURLOPT_POSTFIELDS
。
實際上在curl_setopt_array()
用的數組中,保證CURLOPT_POSTFIELDS
的位置在後邊也是可靠的。PHP的關聯數組是有順序保障的,我們也可以假設curl_setopt_array()
內部的執行順序一定是從頭到尾按順序[注A]
,所以儘可放心。
我的做法只是在代碼表現上加個多餘的保險,突出強調順序的重要性防以後手賤。
命名空間
PHP 5.2或以下的版本沒有命名空間。代碼中用到了空間分隔符\
就會引發解析器錯誤。要照顧PHP 5.2其實容易想,放棄命名空間即可。
要注意的反倒是有命名空間的PHP 5.3+。無論是調用CURLFile還是用class_exists()
判斷CURLFile的存在性,都推薦寫成\CURLFile
明確指定頂層空間,防止代碼包裹在命名空間內的時候崩掉。
http://segmentfault.com/a/1190000000725185