HTTP 用戶端

簡介
發送請求
並行請求
- 請求池
- 請求批次處理
巨集
測試
事件

簡介

Laravel 為 Guzzle HTTP 用戶端提供了一個極具表現力且簡潔的 API，讓你能夠快速發送傳出的 HTTP 請求，以便與其他的網路應用程式通訊。Laravel 對 Guzzle 的封裝專注於其最常見的使用場景，並提供了極佳的開發者體驗。

發送請求

若要發送請求，您可以使用 Http Facade 提供的 head, get, post, put, patch, 以及 delete 方法。首先，讓我們看看如何對另一個 URL 發送基本的 GET 請求：

php

use Illuminate\Support\Facades\Http;

$response = Http::get('http://example.com');

get 方法會回傳 Illuminate\Http\Client\Response 的實例，該實例提供了多種可用於檢查回應的方法：

php

$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 回應資料：

php

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

除了上面列出的回應方法外，還可以使用以下方法來判斷回應是否具有特定的狀態碼：

php

$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 方法：

php

Http::withUrlParameters([
    'endpoint' => 'https://laravel.com',
    'page' => 'docs',
    'version' => '12.x',
    'topic' => 'validation',
])->get('{+endpoint}/{page}/{version}/{topic}');

傾印請求

如果您想在發送傳出請求實例之前將其傾印 (Dump) 並終止腳本執行，可以在請求定義的開頭加入 dd 方法：

php

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

請求資料

當然，在發送 POST、PUT 和 PATCH 請求時，通常會隨請求發送額外資料，因此這些方法接受資料陣列作為其第二個參數。預設情況下，資料將使用 application/json 內容類型 (Content Type) 發送：

php

use Illuminate\Support\Facades\Http;

$response = Http::post('http://example.com/users', [
    'name' => 'Steve',
    'role' => 'Network Administrator',
]);

GET 請求查詢參數

發送 GET 請求時，您可以直接在 URL 後面附加查詢字串，或是將鍵值對 (Key / Value Pairs) 陣列作為第二個參數傳遞給 get 方法：

php

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

或者，也可以使用 withQueryParameters 方法：

php

Http::retry(3, 100)->withQueryParameters([
    'name' => 'Taylor',
    'page' => 1,
])->get('http://example.com/users');

發送表單 URL 編碼請求

如果您想使用 application/x-www-form-urlencoded 內容類型發送資料，則應在發送請求之前呼叫 asForm 方法：

php

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

發送原始請求主體

如果您想在發送請求時提供原始請求主體 (Raw Request Body)，可以使用 withBody 方法。內容類型可以透過該方法的第二個參數提供：

php

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

多部分請求

如果您想將檔案作為多部分請求 (Multi-part Requests) 發送，則應在發送請求之前呼叫 attach 方法。此方法接受檔案名稱及其內容。如果需要，您可以提供第三個參數作為檔案的檔名，而第四個參數可用於提供與檔案相關聯的標頭：

php

$response = Http::attach(
    'attachment', file_get_contents('photo.jpg'), 'photo.jpg', ['Content-Type' => 'image/jpeg']
)->post('http://example.com/attachments');

除了傳遞檔案的原始內容外，您也可以傳遞串流資源 (Stream Resource)：

php

$photo = fopen('photo.jpg', 'r');

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

標頭

可以使用 withHeaders 方法將標頭添加到請求中。此 withHeaders 方法接受一個鍵值對陣列：

php

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

您可以使用 accept 方法來指定應用程式期望的回應內容類型：

php

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

為了方便起見，您可以使用 acceptJson 方法快速指定應用程式期望回應為 application/json 內容類型：

php

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

withHeaders 方法會將新標頭合併到請求現有的標頭中。如果需要，您可以使用 replaceHeaders 方法完全取代所有標頭：

php

$response = Http::withHeaders([
    'X-Original' => 'foo',
])->replaceHeaders([
    'X-Replacement' => 'bar',
])->post('http://example.com/users', [
    'name' => 'Taylor',
]);

身份驗證

