HTTP Client

简介

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

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

  1. composer require guzzlehttp/guzzle

创建请求

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

  1. use Illuminate\Support\Facades\Http;
  3. $response = Http::get('http://test.com');

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

  1. $response->body() : string;
  2. $response->json() : array;
  3. $response->status() : int;
  4. $response->ok() : bool;
  5. $response->successful() : bool;
  6. $response->serverError() : bool;
  7. $response->clientError() : bool;
  8. $response->header($header) : string;
  9. $response->headers() : array;

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

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

请求数据

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

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

发送 URL 编码的请求

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

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

发送 Multipart 请求

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

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

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

  1. $photo = fopen('photo.jpg', 'r');
  3. $response = Http::attach(
  4.     'attachment', $photo, 'photo.jpg'
  5. )->post('http://test.com/attachments');

请求头

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

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

认证

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

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

Bearer Token（Token 令牌）

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

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

重试

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

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

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

错误处理

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

  1. // 确认状态码是否在 200 到 300 之间（包含 200）
  2. $response->successful();
  4. // 确认是否发生了 400 级别的错误（以 4 开头的状态码）
  5. $response->clientError();
  7. // 确认是否发生了 500 级别的错误（以 5 开头的状态码）
  8. $response->serverError();

抛出异常

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

  1. $response = Http::post(...);
  3. // 在客户端或服务端错误发生时抛出异常
  4. $response->throw();
  6. return $response['user']['id'];

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

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

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

测试

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

虚拟响应

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

  1. use Illuminate\Support\Facades\Http;
  3. Http::fake();
  5. $response = Http::post(...);

为特定地址作虚拟响应

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

  1. Http::fake([
  2.     // 伪造 Github.com 的虚拟响应（JSON 格式）
  3.     'github.com/*' => Http::response(['foo' => 'bar'], 200, ['Headers']),
  5.     // 伪造 Google.com 的虚拟响应（纯文本格式）
  6.     'google.com/*' => Http::response('Hello World', 200, ['Headers']),
  7. ]);

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

  1. Http::fake([
  2.     // 伪造 Github.com 的虚拟响应（JSON 格式）
  3.     'github.com/*' => Http::response(['foo' => 'bar'], 200, ['Headers']),
  5.     // 伪造其他所有请求的虚拟响应（纯文本格式）
  6.     '*' => Http::response('Hello World', 200, ['Headers']),
  7. ]);

伪造响应序列

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

  1. Http::fake([
  2.     // Stub a series of responses for GitHub endpoints...
  3.     'github.com/*' => Http::sequence()
  4.                             ->push('Hello World', 200)
  5.                             ->push(['foo' => 'bar'], 200)
  6.                             ->pushStatus(404),
  7. ]);

当响应序列中没有有效响应时，将会引发异常。如果你希望在序列为空时返回默认响应，请使用 whenEmpty 方法：

  1. Http::fake([
  2.     // 伪造 Github.com 的一系列响应
  3.     'github.com/*' => Http::sequence()
  4.                             ->push('Hello World', 200)
  5.                             ->push(['foo' => 'bar'], 200)
  6.                             ->whenEmpty(Http::response()),
  7. ]);

如果你希望伪造一个响应序列，但不想指定特定的 URL 正则，你可以使用 Http::fakeSequence 方法：

  1. Http::fakeSequence()
  2.         ->push('Hello World', 200)
  3.         ->whenEmpty(Http::response());

虚拟回调

如果你需要更复杂的逻辑来确定某个请求的响应，你可以将回调传递给 fake 方法。该回调将会接受一个 Illuminate\Http\Client\Request 实例，并应当返回一个响应实例：

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

检查请求

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

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

  1. Http::fake();
  3. Http::withHeaders([
  4.     'X-First' => 'foo',
  5. ])->post('http://test.com/users', [
  6.     'name' => 'Taylor',
  7.     'role' => 'Developer',
  8. ]);
  10. Http::assertSent(function ($request) {
  11.     return $request->hasHeader('X-First', 'foo') &&
  12.            $request->url() == 'http://test.com/users' &&
  13.            $request['name'] == 'Taylor' &&
  14.            $request['role'] == 'Developer';
  15. });

本文章首发在 LearnKu.com 网站上。

本文中的所有译文仅用于学习和交流目的，转载请务必注明文章译者、出处、和本文链接 我们的翻译工作遵照 CC 协议，如果我们的工作有侵犯到您的权益，请及时联系我们。

Laravel China 社区：https://learnku.com/docs/laravel/7.x/http-client/7487