HTTP 客户端

• 简介
• 发送请求
  • 请求数据
  • 标头
  • 身份验证
  • 超时
  • 重试
  • 错误处理
  • Guzzle 中间件
  • Guzzle 选项
• 并发请求
• 宏
• 测试
  • 伪造响应
  • 检查请求
  • 防止意外请求
• 事件

简介

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) : 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.net.cn',
    '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 内容类型发送数据，你应在发出请求之前调用 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 令牌

如果你想快速将 Bearer 令牌添加到请求的 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 方法。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 方法的可调用对象的请求参数来实现此目的。例如，如果第一次尝试返回身份验证错误，你可能希望使用新的授权令牌重试请求

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

错误处理

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

默认情况下，RequestException 消息在记录或报告时会被截断为 120 个字符。要自定义或禁用此行为，你可以在 bootstrap/app.php 文件中配置应用程序的异常处理行为时，使用 truncateRequestExceptionsAt 和 dontTruncateRequestExceptions 方法

->withExceptions(function (Exceptions $exceptions) {
    // Truncate request exception messages to 240 characters...
    $exceptions->truncateRequestExceptionsAt(240);
 
    // Disable request exception message truncation...
    $exceptions->dontTruncateRequestExceptions();
})

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 实例，使您可以轻松地将请求添加到请求池中进行分派。

use Illuminate\Http\Client\Pool;
use Illuminate\Support\Facades\Http;
 
$responses = Http::pool(fn (Pool $pool) => [
    $pool->get('https://127.0.0.1/first'),
    $pool->get('https://127.0.0.1/second'),
    $pool->get('https://127.0.0.1/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('https://127.0.0.1/first'),
    $pool->as('second')->get('https://127.0.0.1/second'),
    $pool->as('third')->get('https://127.0.0.1/third'),
]);
 
return $responses['first']->ok();

自定义并发请求

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 HTTP 客户端允许您定义“宏”，它可以作为一种流畅、表达性的机制，在整个应用程序中与服务交互时配置常见的请求路径和标头。要开始使用，您可以在应用程序的 App\Providers\AppServiceProvider 类的 boot 方法中定义宏。

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

测试

许多 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([
    // 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']),
]);

为方便起见，可以通过提供字符串、数组或整数作为响应来生成简单的字符串、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(),
]);

模拟响应序列

有时，您可能需要指定单个 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.net.cn');

检查请求

在模拟响应时，您有时可能希望检查客户端接收到的请求，以确保您的应用程序正在发送正确的数据或标头。您可以通过在调用 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.net.cn' => Http::response(status: 500),
    'https://nova.laravel.net.cn/' => Http::response(),
]);
 
Http::get('https://laravel.net.cn');
Http::get('https://nova.laravel.net.cn/');
 
$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.net.cn' => Http::response(status: 500),
    'https://nova.laravel.net.cn/' => Http::response(),
]);
 
Http::get('https://laravel.net.cn');
Http::get('https://nova.laravel.net.cn/');
 
$recorded = Http::recorded(function (Request $request, Response $response) {
    return $request->url() !== 'https://laravel.net.cn' &&
           $response->successful();
});

事件

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