HTTP 客戶端
簡介
Laravel 在 Guzzle HTTP 客戶端 周圍提供了一個富有表現力且極簡的 API,讓您能夠快速發出外發 HTTP 請求,以便與其他 Web 應用程式進行通訊。Laravel 對 Guzzle 的包裝器專注於其最常見的用例以及絕佳的開發人員體驗。
發出請求
若要發出請求,您可以使用 Http
外觀模式提供的 head
、get
、post
、put
、patch
和 delete
方法。首先,讓我們檢查如何向另一個 URL 發出基本 GET
請求
use Illuminate\Support\Facades\Http; $response = Http::get('http://example.com');
get
方法會傳回 Illuminate\Http\Client\Response
的實例,其中提供各種可用於檢查回應的方法
$response->body() : string;$response->json($key = null, $default = null) : mixed;$response->object() : object;$response->collect($key = null) : Illuminate\Support\Collection;$response->resource() : resource;$response->status() : int;$response->successful() : bool;$response->redirect(): bool;$response->failed() : bool;$response->clientError() : bool;$response->header($header) : string;$response->headers() : array;
Illuminate\Http\Client\Response
物件也實作了 PHP ArrayAccess
介面,讓您可以直接在回應中存取 JSON 回應資料
return Http::get('http://example.com/users/1')['name'];
除了上面列出的回應方法外,下列方法可用於判斷回應是否具有給定的狀態碼
$response->ok() : bool; // 200 OK$response->created() : bool; // 201 Created$response->accepted() : bool; // 202 Accepted$response->noContent() : bool; // 204 No Content$response->movedPermanently() : bool; // 301 Moved Permanently$response->found() : bool; // 302 Found$response->badRequest() : bool; // 400 Bad Request$response->unauthorized() : bool; // 401 Unauthorized$response->paymentRequired() : bool; // 402 Payment Required$response->forbidden() : bool; // 403 Forbidden$response->notFound() : bool; // 404 Not Found$response->requestTimeout() : bool; // 408 Request Timeout$response->conflict() : bool; // 409 Conflict$response->unprocessableEntity() : bool; // 422 Unprocessable Entity$response->tooManyRequests() : bool; // 429 Too Many Requests$response->serverError() : bool; // 500 Internal Server Error
URI 樣板
HTTP 客戶端也允許您使用 URI 樣板規格建構請求 URL。若要定義 URI 樣板可以擴展的 URL 參數,您可以使用 withUrlParameters
方法
Http::withUrlParameters([ 'endpoint' => 'https://laravel.dev.org.tw', 'page' => 'docs', 'version' => '11.x', 'topic' => 'validation',])->get('{+endpoint}/{page}/{version}/{topic}');
傾印請求
如果您想要在傳送外發請求實例之前傾印它並終止腳本的執行,您可以將 dd
方法新增至請求定義的開頭
return Http::dd()->get('http://example.com');
請求資料
當然,在發出 POST
、PUT
和 PATCH
請求時,通常會隨請求一起傳送其他資料,因此這些方法會將資料陣列作為其第二個引數。依預設,資料將使用 application/json
內容類型傳送
use Illuminate\Support\Facades\Http; $response = Http::post('http://example.com/users', [ 'name' => 'Steve', 'role' => 'Network Administrator',]);
GET 請求查詢參數
在發出 GET
請求時,您可以直接將查詢字串附加到 URL,或將鍵/值配對陣列作為 get
方法的第二個引數傳遞
$response = Http::get('http://example.com/users', [ 'name' => 'Taylor', 'page' => 1,]);
或者,可以使用 withQueryParameters
方法
Http::retry(3, 100)->withQueryParameters([ 'name' => 'Taylor', 'page' => 1,])->get('http://example.com/users')
傳送表單 URL 編碼請求
如果您想要使用 application/x-www-form-urlencoded
內容類型傳送資料,您應該在發出請求之前呼叫 asForm
方法
$response = Http::asForm()->post('http://example.com/users', [ 'name' => 'Sara', 'role' => 'Privacy Consultant',]);
傳送原始請求主體
如果您想要在發出請求時提供原始請求主體,可以使用 withBody
方法。內容類型可以透過方法的第二個引數提供
$response = Http::withBody( base64_encode($photo), 'image/jpeg')->post('http://example.com/photo');
多部分請求
如果您想要將檔案作為多部分請求傳送,您應該在發出請求之前呼叫 attach
方法。此方法接受檔案的名稱及其內容。如果需要,您可以提供第三個引數,該引數將被視為檔案的檔名,而第四個引數可用於提供與檔案相關聯的標頭
$response = Http::attach( 'attachment', file_get_contents('photo.jpg'), 'photo.jpg', ['Content-Type' => 'image/jpeg'])->post('http://example.com/attachments');
您可以傳遞串流資源,而不是傳遞檔案的原始內容
$photo = fopen('photo.jpg', 'r'); $response = Http::attach( 'attachment', $photo, 'photo.jpg')->post('http://example.com/attachments');
標頭
可以使用 withHeaders
方法將標頭新增至請求。此 withHeaders
方法接受鍵/值配對陣列
$response = Http::withHeaders([ 'X-First' => 'foo', 'X-Second' => 'bar'])->post('http://example.com/users', [ 'name' => 'Taylor',]);
您可以使用 accept
方法指定您的應用程式預期在回應您的請求時傳回的內容類型
$response = Http::accept('application/json')->get('http://example.com/users');
為了方便起見,您可以使用 acceptJson
方法快速指定您的應用程式預期在回應您的請求時傳回 application/json
內容類型
$response = Http::acceptJson()->get('http://example.com/users');
withHeaders
方法會將新的標頭合併到請求的現有標頭中。如果需要,您可以使用 replaceHeaders
方法完全取代所有標頭
$response = Http::withHeaders([ 'X-Original' => 'foo',])->replaceHeaders([ 'X-Replacement' => 'bar',])->post('http://example.com/users', [ 'name' => 'Taylor',]);
身份驗證
您可以使用 withBasicAuth
和 withDigestAuth
方法分別指定基本和摘要驗證憑證
// Basic authentication... // Digest authentication...
持有者權杖
如果您想要快速將持有者權杖新增至請求的 Authorization
標頭,您可以使用 withToken
方法
$response = Http::withToken('token')->post(/* ... */);
逾時
timeout
方法可用於指定等待回應的最大秒數。依預設,HTTP 客戶端會在 30 秒後逾時
$response = Http::timeout(3)->get(/* ... */);
如果超出指定的逾時時間,將會擲回 Illuminate\Http\Client\ConnectionException
的實例。
您可以使用 connectTimeout
方法指定嘗試連線至伺服器時要等待的最大秒數
$response = Http::connectTimeout(3)->get(/* ... */);
重試
如果您希望 HTTP 客戶端在發生用戶端或伺服器錯誤時自動重試請求,您可以使用 retry
方法。retry
方法接受請求應嘗試的最大次數以及 Laravel 在嘗試之間應等待的毫秒數
$response = Http::retry(3, 100)->post(/* ... */);
如果您想要手動計算嘗試之間要休眠的毫秒數,您可以將閉包作為第二個引數傳遞給 retry
方法
use Exception; $response = Http::retry(3, function (int $attempt, Exception $exception) { return $attempt * 100;})->post(/* ... */);
為了方便起見,您也可以提供一個陣列作為 retry
方法的第一個引數。此陣列將用於判斷後續嘗試之間要休眠多少毫秒
$response = Http::retry([100, 200])->post(/* ... */);
如果需要,您可以將第三個引數傳遞給 retry
方法。第三個引數應該是可呼叫的,以判斷是否應該實際嘗試重試。例如,您可能希望僅在初始請求遇到 ConnectionException
時才重試請求
use Exception;use Illuminate\Http\Client\PendingRequest; $response = Http::retry(3, 100, function (Exception $exception, PendingRequest $request) { return $exception instanceof ConnectionException;})->post(/* ... */);
如果請求嘗試失敗,您可能希望在進行新的嘗試之前對請求進行變更。您可以透過修改您提供給 retry
方法的可呼叫引數的請求引數來實現此目的。例如,如果第一次嘗試傳回驗證錯誤,您可能想要使用新的授權權杖重試請求
use Exception;use Illuminate\Http\Client\PendingRequest;use Illuminate\Http\Client\RequestException; $response = Http::withToken($this->getToken())->retry(2, 0, function (Exception $exception, PendingRequest $request) { if (! $exception instanceof RequestException || $exception->response->status() !== 401) { return false; } $request->withToken($this->getNewToken()); return true;})->post(/* ... */);
如果所有請求都失敗,將會擲回 Illuminate\Http\Client\RequestException
的實例。如果您想要停用此行為,您可以提供一個值為 false
的 throw
引數。停用時,在嘗試所有重試後,將會傳回客戶端收到的最後一個回應
$response = Http::retry(3, 100, throw: false)->post(/* ... */);
如果所有請求都因連線問題而失敗,即使 throw
引數設定為 false
,仍會擲回 Illuminate\Http\Client\ConnectionException
。
錯誤處理
與 Guzzle 的預設行為不同,Laravel 的 HTTP 客戶端包裝器不會在用戶端或伺服器錯誤時擲回例外 (伺服器的 400
和 500
層級回應)。您可以使用 successful
、clientError
或 serverError
方法判斷是否傳回其中一個錯誤
// Determine if the status code is >= 200 and < 300...$response->successful(); // Determine if the status code is >= 400...$response->failed(); // Determine if the response has a 400 level status code...$response->clientError(); // Determine if the response has a 500 level status code...$response->serverError(); // Immediately execute the given callback if there was a client or server error...$response->onError(callable $callback);
擲回例外
如果您有一個回應實例,並且希望在回應狀態碼表示客戶端或伺服器錯誤時拋出 Illuminate\Http\Client\RequestException
的實例,您可以使用 throw
或 throwIf
方法。
use Illuminate\Http\Client\Response; $response = Http::post(/* ... */); // Throw an exception if a client or server error occurred...$response->throw(); // Throw an exception if an error occurred and the given condition is true...$response->throwIf($condition); // Throw an exception if an error occurred and the given closure resolves to true...$response->throwIf(fn (Response $response) => true); // Throw an exception if an error occurred and the given condition is false...$response->throwUnless($condition); // Throw an exception if an error occurred and the given closure resolves to false...$response->throwUnless(fn (Response $response) => false); // Throw an exception if the response has a specific status code...$response->throwIfStatus(403); // Throw an exception unless the response has a specific status code...$response->throwUnlessStatus(200); return $response['user']['id'];
Illuminate\Http\Client\RequestException
實例具有一個公開的 $response
屬性,您可以透過它來檢視傳回的回應。
如果沒有發生錯誤,throw
方法會傳回回應實例,讓您可以將其他操作鏈接到 throw
方法。
return Http::post(/* ... */)->throw()->json();
如果您希望在拋出例外之前執行一些額外的邏輯,您可以將閉包傳遞給 throw
方法。例外將在閉包被調用後自動拋出,因此您不需要從閉包內部重新拋出例外。
use Illuminate\Http\Client\Response;use Illuminate\Http\Client\RequestException; return Http::post(/* ... */)->throw(function (Response $response, RequestException $e) { // ...})->json();
預設情況下,RequestException
訊息在記錄或報告時會被截斷為 120 個字元。若要自訂或停用此行為,您可以在 bootstrap/app.php
檔案中配置應用程式的例外處理行為時使用 truncateRequestExceptionsAt
和 dontTruncateRequestExceptions
方法。
->withExceptions(function (Exceptions $exceptions) { // Truncate request exception messages to 240 characters... $exceptions->truncateRequestExceptionsAt(240); // Disable request exception message truncation... $exceptions->dontTruncateRequestExceptions();})
Guzzle 中介層
由於 Laravel 的 HTTP 客戶端是由 Guzzle 提供支援,您可以利用 Guzzle 中介層來操作傳出的請求或檢視傳入的回應。若要操作傳出的請求,請透過 withRequestMiddleware
方法註冊 Guzzle 中介層。
use Illuminate\Support\Facades\Http;use Psr\Http\Message\RequestInterface; $response = Http::withRequestMiddleware( function (RequestInterface $request) { return $request->withHeader('X-Example', 'Value'); })->get('http://example.com');
同樣地,您可以透過 withResponseMiddleware
方法註冊中介層來檢視傳入的 HTTP 回應。
use Illuminate\Support\Facades\Http;use Psr\Http\Message\ResponseInterface; $response = Http::withResponseMiddleware( function (ResponseInterface $response) { $header = $response->getHeader('X-Example'); // ... return $response; })->get('http://example.com');
全域中介層
有時,您可能希望註冊一個適用於每個傳出請求和傳入回應的中介層。為此,您可以使用 globalRequestMiddleware
和 globalResponseMiddleware
方法。通常,這些方法應在應用程式的 AppServiceProvider
的 boot
方法中被調用。
use Illuminate\Support\Facades\Http; Http::globalRequestMiddleware(fn ($request) => $request->withHeader( 'User-Agent', 'Example Application/1.0')); Http::globalResponseMiddleware(fn ($response) => $response->withHeader( 'X-Finished-At', now()->toDateTimeString()));
Guzzle 選項
您可以使用 withOptions
方法為傳出的請求指定其他 Guzzle 請求選項。withOptions
方法接受鍵/值對的陣列。
$response = Http::withOptions([ 'debug' => true,])->get('http://example.com/users');
全域選項
若要為每個傳出的請求設定預設選項,您可以使用 globalOptions
方法。通常,此方法應從應用程式的 AppServiceProvider
的 boot
方法中被調用。
use Illuminate\Support\Facades\Http; /** * Bootstrap any application services. */public function boot(): void{ Http::globalOptions([ 'allow_redirects' => false, ]);}
並行請求
有時,您可能希望同時發出多個 HTTP 請求。換句話說,您希望同時發送多個請求,而不是依序發出請求。當與速度較慢的 HTTP API 互動時,這可以顯著提高效能。
幸運的是,您可以使用 pool
方法來完成此操作。pool
方法接受一個閉包,該閉包接收一個 Illuminate\Http\Client\Pool
實例,讓您可以輕鬆地將請求添加到請求池以進行發送。
use Illuminate\Http\Client\Pool;use Illuminate\Support\Facades\Http; $responses = Http::pool(fn (Pool $pool) => [ $pool->get('http://localhost/first'), $pool->get('http://localhost/second'), $pool->get('http://localhost/third'),]); return $responses[0]->ok() && $responses[1]->ok() && $responses[2]->ok();
如您所見,每個回應實例都可以根據其添加到池中的順序進行存取。如果您願意,您可以使用 as
方法命名請求,這讓您可以按名稱存取相應的回應。
use Illuminate\Http\Client\Pool;use Illuminate\Support\Facades\Http; $responses = Http::pool(fn (Pool $pool) => [ $pool->as('first')->get('http://localhost/first'), $pool->as('second')->get('http://localhost/second'), $pool->as('third')->get('http://localhost/third'),]); return $responses['first']->ok();
自訂並行請求
pool
方法不能與其他 HTTP 客戶端方法(例如 withHeaders
或 middleware
方法)鏈接。如果您想將自訂標頭或中介層應用於池化請求,您應該在池中的每個請求上配置這些選項。
use Illuminate\Http\Client\Pool;use Illuminate\Support\Facades\Http; $headers = [ 'X-Example' => 'example',]; $responses = Http::pool(fn (Pool $pool) => [ $pool->withHeaders($headers)->get('http://laravel.test/test'), $pool->withHeaders($headers)->get('http://laravel.test/test'), $pool->withHeaders($headers)->get('http://laravel.test/test'),]);
巨集
Laravel HTTP 客戶端允許您定義「巨集」,這可以作為流暢且表達力強的機制,在與應用程式中的服務互動時配置常見的請求路徑和標頭。要開始使用,您可以在應用程式的 App\Providers\AppServiceProvider
類別的 boot
方法中定義巨集。
use Illuminate\Support\Facades\Http; /** * Bootstrap any application services. */public function boot(): void{ Http::macro('github', function () { return Http::withHeaders([ 'X-Example' => 'example', ])->baseUrl('https://github.com'); });}
設定好巨集後,您可以從應用程式中的任何位置調用它,以使用指定的配置建立待處理的請求。
$response = Http::github()->get('/');
測試
許多 Laravel 服務都提供功能來幫助您輕鬆且明確地編寫測試,而 Laravel 的 HTTP 客戶端也不例外。Http
facade 的 fake
方法允許您指示 HTTP 客戶端在發出請求時傳回存根/虛擬回應。
模擬回應
例如,若要指示 HTTP 客戶端為每個請求傳回空的 200
狀態碼回應,您可以調用不帶任何參數的 fake
方法。
use Illuminate\Support\Facades\Http; Http::fake(); $response = Http::post(/* ... */);
偽造特定 URL
或者,您可以將陣列傳遞給 fake
方法。陣列的鍵應代表您要偽造的 URL 模式及其關聯的回應。*
字元可以用作萬用字元。對未偽造的 URL 發出的任何請求都將實際執行。您可以使用 Http
facade 的 response
方法為這些端點建構存根/偽造回應。
Http::fake([ // Stub a JSON response for GitHub endpoints... 'github.com/*' => Http::response(['foo' => 'bar'], 200, $headers), // Stub a string response for Google endpoints... 'google.com/*' => Http::response('Hello World', 200, $headers),]);
如果您想指定一個後備 URL 模式,該模式將存根所有不匹配的 URL,您可以使用單個 *
字元。
Http::fake([ // Stub a JSON response for GitHub endpoints... 'github.com/*' => Http::response(['foo' => 'bar'], 200, ['Headers']), // Stub a string response for all other endpoints... '*' => Http::response('Hello World', 200, ['Headers']),]);
為了方便起見,可以通過提供字串、陣列或整數作為回應來生成簡單的字串、JSON 和空回應。
Http::fake([ 'google.com/*' => 'Hello World', 'github.com/*' => ['foo' => 'bar'], 'chatgpt.com/*' => 200,]);
偽造連線例外
有時,您可能需要測試應用程式在 HTTP 客戶端嘗試發出請求時遇到 Illuminate\Http\Client\ConnectionException
的行為。您可以使用 failedConnection
方法指示 HTTP 客戶端拋出連線例外。
Http::fake([ 'github.com/*' => Http::failedConnection(),]);
偽造回應序列
有時,您可能需要指定單個 URL 應按特定順序傳回一系列偽造的回應。您可以使用 Http::sequence
方法來建構回應。
Http::fake([ // Stub a series of responses for GitHub endpoints... 'github.com/*' => Http::sequence() ->push('Hello World', 200) ->push(['foo' => 'bar'], 200) ->pushStatus(404),]);
當回應序列中的所有回應都已被使用完畢時,任何進一步的請求都會導致回應序列拋出例外。如果您想指定在序列為空時應傳回的預設回應,可以使用 whenEmpty
方法。
Http::fake([ // Stub a series of responses for GitHub endpoints... 'github.com/*' => Http::sequence() ->push('Hello World', 200) ->push(['foo' => 'bar'], 200) ->whenEmpty(Http::response()),]);
如果您想偽造一系列回應,但不需要指定應偽造的特定 URL 模式,則可以使用 Http::fakeSequence
方法。
Http::fakeSequence() ->push('Hello World', 200) ->whenEmpty(Http::response());
偽造回調
如果您需要更複雜的邏輯來確定要為某些端點傳回哪些回應,您可以將閉包傳遞給 fake
方法。此閉包將接收 Illuminate\Http\Client\Request
的實例,並且應傳回回應實例。在您的閉包中,您可以執行任何必要的邏輯來確定要傳回的回應類型。
use Illuminate\Http\Client\Request; Http::fake(function (Request $request) { return Http::response('Hello World', 200);});
防止錯誤請求
如果您想確保透過 HTTP 客戶端發送的所有請求都在您的個別測試或完整的測試套件中被偽造,您可以調用 preventStrayRequests
方法。調用此方法後,任何沒有相應偽造回應的請求都會拋出例外,而不是發出實際的 HTTP 請求。
use Illuminate\Support\Facades\Http; Http::preventStrayRequests(); Http::fake([ 'github.com/*' => Http::response('ok'),]); // An "ok" response is returned...Http::get('https://github.com/laravel/framework'); // An exception is thrown...Http::get('https://laravel.dev.org.tw');
檢查請求
在偽造回應時,您有時可能希望檢視客戶端接收到的請求,以確保您的應用程式正在發送正確的資料或標頭。您可以在調用 Http::fake
之後調用 Http::assertSent
方法來完成此操作。
assertSent
方法接受一個閉包,該閉包將接收 Illuminate\Http\Client\Request
實例,並且應傳回一個布林值,指示請求是否符合您的期望。為了讓測試通過,必須至少發出一個符合指定期望的請求。
use Illuminate\Http\Client\Request;use Illuminate\Support\Facades\Http; Http::fake(); Http::withHeaders([ 'X-First' => 'foo',])->post('http://example.com/users', [ 'name' => 'Taylor', 'role' => 'Developer',]); Http::assertSent(function (Request $request) { return $request->hasHeader('X-First', 'foo') && $request->url() == 'http://example.com/users' && $request['name'] == 'Taylor' && $request['role'] == 'Developer';});
如果需要,您可以使用 assertNotSent
方法斷言未發送特定請求。
use Illuminate\Http\Client\Request;use Illuminate\Support\Facades\Http; Http::fake(); Http::post('http://example.com/users', [ 'name' => 'Taylor', 'role' => 'Developer',]); Http::assertNotSent(function (Request $request) { return $request->url() === 'http://example.com/posts';});
您可以使用 assertSentCount
方法斷言在測試期間「發送」了多少個請求。
Http::fake(); Http::assertSentCount(5);
或者,您可以使用 assertNothingSent
方法斷言在測試期間未發送任何請求。
Http::fake(); Http::assertNothingSent();
記錄請求/回應
您可以使用 recorded
方法來收集所有請求及其相應的回應。recorded
方法傳回一個陣列集合,其中包含 Illuminate\Http\Client\Request
和 Illuminate\Http\Client\Response
的實例。
Http::fake([ 'https://laravel.dev.org.tw' => Http::response(status: 500), 'https://nova.laravel.com/' => Http::response(),]); Http::get('https://laravel.dev.org.tw');Http::get('https://nova.laravel.com/'); $recorded = Http::recorded(); [$request, $response] = $recorded[0];
此外,recorded
方法接受一個閉包,該閉包將接收 Illuminate\Http\Client\Request
和 Illuminate\Http\Client\Response
的實例,並且可以用於根據您的期望過濾請求/回應對。
use Illuminate\Http\Client\Request;use Illuminate\Http\Client\Response; Http::fake([ 'https://laravel.dev.org.tw' => Http::response(status: 500), 'https://nova.laravel.com/' => Http::response(),]); Http::get('https://laravel.dev.org.tw');Http::get('https://nova.laravel.com/'); $recorded = Http::recorded(function (Request $request, Response $response) { return $request->url() !== 'https://laravel.dev.org.tw' && $response->successful();});
事件
在發送 HTTP 請求的過程中,Laravel 會觸發三個事件。RequestSending
事件在發送請求之前觸發,而 ResponseReceived
事件在接收到給定請求的回應後觸發。如果沒有收到給定請求的回應,則會觸發 ConnectionFailed
事件。
RequestSending
和 ConnectionFailed
事件都包含一個公開的 $request
屬性,您可以使用它來檢視 Illuminate\Http\Client\Request
實例。同樣地,ResponseReceived
事件包含一個 $request
屬性和一個 $response
屬性,您可以使用它們來檢視 Illuminate\Http\Client\Response
實例。您可以在應用程式中為這些事件建立事件監聽器。
use Illuminate\Http\Client\Events\RequestSending; class LogRequest{ /** * Handle the given event. */ public function handle(RequestSending $event): void { // $event->request ... }}