请求对象

请求对象(Request) 是完全基于 PSR-7 标准实现的，由 hyperf/http-message 组件提供实现支持。

注意 PSR-7 标准为 请求(Request) 进行了 immutable 机制 的设计，所有以 with 开头的方法的返回值都是一个新对象，不会修改原对象的值

安装

该组件完全独立，适用于任何一个框架项目。

  1. composer require hyperf/http-message

如用于其它框架项目则仅支持 PSR-7 提供的 API，具体可直接查阅 PSR-7 的相关规范，该文档所描述的使用方式仅限于使用 Hyperf 时的用法。

获得请求对象

可以通过容器注入 Hyperf\HttpServer\Contract\RequestInterface 获得 对应的 Hyperf\HttpServer\Request，实际注入的对象为一个代理对象，代理的对象为每个请求的 PSR-7 请求对象(Request)，也就意味着仅可在 onRequest 声明周期内可获得此对象，下面是一个获取示例：

  1. declare(strict_types=1);
  3. namespace App\Controller;
  5. use Hyperf\HttpServer\Contract\RequestInterface;
  6. use Hyperf\HttpServer\Annotation\AutoController;
  8. /**
  9.  * @AutoController()
  10.  */
  11. class IndexController
  12. {
  13.     public function info(RequestInterface $request)
  14.     {
  15.         // ...
  16.     }
  17. }

依赖注入与参数

如果希望通过控制器方法参数获取路由参数，可以在依赖项之后列出对应的参数，框架会自动将对应的参数注入到方法参数内，比如您的路由是这样定义的：

  1. // 注解方式
  2. /**
  3.  * @GetMapping(path="/user/{id:\d+}")
  4.  */
  6. // 配置方式
  7. use Hyperf\HttpServer\Router\Router;
  9. Router::addRoute(['GET', 'HEAD'], '/user/{id:\d+}', [\App\Controller\IndexController::class, 'user']);

则可以通过在方法参数上声明 $id 参数获得 Query 参数 id，如下所示：

  1. declare(strict_types=1);
  3. namespace App\Controller;
  5. use Hyperf\HttpServer\Contract\RequestInterface;
  6. use Hyperf\HttpServer\Annotation\AutoController;
  8. /**
  9.  * @AutoController()
  10.  */
  11. class IndexController
  12. {
  13.     public function info(RequestInterface $request, int $id)
  14.     {
  15.         // ...
  16.     }
  17. }

请求路径 & 方法

Hyperf\HttpServer\Contract\RequestInterface 除了使用 PSR-7 标准定义的 APIs 之外，还提供了多种方法来检查请求，下面我们提供一些方法的示例：

获取请求路径

path() 方法返回请求的路径信息。也就是说，如果传入的请求的目标地址是 http://domain.com/foo/bar?baz=1，那么 path() 将会返回 foo/bar：

  1. $uri = $request->path();

is(...$patterns) 方法可以验证传入的请求路径和指定规则是否匹配。使用这个方法的时，你也可以传递一个 * 字符作为通配符：

  1. if ($request->is('user/*')) {
  2.     // ...
  3. }

获取请求的 URL

你可以使用 url() 或 fullUrl() 方法去获取传入请求的完整 URL。url() 方法返回不带有 Query 参数 的 URL，而 fullUrl() 方法的返回值包含 Query 参数 ：

  1. // 没有查询参数
  2. $url = $request->url();
  4. // 带上查询参数
  5. $url = $request->fullUrl();

获取请求方法

getMethod() 方法将返回 HTTP 的请求方法。你也可以使用 isMethod(string $method) 方法去验证 HTTP 的请求方法与指定规则是否匹配：

  1. $method = $request->getMethod();
  3. if ($request->isMethod('post')) {
  4.     // ...
  5. }

PSR-7 请求及方法

hyperf/http-message 组件本身是一个实现了 PSR-7 标准的组件，相关方法都可以通过注入的 请求对象(Request) 来调用。如果注入时声明为 PSR-7 标准的 Psr\Http\Message\ServerRequestInterface 接口，则框架会自动转换为等同于 Hyperf\HttpServer\Contract\RequestInterface 的 Hyperf\HttpServer\Request 对象。

建议使用 Hyperf\HttpServer\Contract\RequestInterface 来注入，这样可获得 IDE 对专属方法的自动完成提醒支持。

输入预处理 & 规范化

获取输入

获取所有输入

您可以使用 all() 方法以 数组 形式获取到所有输入数据:

  1. $all = $request->all();

获取指定输入值

