mirror of https://gitee.com/dromara/sa-token.git synced 2024-12-03 04:17:37 +08:00

History

CrazyLionLi 32bb677e26 增加 1.2K star的开源项目		2021-09-24 11:37:38 +08:00
..
fun	文档新增自定义 SaTokenContext 指南	2021-09-15 22:15:50 +08:00
lib	文档增加示例	2021-09-14 22:18:42 +08:00
micro	优化文档	2021-07-24 22:21:26 +08:00
more	修复路由鉴权文档示例错误之处	2021-09-22 10:17:14 +08:00
oauth2	新增SSO与OAuth2技术对比文档	2021-09-15 02:19:06 +08:00
plugin	优化SSO相关文档	2021-08-24 02:05:16 +08:00
sso	优化文档	2021-09-01 04:25:54 +08:00
start	文档新增自定义 SaTokenContext 指南	2021-09-15 22:15:50 +08:00
up	v1.26.1 beta	2021-09-09 02:37:40 +08:00
use	修复路由鉴权文档示例错误之处	2021-09-22 10:17:14 +08:00
_sidebar.md	文档新增自定义 SaTokenContext 指南	2021-09-15 22:15:50 +08:00
index.html	v1.26.1 beta	2021-09-09 02:37:40 +08:00
logo-150.png	v1.4.0更新	2020-09-07 02:21:35 +08:00
logo.png	完善文档	2020-02-06 00:52:49 +08:00
README.md	增加 1.2K star的开源项目	2021-09-24 11:37:38 +08:00

README.md

Sa-Token v1.26.0

一个轻量级 Java 权限认证框架，让鉴权变得简单、优雅！

前言：️️

为了保证新同学不迷路，请允许我唠叨一下：无论您从何处看到本篇文章，最新开发文档永远在：http://sa-token.dev33.cn/，建议收藏在浏览器书签，如果您已经身处本网站下，则请忽略此条说明。

本文档将会尽力讲解每个功能的设计原因、应用场景，用心阅读文档，你学习到的将不止是 Sa-Token 框架本身，更是绝大多数场景下权限设计的最佳实践。

Sa-Token 介绍

Sa-Token 是一个轻量级 Java 权限认证框架，主要解决：登录认证、权限认证、Session会话、单点登录、OAuth2.0、微服务网关鉴权 等一系列权限相关问题。

Sa-Token 的 API 设计非常简单，有多简单呢？以登录认证为例，你只需要：

// 在登录时写入当前会话的账号id
StpUtil.login(10001);

// 然后在需要校验登录处调用以下方法：
// 如果当前会话未登录，这句代码会抛出 `NotLoginException` 异常
StpUtil.checkLogin();

至此，我们已经借助 Sa-Token 完成登录认证！

此时的你小脑袋可能飘满了问号，就这么简单？自定义 Realm 呢？全局过滤器呢？我不用写各种配置文件吗？

没错，在 Sa-Token 中，登录认证就是如此简单，不需要任何的复杂前置工作，只需这一行简单的API调用，就可以完成会话登录认证！

当你受够 Shiro、SpringSecurity 等框架的三拜九叩之后，你就会明白，相对于这些传统老牌框架，Sa-Token 的 API 设计是多么的简单、优雅！

权限认证示例（只有具备 user:add 权限的会话才可以进入请求）

@SaCheckPermission("user:add")
@RequestMapping("/user/insert")
public String insert(SysUser user) {
	// ... 
	return "用户增加";
}

将某个账号踢下线（待到对方再次访问系统时会抛出NotLoginException异常）

// 使账号id为 10001 的会话强制注销登录
StpUtil.logoutByLoginId(10001);

在 Sa-Token 中，绝大多数功能都可以 一行代码 完成：

StpUtil.login(10001);                     // 标记当前会话登录的账号id
StpUtil.getLoginId();                     // 获取当前会话登录的账号id
StpUtil.isLogin();                        // 获取当前会话是否已经登录, 返回true或false
StpUtil.logout();                         // 当前会话注销登录
StpUtil.logoutByLoginId(10001);           // 让账号为10001的会话注销登录（踢人下线）
StpUtil.hasRole("super-admin");           // 查询当前账号是否含有指定角色标识, 返回true或false
StpUtil.hasPermission("user:add");        // 查询当前账号是否含有指定权限, 返回true或false
StpUtil.getSession();                     // 获取当前账号id的Session
StpUtil.getSessionByLoginId(10001);       // 获取账号id为10001的Session
StpUtil.getTokenValueByLoginId(10001);    // 获取账号id为10001的token令牌值
StpUtil.login(10001, "PC");               // 指定设备标识登录，常用于“同端互斥登录”
StpUtil.logoutByLoginId(10001, "PC");     // 指定设备标识进行强制注销 (不同端不受影响)
StpUtil.openSafe(120);                    // 在当前会话开启二级认证，有效期为120秒 
StpUtil.checkSafe();                      // 校验当前会话是否处于二级认证有效期内，校验失败会抛出异常 
StpUtil.switchTo(10044);                  // 将当前会话身份临时切换为其它账号