HTTP 用戶端

• 簡介

• 建立 Request

  • Request 資料
  • 標頭 (Header)
  • 身份認證
  • 逾時
  • 重試
  • 錯誤處理
  • Guzzle 選項

• 同時進行的 Request

• Macro

• 測試

  • 模擬 Response
  • 攔截 Request

• 事件

簡介

Laravel 為 Guzzle HTTP 用戶端提供了一個語意化的極簡 API，能讓我們快速建立外連 HTTP Request 來與其他 Web App 通訊。Laravel 的 Guzzle 包裝著重於各個常見的使用情境，並提供優秀的開發人員經驗(Developer Experience)。

在開始前，先確保有將 Guzzle 套件安裝為專案的相依性套件。預設情況下，Laravel 已自動包含了這個相依性套件，但若你之前有將其移除，請使用 Composer 再安裝一次：

1composer require guzzlehttp/guzzle
1composer require guzzlehttp/guzzle

建立 Request

若要建立 Request，可以使用 Http Facade 提供的 head、get、post、put、patch、delete 等方法。首先，我們先看看要查詢另一個 URL 的基礎 GET Request 怎麼建立：

1use Illuminate\Support\Facades\Http;
2 
3$response = Http::get('http://example.com');
1use Illuminate\Support\Facades\Http;
2 
3$response = Http::get('http://example.com');

get 方法會回傳 Illuminate\Http\Client\Response 的實體，該實體提供了許多用來取得 Response 資訊的方法：

 1$response->body() : string;
 2$response->json($key = null) : array|mixed;
 3$response->object() : object;
 4$response->collect($key = null) : Illuminate\Support\Collection;
 5$response->status() : int;
 6$response->ok() : bool;
 7$response->successful() : bool;
 8$response->redirect(): bool;
 9$response->failed() : bool;
10$response->serverError() : bool;
11$response->clientError() : bool;
12$response->header($header) : string;
13$response->headers() : array;
 1$response->body() : string;
 2$response->json($key = null) : array|mixed;
 3$response->object() : object;
 4$response->collect($key = null) : Illuminate\Support\Collection;
 5$response->status() : int;
 6$response->ok() : bool;
 7$response->successful() : bool;
 8$response->redirect(): bool;
 9$response->failed() : bool;
10$response->serverError() : bool;
11$response->clientError() : bool;
12$response->header($header) : string;
13$response->headers() : array;

Illuminate\Http\Client\Response 物件也實作了 PHP 的 ArrayAccess 實體，能讓我們直接在 Response 上存取 JSON Response 資料：

1return Http::get('http://example.com/users/1')['name'];
1return Http::get('http://example.com/users/1')['name'];

傾印 Request

若想在送出 Request 前傾印連外 Request 並終止指令碼執行，可在 Request 定義的最前方加上 dd 方法：

1return Http::dd()->get('http://example.com');
1return Http::dd()->get('http://example.com');

Request 資料

當然，我們也很常使用 POST、PUT、PATCH 等 Request 來在 Request 上傳送額外資料，所以這些方法接受資料陣列作為第二個引數。預設情況下，資料會使用 application/json Content Type(內容型別) 來傳送：

1use Illuminate\Support\Facades\Http;
2 
3$response = Http::post('http://example.com/users', [
4    'name' => 'Steve',
5    'role' => 'Network Administrator',
6]);
1use Illuminate\Support\Facades\Http;
2 
3$response = Http::post('http://example.com/users', [
4    'name' => 'Steve',
5    'role' => 'Network Administrator',
6]);

GET Request 查詢參數

在產生 GET Request 時，可以直接將查詢字串(Query String)加到 URL 上，或是傳入一組索引鍵 / 值配對的陣列作為 get 方法的第二個引數：

1$response = Http::get('http://example.com/users', [
2    'name' => 'Taylor',
3    'page' => 1,
4]);
1$response = Http::get('http://example.com/users', [
2    'name' => 'Taylor',
3    'page' => 1,
4]);

傳送 Form URL Encoded 的 Request

若想使用 application/x-www-form-urlencoded Content Type 來傳送資料的話，請在建立 Request 前呼叫 asForm 方法：

