如何在Hyperf中实现JWT无状态认证_集成hyperf-ext/jwt并配置黑名单

冬萱酱_9330

冬萱酱_9330

2026-05-22

1260人浏览

原创

hyperf 3.x 不兼容 hyperf-ext/jwt,需手动实现 jwtguard、替换黑名单为 redis 实现、自定义中间件并统一异常处理,否则认证失败或黑名单失效。

如何在hyperf中实现jwt无状态认证_集成hyperf-ext/jwt并配置黑名单

Hyperf 默认不内置 JWT 支持,直接装 hyperf-ext/jwt 会因底层 TokenParser 和异常处理逻辑不兼容而报错——尤其是 TokenExpiredException 未被正确捕获、AuthManager 无法识别 JWT 驱动,导致认证始终失败。

为什么 hyperf-ext/jwt 不能直接 composer require 就用

该扩展基于 Hyperf 2.2 早期架构开发,与当前主流的 Hyperf 3.x(尤其是 hyperf/auth v3+)存在三处关键断层:

  • JWTGuard 没有实现 supportsRememberMe() 方法,导致 AuthManager 初始化时抛 BadMethodCallException
  • 黑名单存储默认依赖 hyperf/cache 的 FileDriver,但 JWT 扩展未适配 Hyperf 3 的 CacheInterface 新签名(如 getMultiple() 参数类型变更)
  • JWTTokenParser 返回的 TokenInterface 实例缺少 getClaims() 方法,导致中间件里 $request->user() 取不到用户数据

手动补全 JWTGuard 并注册为 auth 驱动

需新建 app/Auth/JWTGuard.php,继承 Hyperf\Auth\Guard\AbstractGuard,并显式实现缺失方法:

namespace App\Auth;

use Hyperf\Auth\Guard\AbstractGuard;
use Hyperf\Auth\Guard\GuardInterface;
use Hyperf\Context\ApplicationContext;
use Hyperf\Contract\ContainerInterface;
use Hyperf\Jwt\JWT;
use Hyperf\Jwt\Token;
use Psr\Http\Message\ServerRequestInterface;

class JWTGuard extends AbstractGuard implements GuardInterface
{
    protected JWT $jwt;

    public function __construct(ContainerInterface $container, string $providerName = null)
    {
        parent::__construct($container, $providerName);
        $this->jwt = $container->get(JWT::class);
    }

    public function user(): ?object
    {
        $token = $this->getTokenFromRequest();
        if (! $token) {
            return null;
        }
        try {
            $payload = $this->jwt->parse($token)->getPayload();
            $id = $payload['uid'] ?? null; // 假设 payload 含 uid 字段
            return $id ? $this->provider->retrieveById($id) : null;
        } catch (\Exception $e) {
            return null;
        }
    }

    protected function getTokenFromRequest(): ?string
    {
        $request = ApplicationContext::getContainer()->get(ServerRequestInterface::class);
        $authHeader = $request->getHeaderLine('Authorization');
        if (preg_match('/Bearer\s+(.*)$/i', $authHeader, $matches)) {
            return $matches[1];
        }
        return null;
    }

    public function supportsRememberMe(): bool
    {
        return false; // JWT 本身无 remember me 概念
    }
}

然后在 config/autoload/auth.php 中注册驱动:

Hyperframes Creative
Hyperframes Creative

HyperFrames视频非动画创意指导,包括设计规范(frame.md/design.md)处理、配色、字体设计、旁白及节奏规划等。

下载
'guards' => [
    'jwt' => [
        'driver' => \App\Auth\JWTGuard::class,
        'provider' => 'users',
    ],
],

配置黑名单:用 Redis 替代默认 FileDriver

hyperf-ext/jwt 的黑名单机制依赖 BlacklistInterface,但其默认实现硬编码了 FileDriver。必须重写为 Redis 实现,并确保过期时间与 token 一致:

  • 在 config/autoload/jwt.php 中关闭自动黑名单(避免启动时报错):'blacklist_enabled' => false
  • 新建 app/Jwt/RedisBlacklist.php,实现 BlacklistInterface,用 $redis->setex($jti, $ttl, 1) 存入 jti + 过期时间
  • 在 token 签发后手动调用 $blacklist->add($token);登出时用 $token->getJti() 主动加入黑名单
  • 注意:Redis key 命名建议加前缀如 jwt:blacklist:,避免与其他业务冲突

中间件里验证 token 并透传用户信息

不要依赖扩展自带的 JWTMiddleware(它没做异常兜底)。自己写一个轻量中间件:

public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
{
    $tokenStr = $this->getTokenFromRequest($request);
    if (! $tokenStr) {
        throw new AuthenticationException('Missing Authorization header');
    }

    try {
        $token = $this->jwt->parse($tokenStr);
        $user = $this->auth->guard('jwt')->user(); // 此时已可取到用户
        $request = $request->withAttribute('user', $user);
    } catch (\Firebase\JWT\ExpiredException $e) {
        throw new AuthenticationException('Token expired');
    } catch (\Exception $e) {
        throw new AuthenticationException('Invalid token');
    }

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

关键点:

  • 必须用 $this->auth->guard('jwt') 触发自定义 Guard 的 user() 方法,而非直接调 $this->jwt->parse()
  • 异常必须转为 AuthenticationException,否则会被 Hyperf 全局异常处理器吞掉,返回 500 而非 401
  • 黑名单检查应放在 user() 内部(比如在 JWTGuard::user() 里查 $blacklist->has($jti)),而不是中间件里重复解析

真正麻烦的不是签发 token,而是让整个 auth 流程和 Hyperf 的生命周期对齐:Guard 必须能被容器正确实例化,异常必须落在 AuthenticationException 体系内,黑名单必须和 Redis TTL 精确同步——漏掉任意一环,都会表现为「明明 token 没过期却总 401」或「登出后 token 还能用」。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

hyperf 黑名单

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

10484

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

6141

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2115

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

3888

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4574

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3591

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

5137

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

4022

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

12002

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Hyperf官方中文手册(3.1)
Hyperf官方中文手册(3.1)

共0课时 | 0人学习

Swoole系列-从0到1-新手进阶
Swoole系列-从0到1-新手进阶

共29课时 | 2.3万人学习