如何制作自定义 PSR-7 ResponseInterface 以减少样板代码？

Question

我正在使用 Slim 4 框架实现一项服务，该框架几乎总是返回 JSON 响应。我试图使所有响应保持统一，其结构与此类似：

{
    "status": "success",
    "data": {"foo": "bar"} // the actual data relevant to the request
    "messages": []
}

在最基本的格式中，这是我需要执行的代码才能做出如下响应：

public function __invoke(ServerRequestInterface $request, ResponseInterface $response): ResponseInterface {
    
    // Do something 

    $response
        ->getBody()
        ->write(json_encode([
            'status' => 'success',
            'data' => [
                'foo' => 'bar'
            ],
            'messages' => [],
        ]));
    return $response
        ->withHeader('Content-Type', 'application/json')
        ->withStatus(200);
}

现在，我一直在使用一个基本的帮助程序类，该类本质上将大部分样板包装成一些静态函数，因此我可以编写如下响应：

public function __invoke(ServerRequestInterface $request, ResponseInterface $response): ResponseInterface {
    
    // Do something 

    $data = ['foo' => 'bar'];

    return APIResponse::success($response, $data)->into();
}

但是，现在我遇到一个问题，我想让响应稍微复杂一些，这将需要额外的依赖项，例如自定义序列化器类。天真的选择是继续将额外的依赖项传递给APIResponse::success($response, $serializer, ..., $data)，但这显然很糟糕，而且不是一个好的长期选择。

我想到的另一个选择是创建一个APIResponseFactory，它将接受构造函数中的任何依赖项并通过 PHP-DI 填充。这会更干净一些，但是每个路由处理程序都需要注入工厂，而且我仍然需要$response每次都手动传递。

return $responseFactory->success($response, $data);

因此，我现在正在考虑的是尝试构建一个可以实现 的自定义类ResponseInterface，从而允许我自动将样板帮助程序构建到每个请求处理程序中。我正在查看我的项目中使用的当前 PSR7 ResponseInterface 实现，代码注释提到该类永远不应该扩展，并建议使用装饰器模式。所以，这是我为当前想法制作的基本伪代码实现。

class MyCustomResponse implements ResponseInterface {

    private $serializer; 

    private $actualResponse;

    // any other dependencies

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

    // Use this class as a decorator and pass all ResponseInterface calls to the external implementation
    // EDIT: It looks like I can't use `__call` to fulfill the interface, so I'd need to manually define to functions, but you get the gist. 
    public function __call($name, $args) {
        return $this->actualResponse->$name(...$args);
    }

    public function success($data) {
        $this->actualResponse
            ->getBody()
            ->write($this->serializer->serialize([
                'status' => 'success',
                'data' => $data,
                'messages' => [],
            ]));
        $this->actualResponse
            ->withHeader('Content-Type', 'application/json')
            ->withStatus(200);
        return $this;
    }
}

因此，我（希望）能够返回这样的响应：

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

我的实际问题：这是为 PSR-7 响应处理程序实现自定义帮助器方法的正确方法吗？有没有更好的办法？编写辅助函数是一种不好的做法吗？由于缺乏更好的描述，PSR-7 接口似乎是低级且冗长的，这让我担心编写这样的包装器在某种程度上违背了标准的意图。是否有其他方法可以遵循标准但减少样板并保持响应统一？

Answer 1

一个“好的”控制器动作return $response->success($data);可以通过以下方式完成

• https://php-di.org/doc/definition-overriding.html#decorators
• https://php-di.org/doc/best-practices.html#using-libraries - 与实现协会的接口

这是一个不好的做法

• 格式{"status":"", "data":[], "messages": []}可能会改变
• 出现文件、流等响应

忘记了争论ResponseInterface $response，争论是如何完成的array $args。

将响应工厂注入每个控制器，因此您的操作如下所示

public function __invoke(ServerRequestInterface $request): ResponseInterface 
{
    // Do something 

    return $this->responseFactory->createJson($data);
    // OR
    //return $this->responseFactory->createSomethingElse();
}