1$response = Http::asForm()->post('http://example.com/users', [
2    'name' => 'Sara',
3    'role' => 'Privacy Consultant',
4]);
1$response = Http::asForm()->post('http://example.com/users', [
2    'name' => 'Sara',
3    'role' => 'Privacy Consultant',
4]);

傳送原始 Request 內文

在建立 Request 時，若想提供原始 Request 內文(Raw Request Body)，可使用 withBody 方法。可以在該方法的第二個引數上提供 Content Type：

1$response = Http::withBody(
2    base64_encode($photo), 'image/jpeg'
3)->post('http://example.com/photo');
1$response = Http::withBody(
2    base64_encode($photo), 'image/jpeg'
3)->post('http://example.com/photo');

Multi-Part 的 Request

若想使用 Multi-Part 的 Request 來傳送檔案的話，請在建立 Request 前呼叫 attach 方法。該方法接受檔案的欄位名稱、以及檔案的內容。若有需要，也可以提供第三個引數，該引數會被當作檔案名稱：

1$response = Http::attach(
2    'attachment', file_get_contents('photo.jpg'), 'photo.jpg'
3)->post('http://example.com/attachments');
1$response = Http::attach(
2    'attachment', file_get_contents('photo.jpg'), 'photo.jpg'
3)->post('http://example.com/attachments');

除了直接傳入檔案的原始內容外，也可以傳入一個 Stream Resource(串流資源)：

1$photo = fopen('photo.jpg', 'r');
2 
3$response = Http::attach(
4    'attachment', $photo, 'photo.jpg'
5)->post('http://example.com/attachments');
1$photo = fopen('photo.jpg', 'r');
2 
3$response = Http::attach(
4    'attachment', $photo, 'photo.jpg'
5)->post('http://example.com/attachments');

標頭

可以使用 withHeaders 方法來將標頭(Header)加到 Request 上。withHeaders 方法接受一組索引鍵 / 值配對的陣列：

1$response = Http::withHeaders([
2    'X-First' => 'foo',
3    'X-Second' => 'bar'
4])->post('http://example.com/users', [
5    'name' => 'Taylor',
6]);
1$response = Http::withHeaders([
2    'X-First' => 'foo',
3    'X-Second' => 'bar'
4])->post('http://example.com/users', [
5    'name' => 'Taylor',
6]);

可以使用 accept 方法來指定你的程式預期所預期 Response 的 Content Type：

1$response = Http::accept('application/json')->get('http://example.com/users');
1$response = Http::accept('application/json')->get('http://example.com/users');

為了方便起見，可以使用 acceptJson 方法來快速指定要預期 Response 的 Content Type 是 application/json：

1$response = Http::acceptJson()->get('http://example.com/users');
1$response = Http::acceptJson()->get('http://example.com/users');

身分驗證

可以使用 withBasicAuth 方法來指定使用 Basic 身分驗證的認證(Credential)，或是使用 withDigestAuth 方法來指定 Digest 身分驗證的認證：

1// Basic authentication...
2$response = Http::withBasicAuth('[email protected]', 'secret')->post(...);
3 
4// Digest authentication...
5$response = Http::withDigestAuth('[email protected]', 'secret')->post(...);
1// Basic authentication...
2$response = Http::withBasicAuth('[email protected]', 'secret')->post(...);
3 
4// Digest authentication...
5$response = Http::withDigestAuth('[email protected]', 'secret')->post(...);

Bearer 權杖

若想快速在 Request 的 Authorization 標頭中加上 Bearer 權杖(Token)，可使用 withToken 方法：

1$response = Http::withToken('token')->post(...);
1$response = Http::withToken('token')->post(...);

逾時

可使用 timeout 方法來為 Response 指定最多要等待的秒數：

1$response = Http::timeout(3)->get(...);
1$response = Http::timeout(3)->get(...);

If the given timeout is exceeded, an instance of Illuminate\Http\Client\ConnectionException will be thrown.

重試

若想讓 HTTP 用戶端在發生用戶端錯誤或伺服器端錯誤時自動重試，可以使用 retry 方法。retry 方法接受該 Request 要重試的最大次數，以及每次重試間要等待多少毫秒：

1$response = Http::retry(3, 100)->post(...);
1$response = Http::retry(3, 100)->post(...);

