HTTP 客户端

简介
发起请求
并发请求
- 请求池
- 请求批处理
宏
测试
事件

简介

Laravel 围绕 Guzzle HTTP 客户端提供了一个富有表现力、极简的 API，允许您快速发出传出 HTTP 请求以与其他 Web 应用程序通信。Laravel 对 Guzzle 的封装专注于其最常见的用例和出色的开发人员体验。

发起请求

要发起请求，您可以使用 Http 门面提供的 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}');

转储请求

如果您想在发送传出请求实例之前转储它并终止脚本的执行，可以在请求定义的开头添加 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

// 基本身份验证...
$response = Http::withBasicAuth('taylor@laravel.com', 'secret')->post(/* ... */);

// 摘要身份验证...
$response = Http::withDigestAuth('taylor@laravel.com', 'secret')->post(/* ... */);

Bearer 令牌

如果您想快速向请求的 Authorization 头添加 bearer 令牌，可以使用 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 方法传递第三个参数。第三个参数应该是确定是否应实际尝试重试的可调用对象。例如，您可能希望仅在初始请求遇到 ConnectionException 时重试请求：

php

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

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

如果请求尝试失败，您可能希望在进行新尝试之前更改请求。您可以通过修改传递给您提供给 retry 方法的可调用对象的请求参数来实现这一点。例如，如果第一次尝试返回身份验证错误，您可能希望使用新的授权令牌重试请求：

php

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 参数。禁用后，在尝试所有重试后，将返回客户端收到的最后一个响应：

php

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

WARNING

如果所有请求都因连接问题而失败，即使 throw 参数设置为 false，仍会抛出 Illuminate\Http\Client\ConnectionException。

错误处理

与 Guzzle 的默认行为不同，Laravel 的 HTTP 客户端封装不会在客户端或服务器错误（服务器返回的 400 和 500 级响应）时抛出异常。您可以使用 successful、clientError 或 serverError 方法确定是否返回了这些错误之一：

php

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

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

// 确定响应是否具有 400 级状态码...
$response->clientError();

// 确定响应是否具有 500 级状态码...
$response->serverError();

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

抛出异常

如果您有响应实例，并且想在响应状态码指示客户端或服务器错误时抛出 Illuminate\Http\Client\RequestException 实例，可以使用 throw 或 throwIf 方法：

php

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

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 {
    // 将请求异常消息截断为 240 个字符...
    RequestException::truncateAt(240);

    // 禁用请求异常消息截断...
    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 方法接受键/值对数组：

php

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

全局选项

要为每个传出请求配置默认选项，您可以使用 globalOptions 方法。通常，此方法应从应用程序的 AppServiceProvider 的 boot 方法调用：

php

use Illuminate\Support\Facades\Http;

/**
 * 引导任何应用程序服务。
 */
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;

$responses = Http::pool(fn (Pool $pool) => [
    $pool->withHeaders([
        'X-Header' => 'Value',
    ])->get('http://localhost/first'),

    $pool->withHeaders([
        'X-Header' => 'Value',
    ])->get('http://localhost/second'),

    $pool->withHeaders([
        'X-Header' => 'Value',
    ])->get('http://localhost/third'),
]);

请求批处理

如果您想发送一批请求并希望一次性对整个批次的响应执行操作，batch 方法提供了一种方便的方式来实现这一点：

php

use Illuminate\Support\Facades\Http;

[$first, $second, $third] = Http::batch([
    Http::get('http://localhost/first'),
    Http::get('http://localhost/second'),
    Http::get('http://localhost/third'),
]);

与 pool 方法一样，batch 方法也接受 concurrency 参数：

php

[$first, $second, $third] = Http::batch([
    Http::get('http://localhost/first'),
    Http::get('http://localhost/second'),
    Http::get('http://localhost/third'),
], concurrency: 5);

宏

Laravel HTTP 客户端允许您定义"宏"，作为流畅、表达力强的方式与 API 路由交互时重用常见请求选项。要开始，您可以在应用程序的 AppServiceProvider 的 boot 方法中定义宏：

php

use Illuminate\Support\Facades\Http;

/**
 * 引导任何应用程序服务。
 */
public function boot(): void
{
    Http::macro('github', function () {
        return Http::withHeaders([
            'X-GitHub-Api-Version' => '2022-11-28',
            'Accept' => 'application/vnd.github.v3+json',
        ])->withToken(config('services.github.token'));
    });
}

定义宏后，您可以从应用程序的任何位置调用它，以使用指定配置创建待处理请求：

php

$response = Http::github()->get('https://api.github.com/user/repos');

测试

许多 Laravel 服务提供了帮助您轻松编写测试的功能，Laravel 的 HTTP 客户端也不例外。Http 门面的 fake 方法允许您指示 HTTP 客户端在发起请求时返回存根/虚拟响应。

伪造响应

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

php

use Illuminate\Support\Facades\Http;

Http::fake();

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

伪造特定 URL

或者，您可以将数组传递给 fake 方法。数组应包含您希望伪造的 URL 模式和每个 URL 应返回的响应。* 字符可用作通配符：

php

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

    // 为 Google 端点存根字符串响应...
    'google.com/*' => Http::response('Hello World', 200),

    // 为其他端点存根 500 响应...
    '*' => Http::response('Not Found', 404),
]);

