HTTP 客户端
介绍
Laravel 提供了一个简洁、最小的 API,围绕 Guzzle HTTP 客户端,允许您快速发起 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' => '网络管理员',
]);
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' => '隐私顾问',
]);
发送原始请求体
如果您希望在发起请求时提供原始请求体,可以使用 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(/* ... */);
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(/* ... */);
如果所有请求因连接问题而失败,即使将 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);
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) {
// 将请求异常消息截断为 240 个字符...
$exceptions->truncateRequestExceptionsAt(240);
// 禁用请求异常消息截断...
$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', '示例应用程序/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
方法不能与其他 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;
/**
* 启动任何应用程序服务。
*/
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([
// 为 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
时的行为。您可以指示 HTTP 客户端在伪造连接异常时使用 failedConnection
方法:
Http::fake([
'github.com/*' => Http::failedConnection(),
]);
伪造响应序列
有时,您可能需要指定单个 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 客户端发送的所有请求在单个测试或完整测试套件中都已被伪造,您可以调用 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');
检查请求
在伪造响应时,您可能偶尔希望检查客户端接收到的请求,以确保您的应用程序发送了正确的数据或头部。您可以通过在调用 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();
});
事件
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 ...
}
}