HTTP 客户端

• 简介
• 创建请求
  • 请求数据
  • 请求头
  • 认证
  • 超时
  • 重试
  • 错误处理
  • Guzzle 选项
• 测试
  • 模拟响应
  • 注入请求

简介

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

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

composer require guzzlehttp/guzzle

创建请求

你可以使用 Http Facade 提供的 get、post、put、patch 以及 delete 方法来创建请求。首先，让我们先看一下如何发出一个基础的 GET 请求：

use Illuminate\Support\Facades\Http;

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

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

$response->body() : string;
$response->json() : array|mixed;
$response->collect() : Illuminate\Support\Collection;
$response->status() : int;
$response->ok() : bool;
$response->successful() : bool;
$response->failed() : 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://example.com/users/1')['name'];

请求数据

大多数情况下，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',
]);

发送原始数据（Raw）请求

如果你想使用一个原始请求体发送请求，你可以在创建请求前调用 withBody 方法。你还可以将数据类型作为第二个参数传递给 withBody 方法：

$response = Http::withBody(
    base64_encode($photo), 'image/jpeg'
)->post('http://example.com/photo');

Multi-part 请求

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

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

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

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

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

请求头

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

$response = Http::withHeaders([
    'X-First' => 'foo',
    'X-Second' => 'bar'
])->post('http://example.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 令牌

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

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

超时

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

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

如果响应时间超过了指定的超时时间，将会抛出 Illuminate\Http\Client\ConnectionException 异常。

重试

如果你希望 HTTP 客户端在发生客户端或服务端错误时自动进行重试，你可以使用 retry 方法。该方法接受两个参数：重新尝试次数以及重试间隔（毫秒）：

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

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

错误处理

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

// 如果状态码在 200 - 300之间
$response->successful();

// 如果状态码 大于 400
$response->failed();

// 如果状态码是 400 层级的错误（401，402，403，404……）
$response->clientError();

// 如果状态码是 500 层级的错误
$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();

如果你希望在抛出异常前进行一些操作，你可以向 throw 方法传递一个闭包。异常将会在闭包执行完成后自动抛出，你不必在闭包内手动抛出异常：

return Http::post(...)->throw(function ($response, $e) {
    //
})->json();

Guzzle 选项

你可以使用 withOptions 方法来指定额外的 Guzzle 请求配置。withOptions 方法接受数组形式的键值对：

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

测试

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

模拟响应

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

use Illuminate\Support\Facades\Http;

Http::fake();

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

注意：在模拟响应时，HTTP 客户端的中间件并不会被执行。你应该在 fake 方法里直接返回被中间件处理过后的真实数据。

模拟指定地址的响应

另外，你也可以向 fake 方法传递一个数组。该数组应该包含你希望进行模拟其响应的 URL 正则以及其对应的响应。你可以在 URL 正则中使用通配符 *。
未包含在内的 URL 的请求将照常执行。你可以使用 Http Facade 的 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 正则来匹配所有未被匹配的 URL，你可以使用单一的 * 通配符：

Http::fake([
    // 模拟发往 github.com 的请求的 JSON 响应
    'github.com/*' => Http::response(['foo' => 'bar'], 200, ['Headers']),

    // 模拟发往其他网站的请求的字符串响应
    '*' => Http::response('Hello World', 200, ['Headers']),
]);

伪造响应队列

有些时候，你可以需要指定一个 URL 返回特定顺序的一系列响应。你可以使用 Http::sequence 方法来构建响应：

Http::fake([
    // 模拟发往 github.com 的请求的一系列响应
    '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 实例，并应该返回一个布尔值来代表该响应是否符合你的期望。为了使测试通过，必须至少发出一个与给定期望相符的请求：

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

或者，你也可以使用 assertNothingSent 方法断言空的请求：

Http::fake();

Http::assertNothingSent();