您可以分別使用 withBasicAuth 和 withDigestAuth 方法指定基本 (Basic) 和摘要 (Digest) 身份驗證憑證：

php

// Basic authentication...
$response = Http::withBasicAuth('[email protected]', 'secret')->post(/* ... */);

// Digest authentication...
$response = Http::withDigestAuth('[email protected]', 'secret')->post(/* ... */);

Bearer Tokens

如果您想快速將 Bearer Token 添加到請求的 Authorization 標頭中，可以使用 withToken 方法：

php

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

逾時

timeout 方法可用於指定等待回應的最長秒數。預設情況下，HTTP 用戶端會在 30 秒後逾時：

php

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

如果超過給定的逾時時間，將拋出 Illuminate\Http\Client\ConnectionException 實例。

您可以使用 connectTimeout 方法指定嘗試連線至伺服器時的最長等待秒數。預設為 10 秒：

php

$response = Http::connectTimeout(3)->get(/* ... */);

重試

如果您希望 HTTP 用戶端在發生客戶端或伺服器錯誤時自動重試請求，可以使用 retry 方法。retry 方法接受請求應嘗試的最大次數，以及 Laravel 在每次嘗試之間應等待的毫秒數：

php

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

如果您想手動計算每次嘗試之間應等待的毫秒數，可以將一個閉包作為第二個參數傳遞給 retry 方法：

php

use Exception;

$response = Http::retry(3, function (int $attempt, Exception $exception) {
    return $attempt * 100;
})->post(/* ... */);

為了方便起見，您也可以將一個陣列作為 retry 方法的第一個參數。該陣列將用於決定後續嘗試之間應等待的毫秒數：

php

$response = Http::retry([100, 200])->post(/* ... */);

如果需要，您可以向 retry 方法傳遞第三個參數。第三個參數應該是一個可呼叫項 (Callable)，用於決定是否真的應該進行重試。例如，您可能希望僅在初始請求遇到 ConnectionException 時才重試請求：

php

use Exception;
use Illuminate\Http\Client\PendingRequest;

$response = Http::retry(3, 100, function (Exception $exception, PendingRequest $request) {
    return $exception instanceof ConnectionException;
})->post(/* ... */);

如果某次請求嘗試失敗，您可能希望在進行下一次嘗試之前對請求進行修改。您可以透過修改傳遞給 retry 方法中可呼叫項的請求參數來實現此目的。例如，如果第一次嘗試回傳了身份驗證錯誤，您可能希望使用新的授權權杖 (Token) 來重試請求：

php

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 參數。停用時，在完成所有重試嘗試後，將回傳用戶端收到的最後一個回應：

php

$response = Http::retry(3, 100, throw: false)->post(/* ... */);

⚠️ 警告

如果所有請求都因為連線問題而失敗，即使將 throw 參數設定為 false，仍然會拋出 Illuminate\Http\Client\ConnectionException。

錯誤處理

與 Guzzle 的預設行為不同，Laravel 的 HTTP 用戶端封裝在發生客戶端或伺服器錯誤時（來自伺服器的 400 和 500 層級回應）不會拋出例外。您可以使用 successful、clientError 或 serverError 方法來判斷是否回傳了這些錯誤：

php

// 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 方法：

php

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 方法上：

php

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

如果您想在拋出例外之前執行一些額外的邏輯，可以將一個閉包傳遞給 throw 方法。例外會在閉包被呼叫後自動拋出，因此您不需要在閉包內手動重新拋出例外：

php

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 檔案中設定應用程式的註冊行為時，使用 truncateAt 和 dontTruncate 方法：

php

use Illuminate\Http\Client\RequestException;

->registered(function (): void {
    // Truncate request exception messages to 240 characters...
    RequestException::truncateAt(240);

    // Disable request exception message truncation...
    RequestException::dontTruncate();
})

或者，您也可以使用 truncateExceptionsAt 方法針對單個請求自訂例外截斷行為：

php

return Http::truncateExceptionsAt(240)->post(/* ... */);

Guzzle 中介層

