HTTP 客户端

• 介绍
• 发出请求
  • 请求数据
  • 请求头
  • 认证
  • 超时
  • 重试
  • 错误处理
  • Guzzle 中间件
  • Guzzle 选项
• 并发请求
• Macros
• 测试
  • 伪造响应
  • 防止 Stray 请求
  • 检查请求
• 事件

介绍

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

发出请求

要发出请求，你可以使用 Http facade提供的 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.com',
    '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 content 类型发送数据，则应在发出请求之前调用 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 方法指定基本和摘要式身份验证凭证:

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

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

不记名令牌

如果您想快速将不记名令牌添加到请求的 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 方法。重试方法接受应尝试请求的最大次数以及 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 方法的可调用对象提供的 request 参数来实现此目的。例如，如果第一次尝试返回身份验证错误，您可能希望使用新的授权令牌重试请求:

    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(/* ... */);

WARNING

如果所有请求都因连接问题而失败，则即使 throw 参数设置为 false，仍会引发 a 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();

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

    // 如果发生错误并且给定的闭包解析为 true...
    $response->throwIf(fn (Response $response) => true);

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

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

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

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

    return $response['user']['id'];

该 Illuminate\Http\Client\RequestException 实例具有 public $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();

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 实例，允许你轻松地将请求添加到请求池中以进行 dispatch:

    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 或中间件方法）链接。如果要将自定义标头或中间件应用于池化请求，则应在池中的每个请求上配置这些选项:

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'),
]);

Macros

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 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([
        // 为 GitHub 端点存根 JSON 响应...
        'github.com/*' => Http::response(['foo' => 'bar'], 200, $headers),

        //  对 Google 端点进行存根字符串响应...
        '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']),
    ]);

伪造响应序列

有时，您可能需要指定单个 URL 应按特定顺序返回一系列虚假响应。你可以使用 Http::sequence 方法来构建响应来完成此操作:

    Http::fake([
        // 对 GitHub 端点的一系列响应进行存根...
        '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 回调

如果您需要更复杂的逻辑来确定为某些端点返回哪些响应，则可以将闭包传递给 fake 方法。此 closure 将接收 Illuminate\Http\Client\Request 的实例，并应返回 response 实例。在你的闭包中，你可以执行任何必要的逻辑来确定要返回什么类型的响应:

    use Illuminate\Http\Client\Request;

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

防止 Stray 请求

如果要确保通过 HTTP 客户端发送的所有请求在整个单个测试或完整测试套件中都是伪造的，则可以调用 preventStrayRequests 方法。调用该方法后，任何没有对应 fake 响应的请求都会抛出异常，而不是发出实际的 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');

检查请求

在伪造响应时，你可能偶尔希望检查 Client 端收到的请求，以确保你的应用程序发送正确的数据或 Headers。您可以通过在调用 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 and 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();
});

事件

Laravel 在发送 HTTP 请求的过程中触发了三个事件。RequestSending 事件在发送请求之前触发，而 ResponseReceived 事件在收到给定请求的响应后触发。如果未收到给定请求的响应，则会触发 ConnectionFailed 事件。

RequestSending 和 ConnectionFailed 事件都包含可用于检查 Illuminate\Http\Client\Request 实例的公共 $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 ...
        }
    }