README

该扩展基于Laravel的illuminate/http扩展进行简化独立而得，核心源码更多为官方源码。

安装

composer require flc\http

非稳定版，请勿用于生产

使用

使用文档，拷贝官方的，:sweat_smile: :sweat_smile

创建请求

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

<?php

use Flc\Http\Client;

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

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

<?php

$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;

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

<?php

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

请求数据

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

<?php

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

发送URL编码的请求

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

<?php

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

发送Multipart请求

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

<?php

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

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

<?php

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

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

请求头

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

<?php

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

认证

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

<?php

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

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

Bearer Token（Token令牌）

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

<?php

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

重试

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

<?php

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

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

错误处理

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

<?php

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

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

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

抛出异常

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

<?php

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

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

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

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

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

<?php

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

LICENSE

MIT

flc / http

维护者

详细信息