由於 Laravel 的 HTTP 用戶端是由 Guzzle 驅動的，因此您可以利用 Guzzle 中介層來操作發出的請求或檢查傳入的回應。若要操作發出的請求，請透過 withRequestMiddleware 方法註冊 Guzzle 中介層：

php

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 回應：

php

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 方法中調用：

php

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 方法接受一個鍵值對 (Key / Value Pairs) 陣列：

php

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

全域選項

若要為每個發出的請求配置預設選項，您可以利用 globalOptions 方法。通常，此方法應該從應用程式 AppServiceProvider 的 boot 方法中調用：

php

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 實例，讓你能夠輕鬆地將請求加入請求池中進行發送：

php

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 方法為請求命名，這讓你能夠透過名稱來存取對應的回應：

php

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 方法提供 concurrency 引數來控制。此值決定了在處理請求池時，可以同時進行的最大 HTTP 請求數量：

php

$responses = Http::pool(fn (Pool $pool) => [
    // ...
], concurrency: 5);

客製化並行請求

pool 方法無法與其他 HTTP 用戶端方法（如 withHeaders 或 middleware 方法）鏈接。如果你想對池化請求套用自訂標頭或中介層，你應該在池中的每個請求上配置這些選項：

php

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 中處理並行請求的另一種方式是使用 batch 方法。與 pool 方法類似，它接受一個接收 Illuminate\Http\Client\Batch 實例的閉包，讓你能夠輕鬆地將請求加入請求池中進行發送，但它也允許你定義完成回呼 (Callback)：

php

use Illuminate\Http\Client\Batch;
use Illuminate\Http\Client\ConnectionException;
use Illuminate\Http\Client\RequestException;
use Illuminate\Http\Client\Response;
use Illuminate\Support\Facades\Http;

$responses = Http::batch(fn (Batch $batch) => [
    $batch->get('http://localhost/first'),
    $batch->get('http://localhost/second'),
    $batch->get('http://localhost/third'),
])->before(function (Batch $batch) {
    // The batch has been created but no requests have been initialized...
})->progress(function (Batch $batch, int|string $key, Response $response) {
    // An individual request has completed successfully...
})->then(function (Batch $batch, array $results) {
    // All requests completed successfully...
})->catch(function (Batch $batch, int|string $key, Response|RequestException|ConnectionException $response) {
    // Batch request failure detected...
})->finally(function (Batch $batch, array $results) {
    // The batch has finished executing...
})->send();

與 pool 方法一樣，你可以使用 as 方法為請求命名：

php

$responses = Http::batch(fn (Batch $batch) => [
    $batch->as('first')->get('http://localhost/first'),
    $batch->as('second')->get('http://localhost/second'),
    $batch->as('third')->get('http://localhost/third'),
])->send();

在透過呼叫 send 方法啟動 batch 之後，你不能再向其新增請求。嘗試這樣做將導致拋出 Illuminate\Http\Client\BatchInProgressException 異常。

請求批次處理的最大並行數可以透過 concurrency 方法來控制。此值決定了在處理請求批次時，可以同時進行的最大 HTTP 請求數量：

php

$responses = Http::batch(fn (Batch $batch) => [
    // ...
])->concurrency(5)->send();

檢查批次處理

提供給批次處理完成回呼的 Illuminate\Http\Client\Batch 實例具有多種屬性和方法，可協助你與指定的請求批次進行互動與檢查：

php

// The number of requests assigned to the batch...
$batch->totalRequests;
 
// The number of requests that have not been processed yet...
$batch->pendingRequests;
 
// The number of requests that have failed...
$batch->failedRequests;

// The number of requests that have been processed thus far...
$batch->processedRequests();

// Indicates if the batch has finished executing...
$batch->finished();

// Indicates if the batch has request failures...
$batch->hasFailures();

延遲批次處理

當呼叫 defer 方法時，該批次請求不會立即執行。相反地，Laravel 會在當前應用程式請求的 HTTP 回應發送給使用者後才執行該批次，從而保持你的應用程式運行快速且反應靈敏：

php

