响应

在 Hyperf 里可通过 Hyperf\HttpServer\Contract\ResponseInterface 接口类来注入 Response 代理对象对响应进行处理,默认返回 Hyperf\HttpServer\Response 对象,该对象可直接调用所有 Psr\Http\Message\ResponseInterface 的方法。

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

返回 Json 格式

Hyperf\HttpServer\Contract\ResponseInterface 提供了 json($data) 方法用于快速返回 Json 格式,并设置 Content-Typeapplication/json$data 接受一个数组或为一个实现了 Hyperf\Utils\Contracts\Arrayable 接口的对象。

  1. <?php
  2. namespace App\Controller;
  3. use Hyperf\HttpServer\Contract\ResponseInterface;
  4. use Psr\Http\Message\ResponseInterface as Psr7ResponseInterface;
  5. class IndexController
  6. {
  7. public function json(ResponseInterface $response): Psr7ResponseInterface
  8. {
  9. $data = [
  10. 'key' => 'value'
  11. ];
  12. return $response->json($data);
  13. }
  14. }

返回 Xml 格式

Hyperf\HttpServer\Contract\ResponseInterface 提供了 xml($data) 方法用于快速返回 XML 格式,并设置 Content-Typeapplication/xml$data 接受一个数组或为一个实现了 Hyperf\Utils\Contracts\Xmlable 接口的对象。

  1. <?php
  2. namespace App\Controller;
  3. use Hyperf\HttpServer\Contract\ResponseInterface;
  4. use Psr\Http\Message\ResponseInterface as Psr7ResponseInterface;
  5. class IndexController
  6. {
  7. public function xml(ResponseInterface $response): Psr7ResponseInterface
  8. {
  9. $data = [
  10. 'key' => 'value'
  11. ];
  12. return $response->xml($data);
  13. }
  14. }

返回 Raw 格式

Hyperf\HttpServer\Contract\ResponseInterface 提供了 raw($data) 方法用于快速返回 raw 格式,并设置 Content-Typeplain/text$data 接受一个字符串或一个实现了 __toString() 方法的对象。

  1. <?php
  2. namespace App\Controller;
  3. use Hyperf\HttpServer\Contract\ResponseInterface;
  4. use Psr\Http\Message\ResponseInterface as Psr7ResponseInterface;
  5. class IndexController
  6. {
  7. public function raw(ResponseInterface $response): Psr7ResponseInterface
  8. {
  9. return $response->raw('Hello Hyperf.');
  10. }
  11. }

返回视图

请参考 视图 部分文档

重定向

Hyperf\HttpServer\Contract\ResponseInterface 提供了 redirect(string $toUrl, int $status = 302, string $schema = 'http') 返回一个已设置重定向状态的 Psr7ResponseInterface 对象。

redirect 方法:

参数 类型 默认值 备注
toUrl string 如果参数不存在 http://https:// 则根据当前服务的 Host 自动拼接对应的 URL,且根据 $schema 参数拼接协议
status int 302 响应状态码
schema string http $toUrl 不存在 http://https:// 时生效,仅可传递 httphttps
  1. <?php
  2. namespace App\Controller;
  3. use Hyperf\HttpServer\Contract\ResponseInterface;
  4. use Psr\Http\Message\ResponseInterface as Psr7ResponseInterface;
  5. class IndexController
  6. {
  7. public function redirect(ResponseInterface $response): Psr7ResponseInterface
  8. {
  9. // redirect() 方法返回的是一个 Psr\Http\Message\ResponseInterface 对象,需再 return 回去
  10. return $response->redirect('/anotherUrl');
  11. }
  12. }

Cookie 设置

  1. <?php
  2. namespace App\Controller;
  3. use Hyperf\HttpServer\Contract\ResponseInterface;
  4. use Psr\Http\Message\ResponseInterface as Psr7ResponseInterface;
  5. use Hyperf\HttpMessage\Cookie\Cookie;
  6. class IndexController
  7. {
  8. public function cookie(ResponseInterface $response): Psr7ResponseInterface
  9. {
  10. $cookie = new Cookie('key', 'value');
  11. return $response->withCookie($cookie)->withContent('Hello Hyperf.');
  12. }
  13. }

分块传输编码 Chunk

Hyperf\HttpServer\Contract\ResponseInterface 提供了 write(string $data) 用于分段向浏览器发送相应内容,并设置 Transfer-Encodingchunked$data 接受一个字符串或一个实现了 __toString() 方法的对象。

  1. <?php
  2. namespace App\Controller;
  3. use Hyperf\HttpServer\Contract\ResponseInterface;
  4. class IndexController
  5. {
  6. public function index(ResponseInterface $response)
  7. {
  8. for ($i=0; $i<10; $i++) {
  9. $response->write((string) $i);
  10. }
  11. return 'Hello Hyperf';
  12. }
  13. }

!> 注意:在调用 write 分段发送数据后,如果再次使用 return 返回数据,此时的数据不会正常返回。即上文的例子中不会输出 Hello Hyperf,只会输出 0123456789

文件下载

Hyperf\HttpServer\Contract\ResponseInterface 提供了 download(string $file, string $name = '') 返回一个已设置下载文件状态的 Psr7ResponseInterface 对象。

如果请求中带有 if-matchif-none-match 的请求头,Hyperf 也会根据协议标准与 ETag 进行比较,如果一致则会返回一个 304 状态码的响应。

download 方法:

参数 类型 默认值 备注
file string 要返回下载文件的绝对路径,同通过 BASE_PATH 常量来定位到项目的根目录
name string 客户端下载文件的文件名,为空则会使用下载文件的原名
  1. <?php
  2. namespace App\Controller;
  3. use Hyperf\HttpServer\Contract\ResponseInterface;
  4. use Psr\Http\Message\ResponseInterface as Psr7ResponseInterface;
  5. class IndexController
  6. {
  7. public function index(ResponseInterface $response): Psr7ResponseInterface
  8. {
  9. return $response->download(BASE_PATH . '/public/file.csv', 'filename.csv');
  10. }
  11. }