如果您没有为请求的 URL 指定响应模式，将使用默认的空 200 状态码响应。

伪造响应序列

有时您可能需要指定单个 URL 应按特定顺序返回一系列响应。您可以使用 Http::sequence 方法来实现这一点：

php

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

当响应序列中的所有响应都已消耗完，对 URL 的任何进一步请求将导致响应序列异常。如果您想指定在序列为空时应返回的默认响应，可以使用 whenEmpty 方法：

php

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

如果您想伪造 URL 序列但不需要指定应伪造的特定 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);
});

防止游离请求

如果您想确保通过 HTTP 客户端发出的所有请求在您的单个测试或完整测试套件中都被伪造，可以调用 preventStrayRequests 方法。调用此方法后，任何没有对应伪造响应的请求将抛出异常，而不是发起实际的 HTTP 请求：

php

use Illuminate\Support\Facades\Http;

Http::preventStrayRequests();

Http::fake([
    'laravel.com/*' => Http::response('Hello World', 200),
]);

// 正常返回伪造响应...
Http::get('https://laravel.com');

// 抛出异常，因为没有为此 URL 设置伪造...
Http::get('https://example.com');

检查请求

在伪造响应时，有时您可能希望检查客户端收到的请求，以确保应用程序发送了正确的数据或头。您可以通过在调用 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/users';
});

如果您想断言请求是"按顺序"发送的，可以使用 assertSentInOrder 方法：

php

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

Http::fake();

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

Http::post('http://example.com/users/2', ['name' => 'Abigail']);

Http::assertSentInOrder([
    function (Request $request) {
        return $request->url() === 'http://example.com/users/1' &&
               $request['name'] === 'Taylor';
    },
    function (Request $request) {
        return $request->url() === 'http://example.com/users/2' &&
               $request['name'] === 'Abigail';
    },
]);

您可以使用 assertNothingSent 方法断言测试期间没有发送任何请求：

php

Http::fake();

Http::assertNothingSent();

如果您需要检查发出的请求但需要自定义请求断言逻辑，可以使用 assertSentCount 方法：

php

Http::fake();

Http::assertSentCount(5);

事件

Laravel 在发起 HTTP 请求时触发三个事件。RequestSending 事件在请求发送之前触发，而 ResponseReceived 事件在收到给定请求的响应后触发。如果未收到成功请求的响应，则触发 ConnectionFailed 事件。

RequestSending 和 ConnectionFailed 事件都包含公共 $request 属性，您可以使用它来检查 Illuminate\Http\Client\Request 实例。ResponseReceived 事件包含公共 $request 属性和公共 $response 属性，您可以使用它们来检查 Illuminate\Http\Client\Request 和 Illuminate\Http\Client\Response 实例。您可以在应用程序中为这些事件创建事件监听器：

php

use Illuminate\Http\Client\Events\RequestSending;

class LogRequest
{
    /**
     * 处理给定的事件。
     */
    public function handle(RequestSending $event): void
    {
        // $event->request ...
    }
}

HTTP 客户端 ​

简介 ​

发起请求 ​

URI 模板 ​

转储请求 ​

请求数据 ​

GET 请求查询参数 ​

发送表单 URL 编码请求 ​

发送原始请求体 ​

多部分请求 ​

请求头 ​

身份验证 ​

Bearer 令牌 ​

超时 ​

重试 ​

错误处理 ​

抛出异常 ​

Guzzle 中间件 ​

全局中间件 ​

Guzzle 选项 ​

全局选项 ​

并发请求 ​

请求池 ​

自定义并发请求 ​

请求批处理 ​

宏 ​

测试 ​

伪造响应 ​

伪造特定 URL ​

伪造响应序列 ​

伪造回调 ​

防止游离请求 ​

检查请求 ​

事件 ​