如何使用Hyperf框架进行接口鉴权

如何使用Hyperf框架进行接口鉴权

鉴权是Web应用程序开发中一个重要的安全性问题，它可以保护我们的接口不被未授权的用户访问。在使用Hyperf框架开发接口时，我们可以利用Hyperf提供的鉴权机制来实现接口鉴权。本文将介绍如何使用Hyperf框架进行接口鉴权，并提供具体的代码示例。

一、理解接口鉴权

接口鉴权是通过验证用户的身份信息，确定用户是否有权访问接口的过程。常见的鉴权方式有基于Token的鉴权和基于角色的鉴权。

基于Token的鉴权是通过在用户登录后颁发一个Token，在每次请求接口时，用户需要在请求的头部中携带该Token，服务端验证该Token的有效性，确定用户身份是否合法。

基于角色的鉴权是通过为用户分配不同的角色和权限，当用户请求接口时，服务端会根据用户的角色来验证其是否有权访问该接口。

二、配置Hyperf框架接口鉴权

1. 安装jwt组件

Hyperf框架提供了Hyperf/Jwt组件来支持接口鉴权，我们首先需要在项目中安装该组件。在项目根目录下运行以下命令：

composer require hyperf/jwt

2. 配置中间件

Hyperf框架中间件可以实现在请求到达控制器之前或之后进行一些处理。我们可以通过配置中间件来实现接口鉴权。

在config/autoload/middleware.php文件中添加以下代码：

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

3. 编写中间件

在app/Middleware目录下创建JwtAuthMiddleware.php文件，编写如下代码：

<?php

declare(strict_types=1);

namespace AppMiddleware;

use HyperfDiAnnotationInject;
use HyperfHttpServerContractRequestInterface;
use HyperfHttpServerContractResponseInterface;
use HyperfUtilsContext;
use HyperfUtilsExceptionParallelExecutionException;
use Phper666JwtAuthJwt;

class JwtAuthMiddleware implements MiddlewareInterface
{
    /**
     * @Inject
     * @var Jwt
     */
    protected $jwt;

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

    /**
     * @Inject
     * @var ResponseInterface
     */
    protected $response;

    /**
     * 接口鉴权逻辑处理
     */
    public function process(RequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
    {
        if (!$this->jwt->checkToken()) {
            return $this->response->json([
                'code' => 401,
                'message' => 'Unauthorized',
            ]);
        }
        
        // 鉴权通过，将用户信息保存在Context中，后续控制器可通过Context获取用户信息
        Context::set('user', $this->jwt->getParserData());

        return $handler->handle($request);
    }
}

三、使用Hyperf进行接口鉴权

1. 登录生成Token

在登录接口中，用户验证通过后，使用Hyperf/Jwt组件生成Token，并返回给前端，前端每次请求接口时需要带上该Token。示例如下：

<?php

declare(strict_types=1);

namespace AppController;

use HyperfHttpServerAnnotationAutoController;
use HyperfDiAnnotationInject;
use Phper666JwtAuthJwt;

/**
 * @AutoController
 */
class AuthController
{
    /**
     * @Inject
     * @var Jwt
     */
    protected $jwt;

    public function login()
    {
        // 获取用户信息
        $userInfo = [
            'user_id' => 1,
            'username' => 'admin',
        ];

        // 生成Token
        $token = $this->jwt->getToken($userInfo);

        // 返回Token给前端
        return [
            'code' => 200,
            'message' => 'success',
            'data' => [
                'token' => $token,
            ],
        ];
    }
}

2. 接口鉴权

在需要鉴权的接口中，我们可以通过Context获取用户信息，并判断用户是否有权访问该接口。示例如下：

<?php

declare(strict_types=1);

namespace AppController;

use HyperfHttpServerAnnotationAutoController;
use HyperfDiAnnotationInject;
use HyperfUtilsContext;

/**
 * @AutoController
 */
class UserController
{
    public function getUserInfo()
    {
        // 从Context中获取用户信息
        $userInfo = Context::get('user');

        // 根据用户信息查询用户
        // ...

        // 返回用户信息给前端
        return [
            'code' => 200,
            'message' => 'success',
            'data' => $userInfo,
        ];
    }
}

通过以上步骤，我们就可以在Hyperf框架中实现接口鉴权了。在需要鉴权的接口中，使用中间件对请求进行鉴权验证，然后根据鉴权结果进行相应的处理。这样可以有效保障接口的安全性，确保只有授权的用户可以访问接口。