use Illuminate\Http\Client\Batch;
use Illuminate\Support\Facades\Http;

$responses = Http::batch(fn (Batch $batch) => [
    $batch->get('http://localhost/first'),
    $batch->get('http://localhost/second'),
    $batch->get('http://localhost/third'),
])->then(function (Batch $batch, array $results) {
    // All requests completed successfully...
})->defer();

巨集

Laravel HTTP 用戶端允許你定義「巨集 (Macros)」，這可以作為一種流暢且具表現力的機制，用於在與整個應用程式中的服務互動時配置常見的請求路徑與標頭。要開始使用，你可以在應用程式的 App\Providers\AppServiceProvider 類別的 boot 方法中定義巨集：

php

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');
    });
}

配置好巨集後，你可以在應用程式的任何地方呼叫它，以建立具有指定配置的待處理請求：

php

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

測試

許多 Laravel 服務都提供了能幫助您輕鬆且具表達力地編寫測試的功能，Laravel 的 HTTP 用戶端也不例外。Http Facade 的 fake 方法允許您指示 HTTP 用戶端在發出請求時返回模擬 (Stubbed) / 虛擬 (Dummy) 的回應。

偽造回應

例如，若要指示 HTTP 用戶端為每個請求返回空的、狀態碼為 200 的回應，您可以呼叫不帶任何參數的 fake 方法：

php

use Illuminate\Support\Facades\Http;

Http::fake();

$response = Http::post(/* ... */);

偽造特定的 URL

或者，您可以將一個陣列傳遞給 fake 方法。該陣列的鍵 (Key) 應代表您希望偽造的 URL 模式及其關聯的回應。* 字元可用作萬用字元。您可以使用 Http Facade 的 response 方法為這些端點建構模擬 / 偽造的回應：

php

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 發出的請求都將實際執行。如果您想指定一個後備 (Fallback) URL 模式來模擬所有未匹配的 URL，可以使用單個 * 字元：

php

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 和空回應：

php

Http::fake([
    'google.com/*' => 'Hello World',
    'github.com/*' => ['foo' => 'bar'],
    'chatgpt.com/*' => 200,
]);

偽造例外

有時您可能需要測試應用程式在嘗試發出請求時，若 HTTP 用戶端遇到 Illuminate\Http\Client\ConnectionException 的行為。您可以使用 failedConnection 方法指示 HTTP 用戶端拋出連線例外：

php

Http::fake([
    'github.com/*' => Http::failedConnection(),
]);

若要測試當拋出 Illuminate\Http\Client\RequestException 時應用程式的行為，您可以使用 failedRequest 方法：

php

$this->mock(GithubService::class);
    ->shouldReceive('getUser')
    ->andThrow(
        Http::failedRequest(['code' => 'not_found'], 404)
    );

偽造回應序列

有時您可能需要指定單個 URL 應按特定順序返回一系列偽造回應。您可以使用 Http::sequence 方法來建構這些回應：

php

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 方法：

php

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 方法：

php

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

偽造回呼

如果您需要更複雜的邏輯來決定某些端點應返回什麼回應，可以傳遞一個閉包 (Closure) 給 fake 方法。此閉包將接收一個 Illuminate\Http\Client\Request 實例並應返回一個回應實例。在您的閉包內，您可以執行任何必要的邏輯來判斷要返回哪種類型的回應：

php

use Illuminate\Http\Client\Request;

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

檢查請求

偽造回應時，您偶爾會希望檢查用戶端接收到的請求，以確保您的應用程式正在發送正確的資料或標頭。您可以在呼叫 Http::fake 之後，透過呼叫 Http::assertSent 方法來實現這一點。

assertSent 方法接受一個閉包，該閉包將接收一個 Illuminate\Http\Client\Request 實例，並應返回一個布林值，指示該請求是否符合您的預期。為了使測試通過，必須至少發出一個符合給定預期的請求：

php

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 方法斷言特定的請求未被發送：

php

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 方法來斷言測試期間「發送」了多少個請求：

php

Http::fake();

Http::assertSentCount(5);

