⚡
开箱即用
forRoot / forRootAsync 一行注册，默认配置即可跑通登录、登出、鉴权、踢人。
xlt-tokenNestJS Token 鉴权库
灵感来源于 Sa-Token · 轻量 · 可插拔 · 零业务侵入
forRoot / forRootAsync 一行注册，默认配置即可跑通登录、登出、鉴权、踢人。
Store、Token 策略、登录校验守卫全部可替换，内置 Memory / Redis Store 与 UUID 策略。
XltTokenGuard 全局鉴权；@XltIgnore / @XltCheckLogin / @LoginId / @TokenValue 五件套覆盖典型场景。
实现 StpInterface 即可启用 @XltCheckPermission / @XltCheckRole，支持 AND/OR 与通配符（user:*）。
XltSession 承载登录期间的扩展数据；被踢/被顶后可查询下线原因和时间。
顶号登录、踢人下线、活跃过期、多端并发等常见鉴权语义在 Recipes 中已有完整范式。
默认 MemoryStore 便于开发，生产推荐 RedisStore，也可实现自定义 Store 对接任何 KV。
195 个测试用例（158 单测 + 37 E2E），单测覆盖率 98%+，E2E 覆盖率 95%+。
配置参考、核心 API、异常矩阵、源码速查与权限/会话指南一站式齐备。
pnpm add xlt-tokennpm install xlt-tokenyarn add xlt-token| 主题 | 文档 | 适合场景 |
|---|---|---|
| 🚀 快速开始 | guide/getting-started | 第一次接入，5 分钟跑通登录/登出 |
| 🏗️ 架构设计 | guide/architecture | 了解分层、存储键结构、并发语义 |
| ⚙️ 配置参考 | guide/configuration | 查阅 XltTokenConfig 字段、forRoot / forRootAsync |
| 🧠 核心 API | core/core-api | StpLogic / StpUtil 所有方法与时序 |
| 🛡️ 守卫与装饰器 | core/guards-and-decorators | XltTokenGuard / @LoginId / @XltIgnore 等六大装饰器 |
| 🔑 权限与会话 | core/permissions-and-session | StpInterface / @XltCheckPermission / @XltCheckRole / XltSession |
| 💾 存储层 | core/storage | MemoryStore / RedisStore / 自定义 Store |
| 🎨 Token 策略 | core/token-strategy | uuid / simple-uuid / random-32，接入 JWT |
| ⚠️ 异常处理 | core/exceptions | NotLoginException / NotPermissionException / NotRoleException |
| 🧪 场景手册 | core/recipes | 顶号、踢人、活跃过期、多端并发、用户注入等 |
| 📖 源码参考 | reference/src-reference | 一站式深度参考（单文件速查） |