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, $flags = 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 Server Error

URI 模板

HTTP 客户端还允许你使用 URI 模板规范构建请求 URL。要定义可由 URI 模板展开的 URL 参数，可以使用 withUrlParameters 方法：

Http::withUrlParameters([
    'endpoint' => 'https://laravel.com',
    'page' => 'docs',
    'version' => '13.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...
$response = Http::withBasicAuth('[email protected]', 'secret')->post(/* ... */);

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

Bearer Tokens

如果你想快速将 Bearer Token 添加到请求的 Authorization 请求头中，可以使用 withToken 方法：

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

超时

可以使用 timeout 方法指定等待响应的最大秒数。默认情况下，HTTP 客户端会在 30 秒后超时：

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

如果超出了给定的超时时间，将抛出 Illuminate\Http\Client\ConnectionException 实例。

你可以使用 connectTimeout 方法指定尝试连接到服务器时等待的最大秒数。默认值为 10 秒：

$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 Illuminate\Http\Client\PendingRequest;
use Throwable;

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

如果某次请求尝试失败，你可能希望在发起新的尝试之前对请求做出修改。你可以通过修改提供给 retry 方法的可调用对象的请求参数来实现这一点。例如，如果首次尝试返回认证错误，你可能会想使用新的授权令牌重试请求：

use Illuminate\Http\Client\PendingRequest;
use Illuminate\Http\Client\RequestException;
use Throwable;

$response = Http::withToken($this->getToken())->retry(2, 0, function (Throwable $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 方法来判断是否返回了此类错误：

// 判断状态码是否 >= 200 且 < 300...
$response->successful();

// 判断状态码是否 >= 400...
$response->failed();

// 判断响应是否具有 400 级别的状态码...
$response->clientError();

// 判断响应是否具有 500 级别的状态码...
$response->serverError();

// 如果发生了客户端或服务器错误，立即执行给定的回调...
$response->onError(callable $callback);

抛出异常

如果你有一个响应实例，并且希望在响应状态码表明出现客户端或服务器错误时抛出一个 Illuminate\Http\Client\RequestException 实例，你可以使用 throw 或 throwIf 方法：

use Illuminate\Http\Client\Response;

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

// 如果发生了客户端或服务器错误，则抛出异常...
$response->throw();

// 如果发生错误且给定条件为真，则抛出异常...
$response->throwIf($condition);

// 如果发生错误且给定闭包的执行结果为真，则抛出异常...
$response->throwIf(fn (Response $response) => true);

// 如果发生错误且给定条件为假，则抛出异常...
$response->throwUnless($condition);

// 如果发生错误且给定闭包的执行结果为假，则抛出异常...
$response->throwUnless(fn (Response $response) => false);

// 如果响应具有特定状态码，则抛出异常...
$response->throwIfStatus(403);

// 除非响应具有特定状态码，否则抛出异常...
$response->throwUnlessStatus(200);

// 如果发生服务器错误（状态码 >= 500），则抛出异常...
$response->throwIfServerError();

// 如果发生客户端错误（状态码 >= 400 且 < 500），则抛出异常...
$response->throwIfClientError();

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 文件中配置应用程序已注册的行为时，使用 truncateAt 和 dontTruncate 方法：

use Illuminate\Http\Client\RequestException;

->registered(function (): void {
    // 将请求异常消息截断为 240 个字符...
    RequestException::truncateAt(240);

    // 禁用请求异常消息截断...
    RequestException::dontTruncate();
})

另外，你可以使用 truncateExceptionsAt 方法针对每个请求自定义异常截断行为：

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

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;

/**
 * 启动任意应用服务。
 */
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 方法提供 concurrency 参数来控制请求池的最大并发数。该值决定了在处理请求池时，同时处于在途状态的 HTTP 请求的最大数量：

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

如果池中的某个请求在连接层面失败（例如超时或 DNS 解析失败），$responses 数组中对应的条目将是 Illuminate\Http\Client\ConnectionException 实例，而非 Response 实例：

foreach ($responses as $response) {
    if ($response instanceof Throwable) {
        // 请求连接失败……
    } elseif ($response->failed()) {
        // 请求连接成功但收到错误响应……
    }
}

自定义并发请求

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 中处理并发请求的另一种方式是使用 batch 方法。与 pool 方法类似，它接收一个闭包，该闭包会接收一个 Illuminate\Http\Client\Batch 实例，让你可以轻松将请求添加到请求池中进行分派，同时它还允许你定义完成回调：

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) {
    // 批处理已创建，但尚未初始化任何请求……
})->progress(function (Batch $batch, int|string $key, Response $response) {
    // 单个请求已成功完成……
})->then(function (Batch $batch, array $results) {
    // 所有请求均已成功完成……
})->catch(function (Batch $batch, int|string $key, Response|RequestException|ConnectionException $response) {
    // 检测到批处理请求失败……
})->finally(function (Batch $batch, array $results) {
    // 批处理已执行完毕……
})->send();

与 pool 方法一样，你可以使用 as 方法为请求命名：

$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 请求的最大数量：

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

检查批处理

传递给批处理完成回调的 Illuminate\Http\Client\Batch 实例具有多种属性和方法，可协助你与指定的请求批处理进行交互并进行检查：

// 分配给该批处理的请求数量……
$batch->totalRequests;

// 尚未处理的请求数量……
$batch->pendingRequests;

// 已失败的请求数量……
$batch->failedRequests;

// 到目前为止已处理的请求数量……
$batch->processedRequests();

// 指示批处理是否已执行完毕……
$batch->finished();

// 指示批处理是否存在请求失败的情况……
$batch->hasFailures();

延迟批处理

当调用 defer 方法时，请求批处理不会立即执行。相反，Laravel 会在当前应用请求的 HTTP 响应发送给用户之后执行该批处理，让应用保持快速且响应灵敏的体验：

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) {
    // 所有请求均已成功完成……
})->defer();

