PHP-FIG的PSR-7 HTTP消息接口使用指南

PHP-FIG的PSR-7 HTTP消息接口使用指南

http-message The purpose of this PSR is to provide a set of common interfaces for HTTP messages as described in RFC 7230 and RFC 7231 项目地址: https://gitcode.com/gh_mirrors/ht/http-message

PSR-7标准概述

PSR-7是PHP标准推荐规范中关于HTTP消息接口的定义，它为PHP应用程序处理HTTP请求和响应提供了一套标准化的接口。这套接口由PHP-FIG（PHP框架互操作性小组）制定，旨在解决不同PHP框架和库之间HTTP消息处理不一致的问题。

核心接口结构

PSR-7定义了几个核心接口，它们构成了一个清晰的继承层次：

1. MessageInterface：定义了HTTP消息的基本结构
2. RequestInterface：扩展自MessageInterface，表示HTTP请求
3. ServerRequestInterface：扩展自RequestInterface，表示服务器端接收的HTTP请求
4. ResponseInterface：扩展自MessageInterface，表示HTTP响应

这种设计反映了HTTP协议的本质：请求和响应都是特定类型的消息。

准备工作

要使用PSR-7接口，你需要选择一个实现了这些接口的库。常见的选择包括但不限于：

• Zend Diactoros
• Guzzle PSR-7
• Slim Framework

这些实现库虽然内部实现不同，但都遵循相同的PSR-7接口规范，因此在使用方式上保持一致。

HTTP头部操作详解

添加头部

// 添加单个头部到响应
$response = $response->withHeader('Content-Type', 'application/json');

withHeader()方法会返回一个新的响应对象，包含添加的头部，原始响应对象不会被修改。这是PSR-7的一个重要特性——不可变性。

追加头部值

// 向现有头部追加值
$response = $response->withAddedHeader('Cache-Control', 'no-cache');

如果头部已存在，新值会被追加到现有值后面；如果不存在，效果等同于withHeader()。

检查头部存在

// 检查请求中是否包含特定头部
if ($request->hasHeader('Authorization')) {
    // 处理认证逻辑
}

获取头部信息

PSR-7提供了两种获取头部值的方式：

1. 获取逗号分隔的字符串：

$contentType = $request->getHeaderLine('Content-Type');
// 返回示例："text/html; charset=UTF-8"

2. 获取值数组：

$contentTypeArray = $request->getHeader('Content-Type');
// 返回示例：["text/html", "charset=UTF-8"]

移除头部

// 从请求中移除特定头部
$request = $request->withoutHeader('X-Deprecated-Header');

HTTP消息体操作

消息体处理模式

PSR-7提供了两种处理消息体的方式：

1. 分离处理模式（推荐）：

$body = $response->getBody();
// 执行各种操作：读取、写入、定位等
$body->write('Hello World');
// 最后将修改后的body重新附加到响应（可选）
$response = $response->withBody($body);

2. 直接链式调用：

$response->getBody()->write('Hello World');

读取消息体内容

$body = $response->getBody();
$body->rewind(); // 将指针重置到起始位置
$content = $body->getContents(); // 读取全部内容

重要提示：在读取内容前必须重置指针位置，否则可能读取不到完整内容或完全读取不到内容。

写入操作

追加内容：

$response->getBody()->write('Appended content');

预置内容（需要特殊处理）：

由于流式处理的特性，预置内容比追加复杂：

$body = $response->getBody();
$body->rewind();
$existingContent = $body->getContents();
$body->rewind();
$body->write('Prepended content');
$body->write($existingContent);

最佳实践建议

1. 不可变对象：记住所有修改方法（如withHeader()）都返回新对象，原始对象保持不变。

2. 流指针管理：操作消息体时要注意指针位置，读取前使用rewind()或seek(0)重置指针。

3. 性能考虑：对于大量头部操作，考虑收集所有修改后一次性应用，而不是多次创建新对象。

4. 内存效率：对于大文件或大数据流，使用流式处理而不是全部加载到内存。

5. 错误处理：检查所有头部和消息体操作的结果，特别是当使用用户提供的数据时。

通过遵循PSR-7标准，你的PHP应用可以更容易地与其他遵循同一标准的组件和框架集成，提高代码的可移植性和可维护性。

http-message The purpose of this PSR is to provide a set of common interfaces for HTTP messages as described in RFC 7230 and RFC 7231 项目地址: https://gitcode.com/gh_mirrors/ht/http-message