用php curl請求接口碰到的問題總結

用php curl請求接口碰到的問題

今天碰到個用php擴展curl類庫命令實現linux curl的情況，碰到了一些小問題，總結總結。

---

場景

向資源方請求實現某種功能。相關同學給出了例子：

curl -v -XPOST -u username:abcpass\; -H "Content-Type: application/json"  \
--data '{"sv":"ddcd"}' 'http://api.test.com/alert'

先找框架裏面封裝好的類庫進行請求，發現無法滿足需求。後來還是直接到php的curl擴展請求吧。

使用CURL的PHP擴展完成一個HTTP請求的發送一般有以下幾個步驟：

• 初始化連接句柄(curl_init)；
• 設置CURL選項(curl_setopt)；
• 執行並獲取結果(curl_exec)；
• 釋放CURL連接句柄(curl_close)。

相關例子如下：

// 1. 初始化
 $ch = curl_init();
 // 2. 設置選項，包括URL
 curl_setopt($ch,CURLOPT_URL,"http://api.test.com/alertr");
 curl_setopt($ch,CURLOPT_RETURNTRANSFER,1);
 curl_setopt($ch,CURLOPT_HEADER,0);
 // 3. 執行並獲取HTML文檔內容
 $output = curl_exec($ch);
 if($output === FALSE ){
       echo "CURL Error:".curl_error($ch);
 }
 // 4. 釋放curl句柄
 curl_close($ch);

參考上面的curl例子，我們還要加入POST方法和通過POSTFIELDS傳遞內容。網上給出的例子如下：

參數	描述
CURLOPT_POST	TRUE 時會發送 POST 請求，類型爲：application/x-www-form-urlencoded，是 HTML 表單提交時最常見的一種。
CURLOPT_POSTFIELDS	全部數據使用HTTP協議中的 "POST" 操作來發送。 要發送文件，在文件名前面加上@前綴並使用完整路徑。 文件類型可在文件名後以 ';type=mimetype' 的格式指定。 這個參數可以是 urlencoded 後的字符串，類似'para1=val1¶2=val2&...'，也可以使用一個以字段名爲鍵值，字段數據爲值的數組。 如果value是一個數組，Content-Type頭將會被設置成multipart/form-data。 從 PHP 5.2.0 開始，使用 @ 前綴傳遞文件時，value 必須是個數組。 從 PHP 5.5.0 開始, @ 前綴已被廢棄，文件可通過 CURLFile 發送。 設置 CURLOPT_SAFE_UPLOAD 爲 TRUE 可禁用 @ 前綴發送文件，以增加安全性。

也有說直接CURLOPT_POSTFIELDS 這個字段傳遞一個json字符串的，這個得看具體server端取得參數形式。如果是標準的post參數形式可以參照上述table中的內容。然後，我們的兄弟部門使用的如下方式獲得參數：

$data  = file_get_contents('php://input');

那麼我們傳遞參數如下：

$mailInfo = [
     'sv' => 'ddcd'
];
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($mailInfo));

---

Authorization

我們還碰到了Authorization的問題, 查詢文檔發現下面兩個參數可以用：CURLOPT_USERNAME和CURLOPT_USERPWD。
於是我用瞭如下參數：

參數	描述	限制說明
CURLOPT_USERNAME	驗證中使用的用戶名。	cURL 7.19.1 中添加，PHP 5.5.0 起有效。
CURLOPT_USERPWD	傳遞一個連接中需要的用戶名和密碼，格式爲："[username]:[password]"。
CURLOPT_HTTPAUTH	。。。	這裏用了CURLAUTH_BASIC這個值

在這裏我碰到了一個坑，一直認爲密碼是abcpass，忽略了後面的\;符號 ,其實\;也是密碼的一部分，而反斜槓\是;的轉譯格式。實際代碼裏面寫的password應該是abcpass; 這個密碼，這個簡單的問題折騰了我半天。一直報401的錯誤。好了正確的代碼如下了。

    $mailInfo = [
            'sv' => 'ddcd'
    ];
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC ) ;
    curl_setopt($ch, CURLOPT_USERPWD, "username:abcpass;");

    curl_setopt($ch, CURLOPT_URL, 'http://api.test.com/alert');
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_USERNAME, 'username'); // 這裏還有優化空間

    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($mailInfo));
    curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
    curl_setopt($ch, CURLOPT_HEADER, 1);
    $re  = curl_exec($ch);
    curl_close($ch);

好了，終於出來了。其他參數默認了，總結下，繼續吧。