客户端

• Introduction
• 发出请求
  • 请求数据
  • Headers
  • Authentication
  • Timeout
  • Retries
  • 错误处理
  • Guzzle 中间件
  • 枪口选项
• 并发请求
• Macros
• Testing
  • 伪造回应
  • 检查请求
  • 防止杂散请求
• Events

#Introduction

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

在开始之前，您应该确保已将 Guzzle 包安装为应用程序的依赖项。默认情况下，Laravel 会自动包含此依赖项。但是，如果您之前删除了该软件包，则可以通过 Composer 重新安装它：

composer require guzzlehttp/guzzle

#发出请求

要发出请求，您可以使用head,get,post,put,patch， 和delete 提供的方法Http 正面。首先，让我们来看看如何制作一个基本的GET 请求另一个 URL：

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) : array|mixed;
$response->object() : object;
$response->collect($key = null) : Illuminate\Support\Collection;
$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 对象还实现了 PHPArrayAccess 接口，允许您直接在响应上访问 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 模板规范.要定义可由 URI 模板扩展的 URL 参数，您可以使用withUrlParameters 方法：

Http::withUrlParameters([
    'endpoint' => 'https://laravel.com',
    'page' => 'docs',
    'version' => '9.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,
]);

发送表单 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'
)->post('http://example.com/attachments');

您可以传递流资源，而不是传递文件的原始内容：

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

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

#Headers

标头可以添加到请求使用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');

#Authentication

您可以使用指定基本和摘要身份验证凭据withBasicAuth 和withDigestAuth 方法分别为：

// Basic authentication...
$response = Http::withBasicAuth('taylor@laravel.com', 'secret')->post(/* ... */);

// Digest authentication...
$response = Http::withDigestAuth('taylor@laravel.com', 'secret')->post(/* ... */);

不记名代币

如果您想快速将不记名令牌添加到请求的Authorization 标头，您可以使用withToken 方法：

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

#Timeout

这timeout 方法可用于指定等待响应的最大秒数：

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

如果超过给定的超时，则实例Illuminate\Http\Client\ConnectionException 将被抛出。

您可以指定尝试使用连接到服务器时等待的最大秒数connectTimeout 方法：

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

#Retries

如果您希望 HTTP 客户端在发生客户端或服务器错误时自动重试请求，您可以使用retry方法。这retry 方法接受应尝试请求的最大次数以及 Laravel 在两次尝试之间应等待的毫秒数：

$response = Http::retry(3, 100)->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 方法。例如，如果第一次尝试返回身份验证错误，您可能希望使用新的授权令牌重试请求：

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

$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 将被抛出。如果您想禁用此行为，您可以提供throw 参数值为false.禁用时，将在尝试所有重试后返回客户端收到的最后一个响应：

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

Warning
如果所有请求都因连接问题而失败，则Illuminate\Http\Client\ConnectionException 即使在throw 参数设置为false.

#错误处理

与 Guzzle 的默认行为不同，Laravel 的 HTTP 客户端包装器不会在客户端或服务器错误时抛出异常（400 和500 服务器的水平响应）。您可以使用successful,clientError， 或者serverError 方法：

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

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

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 中间件 操纵传出请求或检查传入响应。要操纵传出请求，请通过以下方式注册 Guzzle 中间件withMiddleware 结合 Guzzle 的方法mapRequest 中间件工厂：

use GuzzleHttp\Middleware;
use Illuminate\Support\Facades\Http;
use Psr\Http\Message\RequestInterface;

$response = Http::withMiddleware(
    Middleware::mapRequest(function (RequestInterface $request) {
        $request = $request->withHeader('X-Example', 'Value');
        
        return $request;
    })
)->get('http://example.com');

同样，您可以通过注册一个中间件来检查传入的 HTTP 响应withMiddleware 结合 Guzzle 的方法mapResponse 中间件工厂：

use GuzzleHttp\Middleware;
use Illuminate\Support\Facades\Http;
use Psr\Http\Message\ResponseInterface;

$response = Http::withMiddleware(
    Middleware::mapResponse(function (ResponseInterface $response) {
        $header = $response->getHeader('X-Example');

        // ...
        
        return $response;
    })
)->get('http://example.com');

#枪口选项

您可以指定额外的Guzzle 请求选项 使用withOptions 方法。这withOptions 方法接受一组键/值对：

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

#并发请求

有时，您可能希望同时发出多个 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();

#Macros

Laravel HTTP 客户端允许您定义“宏”，它可以作为一种流畅的、富有表现力的机制来在整个应用程序中与服务交互时配置常见的请求路径和标头。首先，您可以在boot 你的应用程序的方法App\Providers\AppServiceProvider 班级：

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

配置宏后，您可以从应用程序的任何位置调用它来创建具有指定配置的挂起请求：

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

#Testing

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

#伪造回应

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

use Illuminate\Support\Facades\Http;

Http::fake();

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

伪造特定网址

或者，您可以将一个数组传递给fake 方法。该数组的键应该表示您希望伪造的 URL 模式及其相关响应。这* 字符可以用作通配符。对未伪造的 URL 发出的任何请求都将实际执行。您可以使用Http 门面的response 为这些端点构造存根/假响应的方法：

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，您可以使用单个* 特点：

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([
    // Stub a series of responses for GitHub endpoints...
    '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 方法。这个闭包将接收一个实例Illuminate\Http\Client\Request 并且应该返回一个响应实例。在你的闭包中，你可以执行任何必要的逻辑来确定返回什么类型的响应：

use Illuminate\Http\Client\Request;

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

#防止杂散请求

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

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

#检查请求

伪造响应时，您可能偶尔希望检查客户端收到的请求，以确保您的应用程序发送正确的数据或标头。您可以通过调用Http::assertSent 调用后的方法Http::fake.

这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();
});

#Events

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

这RequestSending 和ConnectionFailed 事件都包含一个公共$request 您可以用来检查的财产Illuminate\Http\Client\Request 实例。同样，ResponseReceived 事件包含一个$request 财产以及$response 可用于检查的财产Illuminate\Http\Client\Response 实例。您可以在您的App\Providers\EventServiceProvider 服务提供者：

/**
 * The event listener mappings for the application.
 *
 * @var array
 */
protected $listen = [
    'Illuminate\Http\Client\Events\RequestSending' => [
        'App\Listeners\LogRequestSending',
    ],
    'Illuminate\Http\Client\Events\ResponseReceived' => [
        'App\Listeners\LogResponseReceived',
    ],
    'Illuminate\Http\Client\Events\ConnectionFailed' => [
        'App\Listeners\LogConnectionFailed',
    ],
];