通过 input(string $key, $default = null) 和 inputs(array $keys, $default = null): array 获取 一个 或 多个 任意形式的输入值：

  1. // 存在则返回，不存在则返回 null
  2. $name = $request->input('name');
  3. // 存在则返回，不存在则返回默认值 Hyperf
  4. $name = $request->input('name', 'Hyperf');

如果传输表单数据中包含「数组」形式的数据，那么可以使用「点」语法来获取数组：

  1. $name = $request->input('products.0.name');
  3. $names = $request->input('products.*.name');

从查询字符串获取输入

使用 input, inputs 方法可以从整个请求中获取输入数据（包括 Query 参数），而 query(?string $key = null, $default = null) 方法可以只从查询字符串中获取输入数据：

  1. // 存在则返回，不存在则返回 null
  2. $name = $request->query('name');
  3. // 存在则返回，不存在则返回默认值 Hyperf
  4. $name = $request->query('name', 'Hyperf');
  5. // 不传递参数则以关联数组的形式返回所有 Query 参数
  6. $name = $request->query();

获取 JSON 输入信息

如果请求的 Body 数据格式是 JSON，则只要 请求对象(Request) 的 Content-Type Header值 正确设置为 application/json，就可以通过 input(string $key, $default = null) 方法访问 JSON 数据，你甚至可以使用 「点」语法来读取 JSON 数组：

  1. // 存在则返回，不存在则返回 null
  2. $name = $request->input('user.name');
  3. // 存在则返回，不存在则返回默认值 Hyperf
  4. $name = $request->input('user.name', 'Hyperf');
  5. // 以数组形式返回所有 Json 数据
  6. $name = $request->all();

确定是否存在输入值

要判断请求是否存在某个值，可以使用 has($keys) 方法。如果请求中存在该值则返回 true，不存在则返回 false，$keys 可以传递一个字符串，或传递一个数组包含多个字符串，只有全部存在才会返回 true：

  1. // 仅判断单个值
  2. if ($request->has('name')) {
  3.     // ...
  4. }
  5. // 同时判断多个值
  6. if ($request->has(['name', 'email'])) {
  7.     // ...
  8. }

Cookies

从请求中获取 Cookies

使用 getCookieParams() 方法从请求中获取所有的 Cookies，结果会返回一个关联数组。

  1. $cookies = $request->getCookieParams();

如果希望获取某一个 Cookie 值，可通过 cookie(string $key, $default = null) 方法来获取对应的值：

  1. // 存在则返回，不存在则返回 null
  2. $name = $request->cookie('name');
  3. // 存在则返回，不存在则返回默认值 Hyperf
  4. $name = $request->cookie('name', 'Hyperf');

文件

获取上传文件

你可以使用 file(string $key, $default): ?Hyperf\HttpMessage\Upload\UploadedFile 方法从请求中获取上传的文件对象。如果上传的文件存在则该方法返回一个 Hyperf\HttpMessage\Upload\UploadedFile 类的实例，该类继承了 PHP 的 SplFileInfo 类的同时也提供了各种与文件交互的方法：

  1. // 存在则返回一个 Hyperf\HttpMessage\Upload\UploadedFile 对象，不存在则返回 null
  2. $file = $request->file('photo');

检查文件是否存在

您可以使用 hasFile(string $key): bool 方法确认请求中是否存在文件：

  1. if ($request->hasFile('photo')) {
  2.     // ...
  3. }

验证成功上传

除了检查上传的文件是否存在外，您也可以通过 isValid(): bool 方法验证上传的文件是否有效：

  1. if ($request->file('photo')->isValid()) {
  2.     // ...
  3. }

文件路径 & 扩展名

UploadedFile 类还包含访问文件的完整路径及其扩展名方法。getExtension() 方法会根据文件内容判断文件的扩展名。该扩展名可能会和客户端提供的扩展名不同：

  1. // 该路径为上传文件的临时路径
  2. $path = $request->file('photo')->getPath();
  4. // 由于 Swoole 上传文件的 tmp_name 并没有保持文件原名，所以这个方法已重写为获取原文件名的后缀名
  5. $extension = $request->file('photo')->getExtension();

存储上传文件

上传的文件在未手动储存之前，都是存在一个临时位置上的，如果您没有对该文件进行储存处理，则在请求结束后会从临时位置上移除，所以我们可能需要对文件进行持久化储存处理，通过 moveTo(string $targetPath): void 将临时文件移动到 $targetPath 位置持久化储存，代码示例如下：

  1. $file = $request->file('photo');
  2. $file->moveTo('/foo/bar.jpg');
  4. // 通过 isMoved(): bool 方法判断方法是否已移动
  5. if ($file->isMoved()) {
  6.     // ...
  7. }