创建自定义 PSR-7 ResponseInterface 以减少样板代码-php教程-PHP中文网

创建自定义 PSR-7 ResponseInterface 以减少样板代码

霞舞

发布： 2025-09-29 17:43:00

原创

294人浏览过

创建自定义 psr-7 responseinterface 以减少样板代码

本文探讨了在 Slim 4 框架中，如何通过创建自定义 PSR-7 ResponseInterface 实现统一的 JSON 响应格式，从而减少重复代码。文章分析了使用 Helper 类、ResponseFactory 等方案的优缺点，并着重介绍了使用装饰器模式扩展 ResponseInterface 的方法，同时讨论了最佳实践和注意事项，旨在帮助开发者编写更简洁、更易维护的代码。

在开发 Web API 时，保持响应格式的一致性至关重要。尤其是在使用 Slim 4 这样的框架时，我们经常需要返回具有统一结构的 JSON 响应，例如包含 status、data 和 messages 字段。为了避免在每个路由处理程序中编写重复的代码，我们需要寻找一种优雅的方式来封装这些逻辑。

常见的解决方案及其局限性

Helper 类： 最简单的方案是创建一个静态 Helper 类，其中包含用于生成特定格式响应的函数。虽然这种方法可以减少一些样板代码，但当响应逻辑变得复杂，例如需要自定义序列化器时，Helper 类会变得臃肿且难以维护。
ResponseFactory： 另一种选择是使用 ResponseFactory。Factory 接收必要的依赖项（如序列化器），并在构造函数中进行注入。虽然这比 Helper 类更清晰，但每个路由处理程序仍然需要注入 Factory 并在每次调用时手动传递 $response 对象。

使用装饰器模式扩展 ResponseInterface

一个更优雅的解决方案是使用装饰器模式扩展 ResponseInterface。这种方法允许我们创建一个自定义的 ResponseInterface 实现，其中包含我们需要的辅助方法，而无需修改原始的 ResponseInterface。

以下是一个基本示例：

use Psr\Http\Message\ResponseInterface;

class APIResponse implements ResponseInterface
{
    private ResponseInterface $actualResponse;
    private Serializer $serializer;

    public function __construct(ResponseInterface $actualResponse, Serializer $serializer)
    {
        $this->actualResponse = $actualResponse;
        $this->serializer = $serializer;
    }

    public function success(array $data): ResponseInterface
    {
        $this->actualResponse->getBody()->write(
            $this->serializer->serialize([
                'status' => 'success',
                'data' => $data,
                'messages' => [],
            ])
        );

        return $this->actualResponse
            ->withHeader('Content-Type', 'application/json')
            ->withStatus(200);
    }

    // 实现 ResponseInterface 的所有其他方法，并将调用转发给 $actualResponse
    public function getStatusCode(): int {
        return $this->actualResponse->getStatusCode();
    }

    public function withStatus(int $code, string $reasonPhrase = ''): ResponseInterface {
        $this->actualResponse = $this->actualResponse->withStatus($code, $reasonPhrase);
        return $this;
    }

    // ... 其他方法
}

登录后复制

在这个例子中，APIResponse 类实现了 ResponseInterface，并持有一个 ResponseInterface 的实例 $actualResponse。success 方法封装了生成 JSON 响应的逻辑。所有其他 ResponseInterface 方法都被转发到 $actualResponse，从而确保我们的自定义类与 PSR-7 标准兼容。

通义灵码

阿里云出品的一款基于通义大模型的智能编码辅助工具，提供代码智能生成、研发智能问答能力

查看详情

在你的路由处理程序中，你可以这样使用它：

use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;

public function __invoke(ServerRequestInterface $request, ResponseInterface $response): ResponseInterface
{
    $data = ['foo' => 'bar'];
    return $response->success($data);
}

登录后复制

使用 PHP-DI 进行依赖注入

为了更好地管理依赖关系，我们可以使用 PHP-DI 这样的依赖注入容器来配置 APIResponse。

use DI\ContainerBuilder;

$containerBuilder = new ContainerBuilder();
$containerBuilder->addDefinitions([
    ResponseInterface::class => DI\factory(function (Serializer $serializer) {
        $responseFactory = new \Nyholm\Psr7\Factory\Psr17Factory();
        return new APIResponse($responseFactory->createResponse(), $serializer);
    }),
]);

$container = $containerBuilder->build();

登录后复制

这段代码配置了 PHP-DI，以便在需要 ResponseInterface 时，创建一个 APIResponse 实例，并将 Serializer 注入到构造函数中。注意这里使用了 Nyholm\Psr7\Factory\Psr17Factory 创建了一个默认的 Response 对象，作为装饰器的基础。

注意事项

PSR-7 的不可变性： PSR-7 强调不可变性。这意味着每次修改响应时（例如添加 Header 或修改状态码），都需要返回一个新的响应实例。请确保你的自定义 ResponseInterface 实现遵循这一原则。在上面的例子中，withStatus 方法返回了一个新的 ResponseInterface 实例。
处理不同类型的响应： 如果你的 API 需要返回不同类型的响应（例如文件、流），请确保你的自定义 ResponseInterface 实现能够处理这些情况。
错误处理： 在 success 方法中，可以添加错误处理逻辑，例如捕获序列化异常并返回错误响应。

总结

通过使用装饰器模式扩展 ResponseInterface，我们可以创建一个自定义的响应类，封装生成特定格式响应的逻辑，从而减少样板代码并提高代码的可维护性。结合依赖注入容器，我们可以更好地管理依赖关系并确保代码的灵活性。虽然这需要一些额外的工作，但从长远来看，它可以显著提高开发效率并降低维护成本。

此外，需要注意的是，使用 ResponseFactory 也是一个不错的选择，特别是当你的响应逻辑相对简单时。最终的选择取决于你的具体需求和偏好。

以上就是创建自定义 PSR-7 ResponseInterface 以减少样板代码的详细内容，更多请关注php中文网其它相关文章！