若有需要，可以傳入第三個引數給 retry 方法。第三個引數應為一個 Callable，用來判斷是否要重試。舉例來說，我們可以判斷只在 Request 遇到 ConnectionException 時才重試：

1$response = Http::retry(3, 100, function ($exception) {
2    return $exception instanceof ConnectionException;
3})->post(...);
1$response = Http::retry(3, 100, function ($exception) {
2    return $exception instanceof ConnectionException;
3})->post(...);

若所有的 Request 都執行失敗，會擲回 Illuminate\Http\Client\RequestException 實體。

錯誤處理

與 Guzzle 預設的行為不同，Laravel 的 HTTP 用戶端在遇到用戶端錯誤或伺服器端錯誤時 (即，伺服器回傳 4XX 與 5XX 等級的錯誤)，不會擲回 Exception。我們可以使用 successful、clientError、serverError 等方法來判斷是否遇到這類錯誤：

 1// Determine if the status code is >= 200 and < 300...
 2$response->successful();
 3 
 4// Determine if the status code is >= 400...
 5$response->failed();
 6 
 7// Determine if the response has a 400 level status code...
 8$response->clientError();
 9 
10// Determine if the response has a 500 level status code...
11$response->serverError();
12 
13// Immediately execute the given callback if there was a client or server error...
14$response->onError(callable $callback);
 1// Determine if the status code is >= 200 and < 300...
 2$response->successful();
 3 
 4// Determine if the status code is >= 400...
 5$response->failed();
 6 
 7// Determine if the response has a 400 level status code...
 8$response->clientError();
 9 
10// Determine if the response has a 500 level status code...
11$response->serverError();
12 
13// Immediately execute the given callback if there was a client or server error...
14$response->onError(callable $callback);

擲回 Exception

假設有個 Response 實體，而我們想在該 Response 的狀態碼為伺服器端或用戶端錯誤時擲回 Illuminate\Http\Client\RequestException，則可以使用 throw 或 throwIf 方法：

1$response = Http::post(...);
2 
3// Throw an exception if a client or server error occurred...
4$response->throw();
5 
6// Throw an exception if an error occurred and the given condition is true...
7$response->throwIf($condition);
8 
9return $response['user']['id'];
1$response = Http::post(...);
2 
3// Throw an exception if a client or server error occurred...
4$response->throw();
5 
6// Throw an exception if an error occurred and the given condition is true...
7$response->throwIf($condition);
8 
9return $response['user']['id'];

Illuminate\Http\Client\RequestException 實體有個 $response 公用屬性，我們可以使用該屬性來取得回傳的 Response。

如果沒有發生錯誤，throw 方法會回傳 Response 實體，能讓我們在 throw 方法後繼續串上其他操作：

1return Http::post(...)->throw()->json();
1return Http::post(...)->throw()->json();

若想在 Exception 被擲回前加上其他額外的邏輯，可傳入一個閉包給 throw 方法。叫用閉包後，就會自動擲回 Exception，因此我們不需要在閉包內重新擲回 Exception：

1return Http::post(...)->throw(function ($response, $e) {
2    //
3})->json();
1return Http::post(...)->throw(function ($response, $e) {
2    //
3})->json();

Guzzle 選項

我們可以使用 withOptions 方法來指定額外的 Guzzle Request 選項。withOptions 方法接受一組索引鍵 / 值配對的陣列：

1$response = Http::withOptions([
2    'debug' => true,
3])->get('http://example.com/users');
1$response = Http::withOptions([
2    'debug' => true,
3])->get('http://example.com/users');

同時進行的 Request

有時候，我們可能會想同時進行多個 HTTP Request。換句話說，不是依序執行 Request，而是同時分派多個 Request。同時執行多個 Request 的話，在處理速度慢的 HTTP API 時就可以大幅提升效能。

所幸，我們只要使用 pool 方法就能達成。pool 方法接受一個閉包，該閉包會收到 Illuminate\Http\Client\Pool 實體，能讓我們輕鬆地將 Request 加到 Request Pool(請求集區) 以作分派：

 1use Illuminate\Http\Client\Pool;
 2use Illuminate\Support\Facades\Http;
 3 
 4$responses = Http::pool(fn (Pool $pool) => [
 5    $pool->get('http://localhost/first'),
 6    $pool->get('http://localhost/second'),
 7    $pool->get('http://localhost/third'),
 8]);
 9 