或者，您可以使用 assertNothingSent 方法來斷言測試期間沒有發送任何請求：

php

Http::fake();

Http::assertNothingSent();

記錄請求 / 回應

您可以使用 recorded 方法來收集所有請求及其對應的回應。recorded 方法會返回一個陣列集合，其中包含 Illuminate\Http\Client\Request 和 Illuminate\Http\Client\Response 的實例：

php

Http::fake([
    'https://laravel.com' => Http::response(status: 500),
    'https://nova.laravel.com/' => Http::response(),
]);

Http::get('https://laravel.com');
Http::get('https://nova.laravel.com/');

$recorded = Http::recorded();

[$request, $response] = $recorded[0];

此外，recorded 方法接受一個閉包，該閉包將接收 Illuminate\Http\Client\Request 和 Illuminate\Http\Client\Response 實例，並可用於根據您的預期過濾請求 / 回應對：

php

use Illuminate\Http\Client\Request;
use Illuminate\Http\Client\Response;

Http::fake([
    'https://laravel.com' => Http::response(status: 500),
    'https://nova.laravel.com/' => Http::response(),
]);

Http::get('https://laravel.com');
Http::get('https://nova.laravel.com/');

$recorded = Http::recorded(function (Request $request, Response $response) {
    return $request->url() !== 'https://laravel.com' &&
           $response->successful();
});

防止非預期的請求

如果您希望確保在個別測試或整個測試套件中，所有透過 HTTP 用戶端發送的請求都已被偽造，您可以呼叫 preventStrayRequests 方法。呼叫此方法後，任何沒有對應偽造回應的請求都將拋出例外，而不是進行實際的 HTTP 請求：

php

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.com');

有時，您可能希望防止大多數非預期的請求，但仍允許特定的請求執行。要達成此目的，您可以將一組 URL 模式陣列傳遞給 allowStrayRequests 方法。任何符合給定模式之一的請求都將被允許執行，而所有其他請求則會繼續拋出例外：

php

use Illuminate\Support\Facades\Http;

Http::preventStrayRequests();

Http::allowStrayRequests([
    'http://127.0.0.1:5000/*',
]);

// This request is executed...
Http::get('http://127.0.0.1:5000/generate');

// An exception is thrown...
Http::get('https://laravel.com');

事件

Laravel 在發送 HTTP 請求的過程中會觸發三個事件。RequestSending 事件在請求發送之前觸發，而 ResponseReceived 事件則在收到指定請求的回應後觸發。若指定請求未收到任何回應，則會觸發 ConnectionFailed 事件。

RequestSending 與 ConnectionFailed 事件都包含一個公開的 $request 屬性，您可以用它來檢查 Illuminate\Http\Client\Request 執行個體。同樣地，ResponseReceived 事件包含一個 $request 屬性以及一個 $response 屬性，可用於檢查 Illuminate\Http\Client\Response 執行個體。您可以在應用程式中為這些事件建立事件監聽器：

php

use Illuminate\Http\Client\Events\RequestSending;

class LogRequest
{
    /**
     * Handle the event.
     */
    public function handle(RequestSending $event): void
    {
        // $event->request ...
    }
}

HTTP 用戶端 ​

簡介 ​

發送請求 ​

URI 模板 ​

傾印請求 ​

請求資料 ​

GET 請求查詢參數 ​

發送表單 URL 編碼請求 ​

發送原始請求主體 ​

多部分請求 ​

標頭 ​

身份驗證 ​

Bearer Tokens ​

逾時 ​

重試 ​

錯誤處理 ​

拋出例外 ​

Guzzle 中介層 ​

全域中介層 ​

Guzzle 選項 ​

全域選項 ​

並行請求 ​

請求池 ​

客製化並行請求 ​

請求批次處理 ​

檢查批次處理 ​

延遲批次處理 ​

巨集 ​

測試 ​

偽造回應 ​

偽造特定的 URL ​

偽造例外 ​

偽造回應序列 ​

偽造回呼 ​

檢查請求 ​

記錄請求 / 回應 ​

防止非預期的請求 ​

事件 ​