HTTP Client

• 简介
• 创建请求
  • 请求数据
  • 请求头
  • 认证
  • 重试
  • 错误处理
• 测试
  • 模拟响应
  • 检查请求

简介

Laravel 为 Guzzle HTTP 客户端 提供了一种语义化且轻量的 API，让你可以快速地使用 HTTP 请求与其他 Web 应用进行通信。该 API 专注于其在常见用例中的快速实现以及良好的开发者体验。

在开始之前，你需要确保你的项目已经安装 Guzzle 包作为依赖项。默认情况下，Laravel 已经包含了 Guzzle 包。你也可以通过 Composer 手动安装：

composer require guzzlehttp/guzzle

创建请求

你可以通过 get、 post、 put、 patch 和 delete 方法来创建请求。首先，让我们先看一下如何发出一个基础的 GET 请求：

use Illuminate\Support\Facades\Http;

$response = Http::get('http://test.com');

get 方法返回一个 Illuminate\Http\Client\Response 的实例，该实例提供了大量的方法来检查请求的响应：

$response->body() : string;
$response->json() : array;
$response->status() : int;
$response->ok() : bool;
$response->successful() : bool;
$response->serverError() : bool;
$response->clientError() : bool;
$response->header($header) : string;
$response->headers() : array;

Illuminate\Http\Client\Response 对象同样实现了 PHP 的 ArrayAccess 接口，这代表着你可以直接访问响应的 JSON 数据。

return Http::get('http://test.com/users/1')['name'];

请求数据

大多数情况下，POST、 PUT 和 PATCH 携带着额外的请求数据是相当常见的。所以，这些方法的第二个参数接受一个包含着请求数据的数组。默认情况下，这些数据会使用 application/json 类型随请求发送。

$response = Http::post('http://test.com/users', [
    'name' => 'Steve',
    'role' => 'Network Administrator',
]);

发送 URL 编码的请求

如果你希望使用 application/x-www-form-urlencoded 作为请求的数据类型，你可以在创建请求前调用 asForm 方法：

$response = Http::asForm()->post('http://test.com/users', [
    'name' => 'Sara',
    'role' => 'Privacy Consultant',
]);

发送 Multipart 请求

如果你希望将文件作为 Multipart 请求发送，你应该在创建请求前调用 attach 方法。该方法接受文件的标识符（相当于 HTML Input 的 name 属性）以及其内容。你也可以在第三个参数传入自定义的文件名称，这不是必须的。

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

除了传递文件的原始内容，你也可以传递 Stream 流数据：

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

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

请求头

你可以通过 withHeaders 方法添加请求头。该方法接受一个数组格式的键值对。

$response = Http::withHeaders([
    'X-First' => 'foo',
    'X-Second' => 'bar'
])->post('http://test.com/users', [
    'name' => 'Taylor',
]);

认证

你可以使用 withBasicAuth 和 withDigestAuth 方法来分别指定使用 basic 或是 digest 认证方式：

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

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

Bearer Token（Token 令牌）

如果你想要为你的请求快速添加 Authorization Token 令牌请求头，你可以使用 withToken 方法：

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

重试

如果你希望你的 HTTP 客户端在发生错误时自动重新发送请求，你可以使用 retry 方法。该方法接受两个参数：重新尝试次数以及重试等待时间（毫秒）：

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

如果所有的请求都失败了，Illuminate\Http\Client\RequestException 异常将会被抛出。

错误处理

跟 Guzzle 的默认行为不同，Laravel HTTP 客户端并不会在客户端或服务端错误时抛出异常（400 及 500 状态码）。你可以通过 successful、 clientError 或是 serverError 方法来判断是否发生错误：

// 确认状态码是否在 200 到 300 之间（包含 200）
$response->successful();

// 确认是否发生了 400 级别的错误（以 4 开头的状态码）
$response->clientError();

// 确认是否发生了 500 级别的错误（以 5 开头的状态码）
$response->serverError();

抛出异常

如果你希望请求在发生客户端或服务端错误时抛出 Illuminate\Http\Client\RequestException 异常，你可以在请求实例上调用 throw 方法：

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

// 在客户端或服务端错误发生时抛出异常
$response->throw();

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

Illuminate\Http\Client\RequestException 实例拥有一个 $response 公共属性，该属性允许你检查返回的响应。

如果没有发生错误，throw 方法将返回响应实例，你可以在其上进行其他操作：

return Http::post(...)->throw()->json();

测试

许多 Laravel 服务都可以让你非常简单且语义化地编写测试，Laravel HTTP 客户端也不例外。Http Facade 的 Fake 方法允许你让 HTTP 客户端在请求创建时返回虚拟的响应。

虚拟响应

如果你希望 HTTP 客户端为每个请求返回空的 200 响应，你可以不带任何参数地调用 fake 方法：

use Illuminate\Support\Facades\Http;

Http::fake();

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

为特定地址作虚拟响应

另外，你也可以将你希望伪造的 URL 正则以及相应的响应传递给 fake 方法。支持 * 作为通配符。未包含在内的 URL 的请求将照常执行。你可以使用 response 方法为这些请求伪造虚拟响应。

Http::fake([
    // 伪造 Github.com 的虚拟响应（JSON 格式）
    'github.com/*' => Http::response(['foo' => 'bar'], 200, ['Headers']),

    // 伪造 Google.com 的虚拟响应（纯文本格式）
    'google.com/*' => Http::response('Hello World', 200, ['Headers']),
]);

如果你希望指定一个备用 URL 来为所有未有匹配的请求伪造请求，请使用单一的 * 字符：

Http::fake([
    // 伪造 Github.com 的虚拟响应（JSON 格式）
    'github.com/*' => Http::response(['foo' => 'bar'], 200, ['Headers']),

    // 伪造其他所有请求的虚拟响应（纯文本格式）
    '*' => Http::response('Hello World', 200, ['Headers']),
]);

伪造响应序列

有些时候，我们需要一个请求返回特定顺序的一系列响应。你可以使用 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([
    // 伪造 Github.com 的一系列响应
    '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 实例，并应当返回一个响应实例：

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

检查请求

在伪造响应时，你可能希望检查客户端收到的请求，以确保你的应用发送了正确的数据或请求头。你可以在调用 Http::fake 方法后调用 Http::assertSent 来完成该操作。

assertSent 方法接受一个回调，该回调将接受一个 Illuminate\Http\Client\Request 实例，并返回一个布尔值。该值用于确认该响应是否符合你的期望。为了使测试通过，必须至少发出一个与给定期望相符的请求：

Http::fake();

Http::withHeaders([
    'X-First' => 'foo',
])->post('http://test.com/users', [
    'name' => 'Taylor',
    'role' => 'Developer',
]);

Http::assertSent(function ($request) {
    return $request->hasHeader('X-First', 'foo') &&
           $request->url() == 'http://test.com/users' &&
           $request['name'] == 'Taylor' &&
           $request['role'] == 'Developer';
});