hdk-core/src/Middleware/CommonCoreMiddleware.php

<?php

/**
 * ClassicCoreMiddleware.php@hyperf-development-kit
 *
 * @author 李东云<dongyun.li@luxcreo.cn>
 * Powered by PhpStorm
 * Created on 2022/4/29
 */

namespace Singularity\HDK\Core\Middleware;

use Hyperf\Codec\Json;
use Hyperf\Contract\Arrayable;
use Hyperf\Contract\Jsonable;
use Hyperf\Contract\LengthAwarePaginatorInterface;
use Hyperf\Di\Annotation\Inject;
use Hyperf\HttpMessage\Server\ResponsePlusProxy;
use Hyperf\HttpMessage\Stream\SwooleStream;
use Hyperf\HttpServer\CoreMiddleware;
use Lmc\HttpConstants\Header;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Singularity\HDK\Core\Service\ApiStyleService;
use Singularity\HDK\Core\Service\UtilsService;
use Swow\Psr7\Message\ResponsePlusInterface;

use function Hyperf\Config\config;

/**
 * Singularity\HDK\Core\Middleware\CommonCoreMiddleware@HDK-Core
 *
 * @author 李东云 <Dongyun.Li@LuxCreo.Ai>
 * Powered by PhpStorm
 * Created on 2023/3/10
 */
class CommonCoreMiddleware extends CoreMiddleware
{
    #[Inject]
    private UtilsService $utilsService;

    #[Inject]
    private ApiStyleService $apiStyleService;

    /**
     * @inheritDoc
     */
    protected function transferToResponse(
        $response,
        ServerRequestInterface $request,
    ): ResponsePlusInterface {
        $style = $this->apiStyleService->get();

        if (!($response instanceof ResponseInterface)) {
            $response = $style === ApiStyleService::RESTFUL
                ? $this->transferToRestfulResponse($response, $request)
                : $this->transferToClassicResponse($response, $request);
        }

        return new ResponsePlusProxy($response);
    }

    /**
     * @param null|array|Arrayable|Jsonable|ResponseInterface|string $response
     * @param ServerRequestInterface                                 $request
     *
     * @return ResponseInterface
     */
    protected function transferToRestfulResponse(
        null|array|Arrayable|Jsonable|ResponseInterface|string $response,
        ServerRequestInterface $request,
    ): ResponseInterface {
        // 分页数据
        if ($response instanceof LengthAwarePaginatorInterface) {
            $fact_response = $this->response()
                ->withHeader('Per-Page', (string)$response->perPage())
                ->withHeader('Total', (string)$response->total())
                ->withHeader('Current-Page', (string)$response->currentPage())
                ->withHeader('Total-Pages', (string)$response->hasPages());
            $fact_response = $this->utilsService->extendLinkToHeader($fact_response, $response->nextPageUrl(), 'next');
            $fact_response = $this->utilsService->extendLinkToHeader(
                $fact_response,
                $response->url($response->lastPage()),
                'last'
            );
            $fact_response = $this->utilsService->extendLinkToHeader($fact_response, $response->url(1), 'first');
            $fact_response = $this->utilsService->extendLinkToHeader(
                $fact_response,
                $response->previousPageUrl(),
                'prev'
            );
            return $fact_response->withBody(new SwooleStream(Json::encode($response->items())));
        }

        return parent::transferToResponse($response, $request);
    }

    /**
     * @param null|array|Arrayable|Jsonable|ResponseInterface|string $response
     * @param ServerRequestInterface                                 $request
     *
     * @return ResponseInterface
     */
    protected function transferToClassicResponse(
        null|array|Arrayable|Jsonable|ResponseInterface|string $response,
        ServerRequestInterface $request,
    ): ResponseInterface {
        $code_name = config('common.response.code_name');
        $message_name = config('common.response.message_name');
        $data_name = config('common.response.data_name');
        // 分页数据
        if ($response instanceof LengthAwarePaginatorInterface) {
            $paginator = $response;
            $fact_response = $this->response()->withHeader('Per-Page', (string)$paginator->perPage())->withHeader(
                'Total',
                (string)$paginator->total()
            )->withHeader('Current-Page', (string)$paginator->currentPage())->withHeader(
                'Total-Pages',
                (string)$paginator->hasPages()
            );
            $fact_response = $this->utilsService->extendLinkToHeader($fact_response, $paginator->nextPageUrl(), 'next');
            $fact_response = $this->utilsService->extendLinkToHeader(
                $fact_response,
                $paginator->url($paginator->lastPage()),
                'last'
            );
            $fact_response = $this->utilsService->extendLinkToHeader($fact_response, $paginator->url(1), 'first');
            $fact_response = $this->utilsService->extendLinkToHeader(
                $fact_response,
                $paginator->previousPageUrl(),
                'prev'
            );
            return $fact_response->withAddedHeader(Header::CONTENT_TYPE, 'application/json')->withBody(
                new SwooleStream(
                    Json::encode(
                        [
                            $code_name => 200,
                            $message_name => 'ok',
                            $data_name => $response->items(),
                            'meta' => [
                                'currentPage' => $paginator->currentPage(),
                                'lastPage' => $paginator->lastPage(),
                                'perPage' => $paginator->perPage(),
                                'total' => $paginator->total(),
                            ],
                        ]
                    )
                )
            );
        }
        // 普通数组
        if (is_array($response) || $response instanceof Arrayable) {
            $response = [$code_name => 200, $message_name => 'ok', $data_name => $response];
            return $this->response()->withAddedHeader(Header::CONTENT_TYPE, 'application/json')->withBody(
                new SwooleStream(Json::encode($response))
            );
        }
        // 可 Json 化的数据结构
        if ($response instanceof Jsonable) {
            $response = [$code_name => 200, $message_name => 'ok', $data_name => Json::decode((string)$response)];
            return $this->response()->withAddedHeader(Header::CONTENT_TYPE, 'application/json')->withBody(
                new SwooleStream(Json::encode($response))
            );
        }
        if ($response instanceof ResponseInterface) {
            return $response;
        }
        // 其他默认按字符串处理
        return $this->response()->withAddedHeader(Header::CONTENT_TYPE, 'text/plain')->withBody(
            new SwooleStream((string)$response)
        );
    }
}