宏

Laravel HTTP 客户端允许你定义“宏”，这可以作为一种流畅、直观的机制，用于在整个应用与服务交互时配置常用的请求路径和请求头。开始使用前，你可以在应用的 App\Providers\AppServiceProvider 类的 boot 方法中定义该宏：

use Illuminate\Support\Facades\Http;

/**
 * 启动任意应用服务。
 */
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 门面的 fake 方法允许你指示 HTTP 客户端在发起请求时返回模拟/虚拟响应。

模拟响应

例如，要指示 HTTP 客户端为每个请求返回空的、状态码为 200 的响应，可以不传递任何参数调用 fake 方法：

use Illuminate\Support\Facades\Http;

Http::fake();

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

模拟指定 URL

此外，你也可以向 fake 方法传递一个数组。数组的键应为你想要模拟的 URL 模式，对应的值则是关联的响应。* 字符可用作通配符。你可以使用 Http 门面的 response 方法为这些端点构建桩/模拟响应：

Http::fake([
    // 为 GitHub 端点模拟 JSON 响应……
    'github.com/*' => Http::response(['foo' => 'bar'], 200, $headers),

    // 为 Google 端点模拟字符串响应……
    'google.com/*' => Http::response('Hello World', 200, $headers),
]);

对未被伪造的 URL 发起的任何请求都会被实际执行。如果你想指定一个回退 URL 模式，用于对所有未匹配的 URL 进行桩处理，可以使用单个 * 字符：

Http::fake([
    // 为 GitHub 端点桩一个 JSON 响应...
    'github.com/*' => Http::response(['foo' => 'bar'], 200, ['Headers']),

    // 为所有其他端点桩一个字符串响应...
    '*' => 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(),
]);

若要测试当抛出 Illuminate\Http\Client\RequestException 时应用程序的行为，可以使用 failedRequest 方法：

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

伪造响应序列

有时，你可能需要指定某个 URL 应按特定顺序返回一系列伪造响应。你可以使用 Http::sequence 方法来构建这些响应，从而实现这一点：

Http::fake([
    // 为 GitHub 端点桩一系列响应...
    'github.com/*' => Http::sequence()
        ->push('Hello World', 200)
        ->push(['foo' => 'bar'], 200)
        ->pushStatus(404),
]);

当响应序列中的所有响应都被使用完毕后，任何后续请求都会导致该响应序列抛出异常。如果你想指定当序列为空时应返回的默认响应，可以使用 whenEmpty 方法：

Http::fake([
    // 为 GitHub 端点桩一系列响应...
    '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::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.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 的实例，可用于根据你期望的条件过滤请求 / 响应对：

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 请求：

use Illuminate\Support\Facades\Http;

Http::preventStrayRequests();

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

// 返回 "ok" 响应...
Http::get('https://github.com/laravel/framework');

// 抛出异常...
Http::get('https://laravel.com');

有时，你可能希望阻止大部分多余请求，同时仍允许特定的请求执行。为此，你可以将一组 URL 模式传递给 allowStrayRequests 方法。任何匹配给定模式之一的请求都会被允许，而所有其他请求仍会抛出异常：

use Illuminate\Support\Facades\Http;

Http::preventStrayRequests();

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

// 此请求会被执行...
Http::get('http://127.0.0.1:5000/generate');

// 抛出异常...
Http::get('https://laravel.com');

事件

Laravel 在发送 HTTP 请求的过程中会触发三个事件。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
{
    /**
     * 处理事件。
     */
    public function handle(RequestSending $event): void
    {
        // $event->request ...
    }
}