HTTP Client

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

介紹

Laravel 提供了一個圍繞著 Guzzle HTTP client 的表達豐富且極簡的 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 client 也允許您使用 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 內容類型發送：

php

use Illuminate\Support\Facades\Http;

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

GET 請求的查詢參數

在發出 GET 請求時，您可以直接將查詢字串附加到 URL，或者傳遞一個鍵/值對陣列作為 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',
]);

傳送原始請求主體

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

php

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

多部分請求

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

php

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

您可以傳遞一個串流資源，而不是傳遞檔案的原始內容：

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 方法來指定基本認證和摘要認證憑證：

php

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

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

Bearer 權杖

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

php

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

逾時

timeout 方法可用於指定等待回應的最長秒數。預設情況下，HTTP client 將在 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 檔案中配置應用程式的例外處理行為時，利用 truncateRequestExceptionsAt 和 dontTruncateRequestExceptions 方法：

php

use Illuminate\Foundation\Configuration\Exceptions;

->withExceptions(function (Exceptions $exceptions): void {
    // Truncate request exception messages to 240 characters...
    $exceptions->truncateRequestExceptionsAt(240);

    // Disable request exception message truncation...
    $exceptions->dontTruncateRequestExceptions();
})

另外，您可以使用 truncateExceptionsAt 方法針對每個請求自訂例外截斷行為：

php

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

Guzzle 中介層

由於 Laravel 的 HTTP 用戶端由 Guzzle 提供支援，您可以利用 Guzzle Middleware 來操作發出的請求或檢查收到的回應。若要操作發出的請求，請透過 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 方法接受一個鍵值對陣列：

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 方法不能與其他 HTTP client 方法（例如 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 實例，讓您可以輕鬆地將請求加入請求池以供分派，但它也允許您定義完成回呼 (completion callbacks)：

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) {
    // First 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 異常。

檢查批次

提供給批次完成回呼的 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 client 允許您定義「macros (巨集)」，這可以作為一種流暢且富有表達力的機制，用於在與應用程式中的服務互動時配置常見的請求路徑和標頭。要開始使用，您可以在應用程式的 App\Providers\AppServiceProvider 類別的 boot 方法中定義 macro：

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

一旦您的 macro 配置完成，您就可以在應用程式的任何地方調用它，以使用指定的配置創建一個 pending request：

php

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

測試

許多 Laravel 服務提供了功能，幫助您輕鬆且具表達性地撰寫測試，Laravel 的 HTTP Client 也不例外。Http Facade 的 fake 方法能讓您指示 HTTP Client 在發出請求時回傳模擬的回應。

模擬回應

舉例來說，若要指示 HTTP Client 對於每個請求都回傳空的 200 狀態碼回應，您可以呼叫不帶任何引數的 fake 方法：

php

use Illuminate\Support\Facades\Http;

Http::fake();

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

模擬特定 URL

或者，您可以傳遞一個陣列給 fake 方法。該陣列的鍵應該代表您想要模擬的 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 所發出的任何請求都將會實際執行。若您想指定一個備用 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 Client 在嘗試發出請求時遇到 Illuminate\Http\Client\ConnectionException。您可以使用 failedConnection 方法指示 HTTP Client 拋出連線例外：

php

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

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

php

Http::fake([
    'github.com/*' => 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());

模擬回呼

若您需要更複雜的邏輯來判斷對於某些端點要回傳什麼回應，您可以將一個閉包傳遞給 fake 方法。這個閉包將會收到 Illuminate\Http\Client\Request 的實例，且應該回傳一個回應實例。在您的閉包中，您可以執行任何必要的邏輯來判斷要回傳何種回應類型：

php

use Illuminate\Http\Client\Request;

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

檢查請求

在模擬回應時，您有時可能希望檢查 Client 收到的請求，以確保您的應用程式正在發送正確的資料或標頭。您可以在呼叫 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 Client ​

介紹 ​

發出請求 ​

URI 範本 ​

傾印請求 ​

請求資料 ​

GET 請求的查詢參數 ​

傳送表單 URL 編碼請求 ​

傳送原始請求主體 ​

多部分請求 ​

標頭 ​

認證 ​

Bearer 權杖 ​

逾時 ​

重試 ​

錯誤處理 ​

拋出例外 ​

Guzzle 中介層 ​

全域中介層 ​

Guzzle 選項 ​

全域選項 ​

並行請求 ​

請求池 ​

自訂並行請求 ​

請求批次處理 ​

檢查批次 ​

延遲批次 ​

巨集 ​

測試 ​

模擬回應 ​

模擬特定 URL ​

模擬例外 ​

模擬回應序列 ​

模擬回呼 ​

檢查請求 ​

記錄請求/回應 ​

防止漫遊請求 ​

事件 ​