你的 Slim 应用的路由和中间件得到了一个 PSR-7 响应对象,该对象表示返回给客户端的当前 HTTP 响应。响应对象实现了 PSR-7 ResponseInterface,可以使用它来检查和操作 HTTP 响应状态、标头和正文。
如何获取响应对象
PSR-7 响应对象将注入到 Slim 应用程序路由中,作为路由回调的第二个参数,如下所示
响应状态
每个 HTTP 响应都有一个数字的 状态代码。状态代码标识要返回给客户端的 HTTP 响应类型。PSR-7 响应对象的默认状态代码为 200
(OK)。你可以使用 getStatusCode()
方法获取 PSR-7 响应对象的状态代码,如下所示。
可以复制一个 PSR-7 响应对象,并像这样指定一个新的状态代码
每个HTTP响应都有头信息。这些是描述HTTP响应的元数据,但不会响应正文中显示。PSR-7 Response对象提供了几个方法来检查和操作其头信息。
您可以使用 PSR-7 Response 对象的 getHeaders()
方法以关联数组的形式获取所有 HTTP 响应头信息。结果关联数组的键是头信息名称,其值本身是其各自头信息名称的字符串值的数字数组。
您可以使用 PSR-7 Response 对象的 getHeader($name)
方法获取单个头信息的多个值。这将返回给定头信息名称的值数组。记住,单个 HTTP 头信息可能有多个值!
您还可以使用 PSR-7 Response 对象的getHeaderLine($name)
方法获取具有给定头信息的所有值的逗号分隔字符串。与getHeader($name)
方法不同,此方法将返回一个逗号分隔字符串。
您可以使用 PSR-7 Response 对象的 hasHeader($name)
方法测试是否存在头信息。
您可以使用 PSR-7 Response 对象的 withHeader($name, $value)
方法设置头信息值。
提醒
Response 对象是不可变的。此方法将返回 Response 对象的副本,该副本具有新的头信息值。此方法具有破坏性,它会替换已与同一头信息名称关联的现有头信息值。
您可以使用 PSR-7 Response 对象的 withAddedHeader($name, $value)
方法追加头信息值。
提醒
与 withHeader()
方法不同,此方法将新值追加到同一头信息名称已存在的多个值中。Response 对象是不可变的。此方法将返回 Response 对象的副本,该副本具有已追加的头信息值。
您可以使用 Response 对象的 withoutHeader($name)
方法移除头信息。
提醒
Response 对象是不可变的。此方法将返回 Response 对象的副本,该副本不包含指定的头信息。
响应正文
HTTP 响应通常具有正文。
与 PSR-7 请求对象一样,PSR-7 响应对象将主体实现为 Psr\Http\Message\StreamInterface
的一个实例。您可以通过 PSR-7 响应对象的 getBody()
方法获取 HTTP 响应主体 StreamInterface
实例。如果传出的 HTTP 响应长度未知或对于可用的内存过大,则 getBody()
方法更为方便。
产生的 Psr\Http\Message\StreamInterface
实例提供以下方法来读取、迭代并写入其底层的 PHP resource
。
- getSize()
- tell()
- eof()
- isSeekable()
- seek()
- rewind()
- isWritable()
- write($string)
- isReadable()
- read($length)
- getContents()
- getMetadata($key = null)
大多数情况下,您需要写入 PSR-7 响应对象。您可以通过其 write()
方法将内容写入 StreamInterface
实例,如下所示
您还可以使用完全新的 StreamInterface
实例替换 PSR-7 响应对象的正文。当您希望将内容从远程目的地(例如文件系统或远程 API)输入到 HTTP 响应中时,这尤其有用。您可以使用其 withBody(StreamInterface $body)
方法替换 PSR-7 响应对象的正文。它的参数 必须是 Psr\Http\Message\StreamInterface
的一个实例。
提醒
响应对象是不可变的。此方法返回包含新正文的响应对象的副本。
返回 JSON
最简单的形式是,JSON 数据可以通过默认 200 HTTP 状态代码返回。
我们还可以使用自定义 HTTP 状态代码返回 JSON 数据。
提醒
响应对象是不可变的。此方法返回一个有新的内容类型标题的响应对象的副本。此方法是破坏性的,它替换现有的内容类型标题。
返回重定向
您可以使用 Location
标题重定向 HTTP 客户端。