本文将探讨如何在 Slim 4 框架中，通过创建自定义的 PSR-7 ResponseInterface 实现，来减少 JSON 响应的样板代码。我们将分析使用装饰器模式的优势，并提供一种清晰、可维护的解决方案，以实现统一的 API 响应格式。同时，我们将讨论依赖注入和工厂模式，以提供更灵活和可测试的代码结构。
使用装饰器模式自定义 PSR-7 响应
PSR-7 标准中的 ResponseInterface 提供了处理 HTTP 响应的通用接口。为了减少样板代码并保持响应格式的一致性，我们可以使用装饰器模式来扩展 ResponseInterface 的功能。
装饰器模式允许我们在不修改原始类的情况下，动态地添加新的行为。这非常适合 PSR-7 ResponseInterface，因为我们不应该直接扩展其实现类。
以下是一个使用装饰器模式创建自定义 ResponseInterface 的示例：
use Psr\Http\Message\ResponseInterface;
class ApiResponse implements ResponseInterface
{
private ResponseInterface $response;
private Serializer $serializer;
public function __construct(ResponseInterface $response, Serializer $serializer)
{
$this->response = $response;
$this->serializer = $serializer;
}
public function success(array $data): ResponseInterface
{
$payload = [
'status' => 'success',
'data' => $data,
'messages' => [],
];
$this->response->getBody()->write($this->serializer->serialize($payload));
return $this->response
->withHeader('Content-Type', 'application/json')
->withStatus(200);
}
// 实现 ResponseInterface 的所有其他方法，并将调用委托给 $this->response
public function getProtocolVersion(): string
{
return $this->response->getProtocolVersion();
}
public function withProtocolVersion(string $version): ResponseInterface
{
$this->response = $this->response->withProtocolVersion($version);
return $this;
}
public function getHeaders(): array
{
return $this->response->getHeaders();
}
public function hasHeader(string $name): bool
{
return $this->response->hasHeader($name);
}
public function getHeader(string $name): array
{
return $this->response->getHeader($name);
}
public function getHeaderLine(string $name): string
{
return $this->response->getHeaderLine($name);
}
public function withHeader(string $name, $value): ResponseInterface
{
$this->response = $this->response->withHeader($name, $value);
return $this;
}
public function withAddedHeader(string $name, $value): ResponseInterface
{
$this->response = $this->response->withAddedHeader($name, $value);
return $this;
}
public function withoutHeader(string $name): ResponseInterface
{
$this->response = $this->response->withoutHeader($name);
return $this;
}
public function getBody(): StreamInterface
{
return $this->response->getBody();
}
public function withBody(StreamInterface $body): ResponseInterface
{
$this->response = $this->response->withBody($body);
return $this;
}
public function getStatusCode(): int
{
return $this->response->getStatusCode();
}
public function withStatus(int $code, string $reasonPhrase = ''): ResponseInterface
{
$this->response = $this->response->withStatus($code, $reasonPhrase);
return $this;
}
public function getReasonPhrase(): string
{
return $this->response->getReasonPhrase();
}
}在这个例子中，ApiResponse 类实现了 ResponseInterface，并接受一个 ResponseInterface 实例和一个 Serializer 实例作为构造函数参数。success() 方法用于生成具有特定格式的 JSON 响应。 所有其他的 ResponseInterface 方法都被委托给内部的 $this->response 对象。
使用方法：
在你的 Slim 4 控制器中，你可以像这样使用 ApiResponse：
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
class MyController
{
private ApiResponse $apiResponse;
public function __construct(ApiResponse $apiResponse)
{
$this->apiResponse = $apiResponse;
}
public function __invoke(ServerRequestInterface $request, ResponseInterface $response): ResponseInterface
{
$data = ['foo' => 'bar'];
return $this->apiResponse->success($data);
}
}依赖注入：
为了方便地使用 ApiResponse，可以使用依赖注入容器（例如 PHP-DI）来自动创建和注入 ApiResponse 实例。
通用产品企业网站(.NET2.0)1.0
下载
1、系统采用.net2.0开发，数据库access2、三层架构，数据层、逻辑层和表示层分离3、系统完全使用div＋css布局，可以灵活处理界面4、技术特点: 使用模板页，大大减少代码量 动态生成竖向导航菜单 ul li实现表格 各种自定义用户空间 Reapter等数据控件的灵活运用
配置 PHP-DI：
use DI\ContainerBuilder;
use Psr\Container\ContainerInterface;
use Psr\Http\Message\ResponseInterface;
use Nyholm\Psr7\Factory\Psr17Factory; //或者你项目使用的 PSR-17 工厂
use App\ApiResponse;
use App\Serializer; // 假设你有一个 Serializer 类
$containerBuilder = new ContainerBuilder();
$containerBuilder->addDefinitions([
ApiResponse::class => function (ContainerInterface $container) {
$responseFactory = new Psr17Factory(); // 使用 PSR-17 工厂创建 Response
$response = $responseFactory->createResponse();
$serializer = $container->get(Serializer::class); // 假设 Serializer 已经配置
return new ApiResponse($response, $serializer);
},
]);
$container = $containerBuilder->build();现在，你可以直接在控制器中注入 ApiResponse，而无需手动创建实例。
使用 ResponseFactory
另一种方法是使用 ResponseFactory。 这允许你创建不同类型的响应，而无需在每个控制器中重复样板代码。
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\StreamFactoryInterface;
class ResponseFactory
{
private StreamFactoryInterface $streamFactory;
public function __construct(StreamFactoryInterface $streamFactory)
{
$this->streamFactory = $streamFactory;
}
public function createJson(ResponseInterface $response, array $data, int $statusCode = 200): ResponseInterface
{
$payload = [
'status' => 'success',
'data' => $data,
'messages' => [],
];
$json = json_encode($payload);
$response->getBody()->write($json);
return $response
->withHeader('Content-Type', 'application/json')
->withStatus($statusCode);
}
// 可以添加其他类型的响应创建方法
}使用方法：
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
class MyController
{
private ResponseFactory $responseFactory;
public function __construct(ResponseFactory $responseFactory)
{
$this->responseFactory = $responseFactory;
}
public function __invoke(ServerRequestInterface $request, ResponseInterface $response): ResponseInterface
{
$data = ['foo' => 'bar'];
return $this->responseFactory->createJson($response, $data);
}
}注意事项：
- 确保正确实现 ResponseInterface 的所有方法，并将调用委托给内部的 $this->response 对象。
- 使用依赖注入容器来管理依赖关系，例如 Serializer 和 ResponseFactory。
- 考虑使用接口来定义 Serializer，以便更容易地切换不同的序列化策略。
- 保持 ApiResponse 类的简洁，只包含与 API 响应格式相关的逻辑。
总结：
通过使用装饰器模式或 ResponseFactory，我们可以有效地减少 Slim 4 框架中 JSON 响应的样板代码，并保持响应格式的一致性。 选择哪种方法取决于项目的具体需求和偏好。 装饰器模式更适合于扩展现有 ResponseInterface 的功能，而 ResponseFactory 更适合于创建不同类型的响应。 无论选择哪种方法，都应该遵循 PSR-7 标准，并使用依赖注入来管理依赖关系。
