PHPackages nizerin/hyperf-jwt - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Authentication & Authorization](/categories/authentication) 4. / 5. nizerin/hyperf-jwt ActiveLibrary[Authentication & Authorization](/categories/authentication) nizerin/hyperf-jwt ================== A jwt-auth component build for Hyperf 1.0.1(6y ago)85.6k2[2 issues](https://github.com/PHP-OPEN-HUB/hyperf-jwt/issues)MITPHPPHP >=7.2 Since Oct 10Pushed 6y agoCompare [ Source](https://github.com/PHP-OPEN-HUB/hyperf-jwt)[ Packagist](https://packagist.org/packages/nizerin/hyperf-jwt)[ RSS](/packages/nizerin-hyperf-jwt/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (2)Dependencies (10)Versions (3)Used By (0) ### 基于hyperf() 框架的jwt鉴权(json web token)组件。 [](#基于hyperfhttpsdochyperfiozhreadme-框架的jwt鉴权json-web-token组件) ### 采用基于 进行封装。 [](#采用基于httpsgithubcomlcobuccijwttree33-进行封装) ### 黑名单的设置参考了这篇文章 [](#黑名单的设置参考了这篇文章httpslearnkucomarticles17883) ### 注意： [](#注意) 由于`hyperf`可以升级1.1版本，如果你用1.1版本，请需要修改`jwt-auth`的`composer.json`文件，把依赖`hyperf`的组件版本全部改为~1.1.0或者使用`jwt-auth`的^2.0.1版本，这个版本是针对`hyperf`的1.1版本的 ### 说明： [](#说明) ``` jwt-auth支持单点登录、多点登录、支持注销token(token会失效)、支持刷新token 单点登录：只会有一个token生效，一旦刷新token，前面生成的token都会失效，一般以用户id来做区分 多点登录：token不做限制，一旦刷新token，则当前token会失效 注意：使用单点登录或者多点登录时，必须要开启黑名单，并且使用hyperf的缓存(建议使用redis缓存)。如果不开启黑名单，无法使token失效，生成的token会在有效时间内都可以使用(未更换证书或者secret)。 单点登录原理：JWT有七个默认字段供选择。单点登录主要用到jti默认字段，jti字段的值默认为用户id。当生成token时，getToken方法有一个$isInsertSsoBlack参数来控制是否会把前面生成的token都失效，默认是失效的，如果想不失效，设置为false即可。但是如果是调用refreshToken来刷新token或者调用logout注销token，默认前面生成的token都会失效。 jwt的生成的token加入黑名单时，会把用户id作为缓存的键，当前时间作为值，配置文件中的blacklist_cache_ttl作为缓存的失效时间。每次生成token或者刷新token时，会先从token中拿到签发时间和jti的值，根据jti值找到对应的缓存拿到时间，拿到时间后跟token的签发时间对比，如果签发时间小于等于拿到的时间值，则token判断为失效的。（jti在单点登录中，存的值是用户id） 多点登录原理：多点登录跟单点登录差不多，唯一不同的是jti的值不是用户id，而是一个唯一字符串，每次调用refreshToken来刷新token或者调用logout注销token会默认把请求头中的token加入到黑名单，而不会影响到别的token token不做限制原理：token不做限制，在token有效的时间内都能使用，你只要把配置文件中的blacklist_enabled设置为false即可，即为关闭黑名单功能 ``` ### 使用： [](#使用) ##### 1、拉取依赖 [](#1拉取依赖) ``` composer require nizerin/hyperf-jwt ``` ##### 2、发布配置 [](#2发布配置) ``` php bin/hyperf.php jwt:publish --config ``` ##### 3、jwt配置 [](#3jwt配置) 去配置config/autoload/jwt.php文件或者在配置文件.env里配置 ``` # 务必改为你自己的字符串 JWT_SECRET=hyperf #token过期时间，单位为秒 JWT_TTL=60 ``` 更多的配置请到config/autoload/jwt.php查看 ##### 4、全局路由验证 [](#4全局路由验证) 在config/autoload/middlewaress.php配置文件中加入jwt验证中间件,所有的路由都会进行token的验证，例如： ``` [ Hyperf\JwtAuth\Middleware\JwtAuthMiddleware:class ], ]; ``` ##### 5、局部验证 [](#5局部验证) 在config/routes.php文件中，想要验证的路由加入jwt验证中间件即可，例如： ``` [Hyperf\JwtAuth\Middleware\JwtAuthMiddleware::class]]); ``` ##### 6、注解的路由验证 [](#6注解的路由验证) 请看官方文档：在你想要验证的地方加入jwt验证中间件即可。 ##### 7、模拟登录获取token [](#7模拟登录获取token) ``` request->input('username'); $password = $this->request->input('password'); if ($username && $password) { $userData = [ 'uid' => 1, 'username' => 'xx', ]; $token = (string)$jwt->getToken($userData); return $this->response->json(['code' => 0, 'msg' => '获取token成功', 'data' => ['token' => $token]]); } return $this->response->json(['code' => 0, 'msg' => '登录失败', 'data' => []]); } # http头部必须携带token才能访问的路由 public function getData() { return $this->response->json(['code' => 0, 'msg' => 'success', 'data' => ['a' => 1]]); } } ``` 注意：暂时不支持传入用户对象获取token，后期会支持 ##### 7、路由 [](#7路由) ``` [Hyperf\JwtAuth\Middleware\JwtAuthMiddleware::class]]); ``` ##### 8、鉴权 [](#8鉴权) 在需要鉴权的接口,请求该接口时在HTTP头部加入 ``` Authorization Bearer token ``` ##### 9、结果 [](#9结果) ###### 请求：http://{your ip}:9501/login，下面是返回的结果 [](#请求httpyour-ip9501login下面是返回的结果) ``` { "code": 0, "msg": "获取token成功", "data": { "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NjQ3MzgyNTgsIm5iZiI6MTU2NDczODI1OCwiZXhwIjoxNTY0NzM4MzE4LCJ1aWQiOjEsInVzZXJuYW1lIjoieHgifQ.CJL1rOqRmrKjFpYalY6Wu7JBH6vkbysfvOf-TMQgonQ" } } ``` ###### 请求：http://{your ip}:9501/v1/data [](#请求httpyour-ip9501v1data) ``` { "code": 0, "msg": "success", "data": { "a": 1 } } ``` ##### 10、例子文件 [](#10例子文件) ``` jwt = $jwt; } # 模拟登录 public function login() { $username = $this->request->input('username'); $password = $this->request->input('password'); if ($username && $password) { $userData = [ 'uid' => 1, // 如果使用单点登录，必须存在配置文件中的sso_key的值，一般设置为用户的id 'username' => 'xx', ]; $token = $this->jwt->getToken($userData); $data = [ 'code' => 0, 'msg' => 'success', 'data' => [ 'token' => (string)$token, 'exp' => $this->jwt->getTTL(), ] ]; return $this->response->json($data); } return $this->response->json(['code' => 0, 'msg' => '登录失败', 'data' => []]); } # 刷新token，http头部必须携带token才能访问的路由 public function refreshToken() { $token = $this->jwt->refreshToken(); $data = [ 'code' => 0, 'msg' => 'success', 'data' => [ 'token' => (string)$token, 'exp' => $this->jwt->getTTL(), ] ]; return $this->response->json($data); } # 注销token，http头部必须携带token才能访问的路由 public function logout() { $this->jwt->logout(); return true; } # http头部必须携带token才能访问的路由 public function getData() { $data = [ 'code' => 0, 'msg' => 'success', 'data' => [ 'cache_time' => $this->jwt->getTokenDynamicCacheTime() // 获取token的有效时间，动态的 ] ]; return $this->response->json($data); } } ``` ##### 11、获取解析后的token数据 [](#11获取解析后的token数据) 提供了一个方法`getParserData`来获取解析后的token数据。 例如：$this->jwt->getParserData() ##### 12、建议 [](#12建议) 目前 jwt 抛出的异常目前有两种类型`Hyperf\JwtAuth\Exception\TokenValidException`和`Hyperf\JwtAuth\Exception\JWTException`,`TokenValidException`异常为 token 验证失败的异常，会抛出 401, JWTException 异常会抛出 500 ，最好你们自己在项目异常重新返回错误信息。 ### Health Score 29 — LowBetter than 59% of packages Maintenance15 Infrequent updates — may be unmaintained Popularity28 Limited adoption so far Community4 Small or concentrated contributor base Maturity54 Maturing project, gaining track record How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~0 days Total 2 Last Release 2412d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/573fcf255345bc64772d2c61b862bd91ff59089560d78094eb218a4df1d72e35?d=identicon)[nizerin](/maintainers/nizerin) --- Tags hyperfjwt-authphpphpjwthyperf ### Code Quality Static AnalysisPHPStan Code StylePHP CS Fixer Type Coverage Yes ### Embed Badge ![Health badge](/badges/nizerin-hyperf-jwt/health.svg) ``` [![Health](https://phpackages.com/badges/nizerin-hyperf-jwt/health.svg)](https://phpackages.com/packages/nizerin-hyperf-jwt) ``` ### Alternatives [hyperf-ext/jwt The Hyperf JWT package. 53134.9k2](/packages/hyperf-ext-jwt) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)