登录/注册

响应

在 Hyperf 里可通过 HyperfHttpServerContractResponseInterface 接口类来注入 Response 代理对象对响应进行处理,默认返回 HyperfHttpServerResponse 对象,该对象可直接调用所有 PsrHttpMessageResponseInterface 的方法。

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

返回 Json 格式

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

<?php
namespace AppController;

use HyperfHttpServerContractResponseInterface;
use PsrHttpMessageResponseInterface as Psr7ResponseInterface;

class IndexController
{
    public function json(ResponseInterface $response): Psr7ResponseInterface
    {
        $data = [
            'key' => 'value'
        ];
        return $response->json($data);
    }
}

返回 Xml 格式

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

<?php
namespace AppController;

use HyperfHttpServerContractResponseInterface;
use PsrHttpMessageResponseInterface as Psr7ResponseInterface;

class IndexController
{
    public function xml(ResponseInterface $response): Psr7ResponseInterface
    {
        $data = [
            'key' => 'value'
        ];
        return $response->xml($data);
    }
}

返回 Raw 格式

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

<?php
namespace AppController;

use HyperfHttpServerContractResponseInterface;
use PsrHttpMessageResponseInterface as Psr7ResponseInterface;

class IndexController
{
    public function raw(ResponseInterface $response): Psr7ResponseInterface
    {
        return $response->raw('Hello Hyperf.');
    }
}

返回视图

请参考 视图 部分文档

重定向

HyperfHttpServerContractResponseInterface 提供了 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
<?php
namespace AppController;

use HyperfHttpServerContractResponseInterface;
use PsrHttpMessageResponseInterface as Psr7ResponseInterface;

class IndexController
{
    public function redirect(ResponseInterface $response): Psr7ResponseInterface
    {
        // redirect() 方法返回的是一个 PsrHttpMessageResponseInterface 对象,需再 return 回去  
        return $response->redirect('/anotherUrl');
    }
}

Cookie 设置

<?php
namespace AppController;

use HyperfHttpServerContractResponseInterface;
use PsrHttpMessageResponseInterface as Psr7ResponseInterface;
use HyperfHttpMessageCookieCookie;

class IndexController
{
    public function cookie(ResponseInterface $response): Psr7ResponseInterface
    {
        $cookie = new Cookie('key', 'value');
        return $response->withCookie($cookie)->withContent('Hello Hyperf.');
    }
}

Gzip 压缩

分块传输编码 Chunk

文件下载

HyperfHttpServerContractResponseInterface 提供了 download(string $file, string $name = '') 返回一个已设置下载文件状态的 Psr7ResponseInterface 对象。如果请求中带有 if-matchif-none-match 的请求头,Hyperf 也会根据协议标准与 ETag 进行比较,如果一致则会返回一个 304 状态码的响应。

download 方法:

参数 类型 默认值 备注
file string 要返回下载文件的绝对路径,同通过 BASE_PATH 常量来定位到项目的根目录
name string 客户端下载文件的文件名,为空则会使用下载文件的原名
<?php
namespace AppController;

use HyperfHttpServerContractResponseInterface;
use PsrHttpMessageResponseInterface as Psr7ResponseInterface;

class IndexController
{
    public function index(ResponseInterface $response): Psr7ResponseInterface
    {
        return $response->download(BASE_PATH . '/public/file.csv', 'filename.csv');
    }
}
原文地址:https://www.bookstack.cn/read/hyperf-1.1.20/response.md
文章来源与用户投稿或网络采集,如果您是本文的作者,发现版权或转载方式问题请右侧邮箱联系管理员。

抢沙发

我们不是孤独的个体,留下足迹,保持联系,成为团体...
姓名
电子邮件
个人主页