PHP開發：使用 Guzzle 實作 HTTP 用戶端-php教程-PHP中文網

PHP開發：使用 Guzzle 實作 HTTP 用戶端

PHPz

發布： 2023-06-17 11:16:01

原創

2133 人瀏覽過

PHP開發：使用Guzzle 實作HTTP 用戶端

在PHP 開發過程中，常常需要與外部服務進行通訊取得數據，這就要涉及到HTTP 請求，而Guzzle 是一個功能強大的PHP HTTP 用戶端工具，它提供了簡單易用的API，可以輕鬆地進行HTTP 請求。

本文將介紹 Guzzle 的基本使用方法，幫助 PHP 開發者快速實現 HTTP 請求。

安裝Guzzle

Guzzle 可以透過Composer 進行安裝，只需要在專案根目錄下的composer.json 檔案中新增以下內容：

{
    "require": {
        "guzzlehttp/guzzle": "^7.0.0"
    }
}

登入後複製

然後在命令列中執行composer install 命令即可安裝Guzzle。

傳送 HTTP 請求

使用 Guzzle 傳送 HTTP 請求非常簡單。以下是一個範例，發送一個GET 請求：

use GuzzleHttpClient;

$client = new Client();

$response = $client->request('GET', 'https://api.github.com/repos/guzzle/guzzle');

echo $response->getStatusCode(); // 200
echo $response->getHeaderLine('content-type'); // 'application/json; charset=utf8'
echo $response->getBody(); // '{"id": 1420053, "name": "guzzle", ...}'

登入後複製

在這個範例中，我們使用Guzzle 建立了一個Client 實例，然後發送了一個GET 請求，存取了Github 上Guzzle 項目的API，接著我們透過$response 物件取得了請求回應的狀態碼、回應頭和回應體的內容。就是這麼簡單！

上面是 GET 請求的例子，那麼 POST 請求怎麼做呢？以傳送一個 JSON 資料為例：

use GuzzleHttpClient;
use GuzzleHttpRequestOptions;

$client = new Client();

$response = $client->request('POST', 'http://httpbin.org/post', [
    RequestOptions::JSON => [
        'key' => 'value'
    ]
]);

echo $response->getStatusCode(); // 200
echo $response->getHeaderLine('content-type'); // 'application/json'
echo $response->getBody(); // '{ ... "data": "{"key":"value"}", ... }'

登入後複製

在這個範例中，我們指定了請求方法為 POST，並傳入了請求體的 JSON 資料。這裡使用了 Guzzle 提供的 RequestOptions 類別來指定請求參數的方式，請求參數可以是 JSON、表單等多種形式。

其他HTTP 請求方法（如PUT、DELETE、PATCH 等）與GET、POST 請求類似，只需要在$client->request() 的第一個參數中傳入對應的方法即可。

設定 Guzzle

除了基本的使用方法外，Guzzle 還提供了豐富的設定選項，可以幫助我們更好地控制 HTTP 請求。以下是一些常用設定選項：

（1）timeout：請求逾時時間，單位為秒。

$client = new Client([
    'timeout' => 10
]);

登入後複製

（2）headers：自訂請求頭。

$client = new Client([
    'headers' => [
        'User-Agent' => 'MyApp/1.0'
    ]
]);

登入後複製

（3）query：請求的查詢參數，可以是陣列或字串。

$client = new Client();

$response = $client->request('GET', 'https://api.github.com/search/repositories', [
    'query' => [
        'q' => 'php',
        'sort' => 'stars'
    ]
]);

登入後複製

（4）auth：請求身份驗證，可以是基本認證或 OAuth1.0。

$client = new Client();

$response = $client->request('GET', 'https://api.github.com/user', [
    'auth' => ['username', 'password']
]);

登入後複製

（5）verify：是否驗證 SSL 證書，預設為 true。

$client = new Client([
    'verify' => false
]);

登入後複製

（6）proxy：代理設置，可以是 HTTP、HTTPS 或 SOCKS5 代理。

$client = new Client([
    'proxy' => 'http://user:pass@host:port'
]);

登入後複製

異常處理

在進行 HTTP 請求時，可能會出現一些異常，例如 DNS 解析錯誤、請求逾時等等。 Guzzle 提供了一套完整的異常處理機制，可以方便地捕捉和處理這些異常。

以下是一個簡單的錯誤處理範例：

use GuzzleHttpClient;
use GuzzleHttpExceptionRequestException;

$client = new Client();

try {
    $response = $client->request('GET', 'https://invalid-url.com');
} catch (RequestException $e) {
    echo $e->getMessage();
    if ($e->hasResponse()) {
        echo $e->getResponse()->getBody()->getContents();
    }
}

登入後複製

這個範例中，我們試著存取一個無效的URL，Guzzle 會拋出一個RequestException 例外，我們可以透過擷取該例外來取得錯誤訊息.同時，如果請求回應存在，則可以透過 $e->getResponse() 方法取得回應物件。