10return $responses[0]->ok() &&
11       $responses[1]->ok() &&
12       $responses[2]->ok();
 1use Illuminate\Http\Client\Pool;
 2use Illuminate\Support\Facades\Http;
 3 
 4$responses = Http::pool(fn (Pool $pool) => [
 5    $pool->get('http://localhost/first'),
 6    $pool->get('http://localhost/second'),
 7    $pool->get('http://localhost/third'),
 8]);
 9 
10return $responses[0]->ok() &&
11       $responses[1]->ok() &&
12       $responses[2]->ok();

就像這樣，我們可以依據加入 Pool 的順序來存取每個 Response 實體。若有需要的話，也可以使用 as 方法來為 Request 命名，好讓我們能使用名稱來存取對應的 Response：

 1use Illuminate\Http\Client\Pool;
 2use Illuminate\Support\Facades\Http;
 3 
 4$responses = Http::pool(fn (Pool $pool) => [
 5    $pool->as('first')->get('http://localhost/first'),
 6    $pool->as('second')->get('http://localhost/second'),
 7    $pool->as('third')->get('http://localhost/third'),
 8]);
 9 
10return $responses['first']->ok();
 1use Illuminate\Http\Client\Pool;
 2use Illuminate\Support\Facades\Http;
 3 
 4$responses = Http::pool(fn (Pool $pool) => [
 5    $pool->as('first')->get('http://localhost/first'),
 6    $pool->as('second')->get('http://localhost/second'),
 7    $pool->as('third')->get('http://localhost/third'),
 8]);
 9 
10return $responses['first']->ok();

Macro

Laravel HTTP 用戶端支援定義「Macro(巨集)」。通過 Macro，我們就能通過一些流暢且語義化的機制來在專案中為一些服務設定常用的 Request 路徑與標頭。若要開始使用 Macro，我們可以在專案的 App\Providers\AppServiceProvider 內 boot 方法中定義 Macro：

 1use Illuminate\Support\Facades\Http;
 2 
 3/**
 4 * Bootstrap any application services.
 5 *
 6 * @return void
 7 */
 8public function boot()
 9{
10    Http::macro('github', function () {
11        return Http::withHeaders([
12            'X-Example' => 'example',
13        ])->baseUrl('https://github.com');
14    });
15}
 1use Illuminate\Support\Facades\Http;
 2 
 3/**
 4 * Bootstrap any application services.
 5 *
 6 * @return void
 7 */
 8public function boot()
 9{
10    Http::macro('github', function () {
11        return Http::withHeaders([
12            'X-Example' => 'example',
13        ])->baseUrl('https://github.com');
14    });
15}

設定好 Macro 後，就可以在任何地方叫用這個 Macro，以使用指定的設定來建立 Request：

1$response = Http::github()->get('/');
1$response = Http::github()->get('/');

測試

許多 Laravel 的服務都提供了能讓我們輕鬆撰寫測試的功能，而 Laravel 的 HTTP 包裝也不例外。Http Facade 的 fake 方法能讓我們指定 HTTP 用戶端在建立 Request 後回傳一組虛擬的 Response。

模擬(Fake) Response

舉例來說，若要讓 HTTP 用戶端為每個 Request 回傳 200 狀態碼的空 Response，可呼叫 fake 方法，然後不傳入任何引數：

1use Illuminate\Support\Facades\Http;
2 
3Http::fake();
4 
5$response = Http::post(...);
1use Illuminate\Support\Facades\Http;
2 
3Http::fake();
4 
5$response = Http::post(...);

模擬執行 URL

或者，我們也可以傳入一組陣列給 fake 方法。該陣列的索引鍵代表要模擬的 URL，對應的值則為 Response。可使用 * 字元來當作萬用字元。當 Request 的 URL 不在模擬列表內時，就會被實際執行。可以使用 Http Facade 的 response 方法來為這些Endpoint(端點)建立虛擬的 Response：

