如何使用Hyperf框架進(jìn)行介面鑑權(quán)

鑑權(quán)是Web應(yīng)用程式開發(fā)中一個(gè)重要的安全性問題，它可以保護(hù)我們的介面不被未授權(quán)的使用者存取。在使用Hyperf框架開發(fā)介面時(shí)，我們可以利用Hyperf提供的鑑權(quán)機(jī)制來(lái)實(shí)作介面鑑權(quán)。本文將介紹如何使用Hyperf框架進(jìn)行介面鑑權(quán)，並提供具體的程式碼範(fàn)例。

一、理解介面鑑權(quán)

介面鑑權(quán)是透過驗(yàn)證使用者的身份訊息，確定使用者是否有權(quán)存取介面的過程。常見的鑑權(quán)方式有基於Token的鑑權(quán)和基於角色的鑑權(quán)。

基於Token的鑑權(quán)是透過在使用者登入後頒發(fā)一個(gè)Token，在每次請(qǐng)求介面時(shí)，使用者需要在請(qǐng)求的頭部中攜帶該Token，服務(wù)端驗(yàn)證該Token的有效性，確定使用者身分是否合法。

基於角色的鑑權(quán)是透過為使用者指派不同的角色和權(quán)限，當(dāng)使用者要求介面時(shí)，服務(wù)端會(huì)根據(jù)使用者的角色來(lái)驗(yàn)證其是否有權(quán)存取該介面。

二、設(shè)定Hyperf框架介面鑑權(quán)

1. 安裝jwt元件

Hyperf框架提供了Hyperf/Jwt元件來(lái)支援介面鑑權(quán)，我們首先需要在專案中安裝該元件。在專案根目錄下執(zhí)行以下命令：

composer require hyperf/jwt

2. 配置中間件

Hyperf框架中間件可以實(shí)現(xiàn)在請(qǐng)求到達(dá)控制器之前或之後進(jìn)行一些處理。我們可以透過配置中間件來(lái)實(shí)現(xiàn)介面鑑權(quán)。

在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;

    /**
     * 接口鑒權(quán)邏輯處理
     */
    public function process(RequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
    {
        if (!$this->jwt->checkToken()) {
            return $this->response->json([
                'code' => 401,
                'message' => 'Unauthorized',
            ]);
        }
        
        // 鑒權(quán)通過，將用戶信息保存在Context中，后續(xù)控制器可通過Context獲取用戶信息
        Context::set('user', $this->jwt->getParserData());

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

三、使用Hyperf進(jìn)行介面鑑權(quán)

1. 登入產(chǎn)生Token

##在登入介面中，用戶驗(yàn)證通過後，使用Hyperf/Jwt元件產(chǎn)生Token，並傳回給前端，前端每次要求介面時(shí)需要帶上該Token。範(fàn)例如下：

<?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,
            ],
        ];
    }
}

介面鑑權(quán)

在需要鑑權(quán)的介面中，我們可以透過Context取得使用者信息，並判斷使用者是否有權(quán)存取該接口。範(fàn)例如下：

<?php

declare(strict_types=1);

namespace AppController;

use HyperfHttpServerAnnotationAutoController;
use HyperfDiAnnotationInject;
use HyperfUtilsContext;

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

        // 根據(jù)用戶信息查詢用戶
        // ...

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

透過上述步驟，我們就可以在Hyperf框架中實(shí)作介面鑑權(quán)了。在需要鑑權(quán)的介面中，使用中間件對(duì)請(qǐng)求進(jìn)行鑑權(quán)驗(yàn)證，然後根據(jù)鑑權(quán)結(jié)果進(jìn)行相應(yīng)的處理。這樣可以有效保障介面的安全性，確保只有授權(quán)的使用者可以存取介面。

以上是如何使用Hyperf框架進(jìn)行介面鑑權(quán)的詳細(xì)內(nèi)容。更多資訊請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！