带你学习hyperf-3.2 中间件

3.2 中间件

1. 创建中间件：所有的中间件都会被默认创建到app/Middlware目录下

php ./bin/hyperf.php gen:middleware Auth/UserTokenMiddleware

2. 定义全局中间件：在config/autoload/middlewares.php下定义

<?php

return [
    'http' => [
        AppMiddlewareAuthUserTokenMiddleware::class
    ],
];

3. 定义局部中间件

• 在路由里定义：在config/routes.php

<?php

use HyperfHttpServerRouterRouter;

Router::addGroup('/api', function () {
Router::get('/test/{id}', 'AppControllerIndexController@test');
}, [
['middleware' => [AppMiddlewareAuthUserTokenMiddleware::class]]
]);

• 在控制器里定义：当路由的定时方式是注解的时候才可以实现
  • @Middlewares：定义多个中间件，用{}包裹
  • @Middleware：定义单个中间件

    <?php
namespace AppController;

use HyperfHttpServerAnnotationAutoController;
use HyperfHttpServerAnnotationMiddleware;
use HyperfHttpServerAnnotationMiddlewares;

/**
 * @AutoController()
 * @Middlewares({
        @Middleware(AppMiddlewareAuthUserTokenMiddleware::class)
 *     })
 */
class IndexController extends AbstractController
{
    public function index()
    {
        $user = $this->request->input('user', 'Hyperf');
        $method = $this->request->getMethod();

        return [
            'method' => $method,
            'message' => "Hello {$user}.",
        ];
    }

    /**
     * @AutoController()
     * @Middlewares({
            @Middleware(AppMiddlewareAuthAllowedGetMiddleware::class)
     *     })
     */
    public function test(int $id)
    {
        return $id;
    }
}

4. 多个中间件的执行顺序：全局中间件→类级别中间件→方法级别中间件
5. 中间件的内容的编写

<?php
namespace AppMiddlewareAuth;

use HyperfHttpServerContractRequestInterface as Request;
use HyperfHttpServerContractResponseInterface as Response;
use PsrContainerContainerInterface;
use PsrHttpMessageResponseInterface;
use PsrHttpServerMiddlewareInterface;
use PsrHttpMessageServerRequestInterface;
use PsrHttpServerRequestHandlerInterface;

class UserTokenMiddleware implements MiddlewareInterface
{
    /**
     * @var ContainerInterface
     */
    protected $container;

    /**
     * @var Response
     */
    protected $response;

    /**
     * @var $request
     */
    protected $request;

    public function __construct(ContainerInterface $container, Response $response, Request $request)
    {
        $this->container = $container;
        $this->response = $response;
        $this->request = $request;
    }

    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
    {
        // token验证
        $checkToken = false;
        if ($checkToken) { // 验证成功继续往下请求
            return $handler->handle($request);
        } else { // 验证失败直接返回json内容
            return $this->response->json(
                [
                    'code' => -1,
                    'data' => [
                        'error' => '中间里验证token无效，阻止继续向下执行',
                    ],
                ]
            );
        }
    }
}