1Http::fake([
2    // Stub a JSON response for GitHub endpoints...
3    'github.com/*' => Http::response(['foo' => 'bar'], 200, $headers),
4 
5    // Stub a string response for Google endpoints...
6    'google.com/*' => Http::response('Hello World', 200, $headers),
7]);
1Http::fake([
2    // Stub a JSON response for GitHub endpoints...
3    'github.com/*' => Http::response(['foo' => 'bar'], 200, $headers),
4 
5    // Stub a string response for Google endpoints...
6    'google.com/*' => Http::response('Hello World', 200, $headers),
7]);

若想為所有不符合的 URL 建立一個遞補用 URL 規則，只要使用單一 * 字元即可：

1Http::fake([
2    // Stub a JSON response for GitHub endpoints...
3    'github.com/*' => Http::response(['foo' => 'bar'], 200, ['Headers']),
4 
5    // Stub a string response for all other endpoints...
6    '*' => Http::response('Hello World', 200, ['Headers']),
7]);
1Http::fake([
2    // Stub a JSON response for GitHub endpoints...
3    'github.com/*' => Http::response(['foo' => 'bar'], 200, ['Headers']),
4 
5    // Stub a string response for all other endpoints...
6    '*' => Http::response('Hello World', 200, ['Headers']),
7]);

模擬 Response 序列

有時候我們需要讓單一 URL 以固定的順序回傳一系列模擬的 Response。我們可以使用 Http::sequence 方法來建立 Request：

1Http::fake([
2    // Stub a series of responses for GitHub endpoints...
3    'github.com/*' => Http::sequence()
4                            ->push('Hello World', 200)
5                            ->push(['foo' => 'bar'], 200)
6                            ->pushStatus(404),
7]);
1Http::fake([
2    // Stub a series of responses for GitHub endpoints...
3    'github.com/*' => Http::sequence()
4                            ->push('Hello World', 200)
5                            ->push(['foo' => 'bar'], 200)
6                            ->pushStatus(404),
7]);

用完 Response 序列內的所有 Response 後，接下來再建立 Request 就會導致 Response 系列擲回一個 Exception。若想指定當序列為空時要回傳的預設 Response，可使用 whenEmpty 方法：

1Http::fake([
2    // Stub a series of responses for GitHub endpoints...
3    'github.com/*' => Http::sequence()
4                            ->push('Hello World', 200)
5                            ->push(['foo' => 'bar'], 200)
6                            ->whenEmpty(Http::response()),
7]);
1Http::fake([
2    // Stub a series of responses for GitHub endpoints...
3    'github.com/*' => Http::sequence()
4                            ->push('Hello World', 200)
5                            ->push(['foo' => 'bar'], 200)
6                            ->whenEmpty(Http::response()),
7]);

若想模擬一系列的 Response，但又不想指定要模擬的特定 URL 格式，可使用 Http::fakeSequence 方法：

1Http::fakeSequence()
2        ->push('Hello World', 200)
3        ->whenEmpty(Http::response());
1Http::fakeSequence()
2        ->push('Hello World', 200)
3        ->whenEmpty(Http::response());

模擬回呼

若某些 Endpoint 需要使用比較複雜的邏輯來判斷要回傳什麼 Response 的話，可傳入一個閉包給 fake 方法。該閉包會收到一組 Illuminate\Http\Client\Request 的實體，而該閉包必須回傳 Response 實體。在這個閉包內，我們就可以任意加上邏輯來判斷要回傳什麼類型的 Response：

1Http::fake(function ($request) {
2    return Http::response('Hello World', 200);
3});
1Http::fake(function ($request) {
2    return Http::response('Hello World', 200);
3});

檢查 Request

在模擬 Response 時，有時候我們會需要檢查用戶端收到的 Request，以確保程式有傳送正確的資料。可以在呼叫 Http::fake 之前先呼叫 Http::assertSent 方法來檢查。

