主题
HTTP 客户端
简介
Laravel 围绕 Guzzle HTTP 客户端提供了一个富有表现力的、简洁的 API,让你可以快速发出 HTTP 请求与其他 Web 应用程序进行通信。Laravel 对 Guzzle 的封装专注于其最常见的用例和出色的开发者体验。
发起请求
要发起请求,你可以使用 Http facade 提供的 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 ErrorURI 模板
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();
// 如果发生错误且给定条件为 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 实例有一个公共的 $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;
$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 中处理并发请求的另一种方式是使用 batch 方法。与 pool 方法类似,它接受一个闭包,该闭包接收一个 Illuminate\Http\Client\Batch 实例,允许你轻松地将请求添加到请求池中进行分发,但它还允许你定义完成回调:
php
use Illuminate\Http\Client\Batch;
use Illuminate\Http\Client\ConnectionException;
use Illuminate\Http\Client\RequestException;
use Illuminate\Http\Client\Response;
use Illuminate\Support\Facades\Http;
$responses = Http::batch(fn (Batch $batch) => [
$batch->get('http://localhost/first'),
$batch->get('http://localhost/second'),
$batch->get('http://localhost/third'),
])->before(function (Batch $batch) {
// 批处理已创建但尚未初始化请求...
})->progress(function (Batch $batch, int|string $key, Response $response) {
// 单个请求已成功完成...
})->then(function (Batch $batch, array $results) {
// 所有请求都已成功完成...
})->catch(function (Batch $batch, int|string $key, Response|RequestException|ConnectionException $response) {
// 检测到批处理请求失败...
})->finally(function (Batch $batch, array $results) {
// 批处理已完成执行...
})->send();与 pool 方法类似,你可以使用 as 方法命名你的请求:
php
$responses = Http::batch(fn (Batch $batch) => [
$batch->as('first')->get('http://localhost/first'),
$batch->as('second')->get('http://localhost/second'),
$batch->as('third')->get('http://localhost/third'),
])->send();通过调用 send 方法启动 batch 后,你无法向其添加新请求。尝试这样做将导致抛出 Illuminate\Http\Client\BatchInProgressException 异常。
请求批处理的最大并发数可以通过 concurrency 方法控制。此值决定了在处理请求批处理时可以同时进行的最大 HTTP 请求数:
php
$responses = Http::batch(fn (Batch $batch) => [
// ...
])->concurrency(5)->send();检查批处理
提供给批处理完成回调的 Illuminate\Http\Client\Batch 实例具有多种属性和方法,可帮助你与给定的请求批处理进行交互和检查:
php
// 分配给批处理的请求数...
$batch->totalRequests;
// 尚未处理的请求数...
$batch->pendingRequests;
// 失败的请求数...
$batch->failedRequests;
// 到目前为止已处理的请求数...
$batch->processedRequests();
// 指示批处理是否已完成执行...
$batch->finished();
// 指示批处理是否存在请求失败...
$batch->hasFailures();延迟批处理
调用 defer 方法时,请求批处理不会立即执行。相反,Laravel 将在当前应用程序请求的 HTTP 响应发送给用户后执行批处理,使你的应用程序保持快速响应:
php
use Illuminate\Http\Client\Batch;
use Illuminate\Support\Facades\Http;
$responses = Http::batch(fn (Batch $batch) => [
$batch->get('http://localhost/first'),
$batch->get('http://localhost/second'),
$batch->get('http://localhost/third'),
])->then(function (Batch $batch, array $results) {
// 所有请求都已成功完成...
})->defer();宏
Laravel HTTP 客户端允许你定义「宏」,它可以作为一种流畅、富有表现力的机制,在整个应用程序中与服务交互时配置通用的请求路径和头信息。要开始使用,你可以在应用程序的 App\Providers\AppServiceProvider 类的 boot 方法中定义宏:
php
use Illuminate\Support\Facades\Http;
/**
* 引导任何应用程序服务。
*/
public function boot(): void
{
Http::macro('github', function () {
return Http::withHeaders([
'X-Example' => 'example',
])->baseUrl('https://github.com');
});
}配置宏后,你可以从应用程序中的任何位置调用它,以使用指定的配置创建待处理请求:
php
$response = Http::github()->get('/');测试
许多 Laravel 服务提供了帮助你轻松且富有表现力地编写测试的功能,Laravel 的 HTTP 客户端也不例外。Http facade 的 fake 方法允许你指示 HTTP 客户端在发起请求时返回存根/虚拟响应。
伪造响应
例如,要指示 HTTP 客户端为每个请求返回空的 200 状态码响应,你可以不带参数调用 fake 方法:
php
use Illuminate\Support\Facades\Http;
Http::fake();
$response = Http::post(/* ... */);伪造特定 URL
或者,你可以向 fake 方法传递一个数组。数组的键应该表示你希望伪造的 URL 模式及其关联的响应。* 字符可用作通配符。你可以使用 Http facade 的 response 方法为这些端点构建存根/伪造响应:
php
Http::fake([
// 为 GitHub 端点存根 JSON 响应...
'github.com/*' => Http::response(['foo' => 'bar'], 200, $headers),
// 为 Google 端点存根字符串响应...
'google.com/*' => Http::response('Hello World', 200, $headers),
]);对未被伪造的 URL 发起的任何请求将实际执行。如果你想指定一个回退 URL 模式来存根所有未匹配的 URL,你可以使用单个 * 字符:
php
Http::fake([
// 为 GitHub 端点存根 JSON 响应...
'github.com/*' => Http::response(['foo' => 'bar'], 200, ['Headers']),
// 为所有其他端点存根字符串响应...
'*' => Http::response('Hello World', 200, ['Headers']),
]);为方便起见,可以通过提供字符串、数组或整数作为响应来生成简单的字符串、JSON 和空响应:
php
Http::fake([
'google.com/*' => 'Hello World',
'github.com/*' => ['foo' => 'bar'],
'chatgpt.com/*' => 200,
]);伪造异常
有时你可能需要测试你的应用程序在 HTTP 客户端尝试发起请求时遇到 Illuminate\Http\Client\ConnectionException 的行为。你可以使用 failedConnection 方法指示 HTTP 客户端抛出连接异常:
php
Http::fake([
'github.com/*' => Http::failedConnection(),
]);要测试你的应用程序在抛出 Illuminate\Http\Client\RequestException 时的行为,你可以使用 failedRequest 方法:
php
$this->mock(GithubService::class);
->shouldReceive('getUser')
->andThrow(
Http::failedRequest(['code' => 'not_found'], 404)
);伪造响应序列
有时你可能需要指定单个 URL 应按特定顺序返回一系列伪造响应。你可以使用 Http::sequence 方法来构建响应:
php
Http::fake([
// 为 GitHub 端点存根一系列响应...
'github.com/*' => Http::sequence()
->push('Hello World', 200)
->push(['foo' => 'bar'], 200)
->pushStatus(404),
]);当响应序列中的所有响应都已被消费时,任何后续请求都将导致响应序列抛出异常。如果你想指定序列为空时应返回的默认响应,你可以使用 whenEmpty 方法:
php
Http::fake([
// 为 GitHub 端点存根一系列响应...
'github.com/*' => Http::sequence()
->push('Hello World', 200)
->push(['foo' => 'bar'], 200)
->whenEmpty(Http::response()),
]);如果你想伪造响应序列但不需要指定应该伪造的特定 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::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/posts';
});你可以使用 assertSentCount 方法断言测试期间「发送」了多少个请求:
php
Http::fake();
Http::assertSentCount(5);或者,你可以使用 assertNothingSent 方法断言测试期间没有发送任何请求:
php
Http::fake();
Http::assertNothingSent();记录请求/响应
你可以使用 recorded 方法收集所有请求及其对应的响应。recorded 方法返回一个包含 Illuminate\Http\Client\Request 和 Illuminate\Http\Client\Response 实例的数组集合:
php
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 实例,可用于根据你的期望过滤请求/响应对:
php
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();
});防止游离请求
如果你想确保通过 HTTP 客户端发送的所有请求在整个单独的测试或完整的测试套件中都已被伪造,你可以调用 preventStrayRequests 方法。调用此方法后,任何没有对应伪造响应的请求都将抛出异常,而不是发出实际的 HTTP 请求:
php
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');有时,你可能希望防止大多数游离请求,同时仍允许特定请求执行。为此,你可以向 allowStrayRequests 方法传递 URL 模式数组。任何匹配给定模式之一的请求都将被允许,而所有其他请求将继续抛出异常:
php
use Illuminate\Support\Facades\Http;
Http::preventStrayRequests();
Http::allowStrayRequests([
'http://127.0.0.1:5000/*',
]);
// 此请求被执行...
Http::get('http://127.0.0.1:5000/generate');
// 抛出异常...
Http::get('https://laravel.com');事件
Laravel 在发送 HTTP 请求的过程中触发三个事件。RequestSending 事件在请求发送之前触发,而 ResponseReceived 事件在收到给定请求的响应后触发。ConnectionFailed 事件在没有收到给定请求的响应时触发。
RequestSending 和 ConnectionFailed 事件都包含一个公共的 $request 属性,你可以使用它来检查 Illuminate\Http\Client\Request 实例。同样,ResponseReceived 事件包含一个 $request 属性以及一个 $response 属性,可用于检查 Illuminate\Http\Client\Response 实例。你可以在应用程序中为这些事件创建事件监听器:
php
use Illuminate\Http\Client\Events\RequestSending;
class LogRequest
{
/**
* 处理事件。
*/
public function handle(RequestSending $event): void
{
// $event->request ...
}
}