assertSent 方法接受一組閉包，該閉包會收到 Illuminate\Http\Client\Request 的實體，而該閉包應回傳用來表示 Request 是否符合預期的布林值。若要讓測試通過，提供的 Request 中就必須至少有一個是符合給定預期條件的：

 1use Illuminate\Http\Client\Request;
 2use Illuminate\Support\Facades\Http;
 3 
 4Http::fake();
 5 
 6Http::withHeaders([
 7    'X-First' => 'foo',
 8])->post('http://example.com/users', [
 9    'name' => 'Taylor',
10    'role' => 'Developer',
11]);
12 
13Http::assertSent(function (Request $request) {
14    return $request->hasHeader('X-First', 'foo') &&
15           $request->url() == 'http://example.com/users' &&
16           $request['name'] == 'Taylor' &&
17           $request['role'] == 'Developer';
18});
 1use Illuminate\Http\Client\Request;
 2use Illuminate\Support\Facades\Http;
 3 
 4Http::fake();
 5 
 6Http::withHeaders([
 7    'X-First' => 'foo',
 8])->post('http://example.com/users', [
 9    'name' => 'Taylor',
10    'role' => 'Developer',
11]);
12 
13Http::assertSent(function (Request $request) {
14    return $request->hasHeader('X-First', 'foo') &&
15           $request->url() == 'http://example.com/users' &&
16           $request['name'] == 'Taylor' &&
17           $request['role'] == 'Developer';
18});

若有需要，可以使用 assertNotSent 方法來判斷特定 Request 是否未被送出：

 1use Illuminate\Http\Client\Request;
 2use Illuminate\Support\Facades\Http;
 3 
 4Http::fake();
 5 
 6Http::post('http://example.com/users', [
 7    'name' => 'Taylor',
 8    'role' => 'Developer',
 9]);
10 
11Http::assertNotSent(function (Request $request) {
12    return $request->url() === 'http://example.com/posts';
13});
 1use Illuminate\Http\Client\Request;
 2use Illuminate\Support\Facades\Http;
 3 
 4Http::fake();
 5 
 6Http::post('http://example.com/users', [
 7    'name' => 'Taylor',
 8    'role' => 'Developer',
 9]);
10 
11Http::assertNotSent(function (Request $request) {
12    return $request->url() === 'http://example.com/posts';
13});

可以使用 assertSentCount 方法來判斷在測試時「送出」了多少個 Request：

1Http::fake();
2 
3Http::assertSentCount(5);
1Http::fake();
2 
3Http::assertSentCount(5);

或者，也可以使用 assertNothingSent 方法來判斷在測試時是否未送出任何 Request：

1Http::fake();
2 
3Http::assertNothingSent();
1Http::fake();
2 
3Http::assertNothingSent();

事件

在傳送 HTTP Request 的過程中，Laravel 會觸發三個事件。在送出 Request 前會觸發 RequestSending 事件，而給定 Request 收到 Response 後會觸發 ResponseReceived 事件。若給定的 Request 未收到 Response，會觸發 ConnectionFailed 事件。

RequestSending 與 ConnectionFailed 事件都有一個 $request 共用屬性，可以通過這個屬性來取得 Illuminate\Http\Client\Request 實體。而 ResponseReceived 事件中也有一個 $request 公開屬性，以及一個可用來取得 Illuminate\Http\Client\Response 實體的 $response 公開屬性。可以在 App\Providers\EventServiceProvider Service Provider 中為這些 Event 註冊 Listener：

 1/**
 2 * The event listener mappings for the application.
 3 *
 4 * @var array
 5 */
 6protected $listen = [
 7    'Illuminate\Http\Client\Events\RequestSending' => [
 8        'App\Listeners\LogRequestSending',
 9    ],
10    'Illuminate\Http\Client\Events\ResponseReceived' => [
11        'App\Listeners\LogResponseReceived',
12    ],
13    'Illuminate\Http\Client\Events\ConnectionFailed' => [
14        'App\Listeners\LogConnectionFailed',
15    ],
16];
 1/**
 2 * The event listener mappings for the application.
 3 *
 4 * @var array
 5 */
 6protected $listen = [
 7    'Illuminate\Http\Client\Events\RequestSending' => [
 8        'App\Listeners\LogRequestSending',
 9    ],
10    'Illuminate\Http\Client\Events\ResponseReceived' => [
11        'App\Listeners\LogResponseReceived',
12    ],
13    'Illuminate\Http\Client\Events\ConnectionFailed' => [
14        'App\Listeners\LogConnectionFailed',
15    ],
16];