@@ -15,20 +15,76 @@
---
+## 前言：️️
+为了保证新同学不迷路，请允许我唠叨一下：无论您从何处看到本篇文章，最新开发文档永远在：[http://sa-token.dev33.cn/](http://sa-token.dev33.cn/)，
+建议收藏在浏览器书签，如果您已经身处本网站下，则请忽略此条说明。
-## 在线资料
-
-- [在线文档：http://sa-token.dev33.cn/](http://sa-token.dev33.cn/)
-
-- [需求提交：我们深知一个优秀的项目需要海纳百川，点我在线提交需求](http://sa-app.dev33.cn/wall.html?name=sa-token)
-
-- [开源不易，求鼓励，点个star吧 ！](###)
-
+用心阅读文档，你学习到的将不止是 `Sa-Token` 框架本身，更是绝大多数场景下权限设计的最佳实践。
## Sa-Token 介绍
-Sa-Token是一个轻量级Java权限认证框架，主要解决：登录认证、权限认证、Session会话、单点登录、OAuth2.0、微服务网关鉴权 等一系列权限相关问题
+**Sa-Token** 是一个轻量级 Java 权限认证框架，主要解决：**`登录认证`**、**`权限认证`**、**`Session会话`**、**`单点登录`**、**`OAuth2.0`**、**`微服务网关鉴权`**
+等一系列权限相关问题。
-框架集成简单、开箱即用、API设计清爽，通过Sa-Token，你将以一种极其简单的方式实现系统的权限认证部分
+
+
+Sa-Token 的 API 调用非常简单，有多简单呢？以登录认证为例，你只需要：
+
+``` java
+// 在登录时写入当前会话的账号id
+StpUtil.login(10001);
+
+// 然后在任意需要校验登录处调用以下API
+// 如果当前会话未登录，这句代码会抛出 `NotLoginException`异常
+StpUtil.checkLogin();
+```
+
+至此，我们已经借助 Sa-Token 完成登录授权！
+
+此时的你小脑袋可能飘满了问号，就这么简单？自定义 Realm 呢？全局过滤器呢？我不用写各种配置文件吗？
+
+事实上在此我可以负责的告诉你，在 Sa-Token 中，登录授权就是如此的简单，不需要什么全局过滤器，不需要各种乱七八糟的配置！只需要这一行简单的API调用，即可完成会话的登录授权！
+
+当你受够 Shiro、SpringSecurity 等框架的三拜九叩之后，你就会明白，相对于这些传统老牌框架，Sa-Token 的 API 设计是多么的简单、优雅！
+
+权限认证示例（只有具备 `user:add` 权限的会话才可以进入请求）
+``` java
+@SaCheckPermission("user:add")
+@RequestMapping("/user/insert")
+public String insert(SysUser user) {
+ // ...
+ return "用户增加";
+}
+```
+
+将某个账号踢下线（待到对方再次访问系统时会抛出`NotLoginException`异常）
+``` java
+// 使账号id为 10001 的会话强制注销登录
+StpUtil.logoutByLoginId(10001);
+```
+
+除了以上的示例，Sa-Token还可以一行代码完成以下功能：
+``` java
+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); // 将当前会话身份临时切换为其它账号
+```
+
+即使不运行测试，相信您也能意会到绝大多数 API 的用法。
+
+
+## Sa-Token 功能一览
- **登录认证** —— 单端登录、多端登录、同端互斥登录、七天内免登录
- **权限认证** —— 权限认证、角色认证、会话二级认证
@@ -59,185 +115,41 @@ Sa-Token是一个轻量级Java权限认证框架，主要解决：登录认证
- **开箱即用** —— 提供SpringMVC、WebFlux等常见web框架starter集成包，真正的开箱即用
- **更多功能正在集成中...** —— 如有您有好想法或者建议，欢迎加群交流
-##### Sa-Token 源码模块一览
-``` js
-── sa-token
- ├── sa-token-core // [核心] Sa-Token 核心模块
- ├── sa-token-starter // [整合] Sa-Token 与其它框架整合
- ├── sa-token-servlet // [整合] Sa-Token 整合 Servlet容器实现类包
- ├── sa-token-spring-boot-starter // [整合] Sa-Token 整合 SpringBoot 快速集成
- ├── sa-token-reactor-spring-boot-starter // [整合] Sa-Token 整合 Reactor响应式编程 快速集成
- ├── sa-token-solon-plugin // [整合] Sa-Token 整合 Solon 快速集成
- ├── sa-token-plugin // [插件] Sa-Token 插件合集
- ├── sa-token-dao-redis // [插件] Sa-Token 整合 Redis (使用jdk默认序列化方式)
- ├── sa-token-dao-redis-jackson // [插件] Sa-Token 整合 Redis (使用jackson序列化方式)
- ├── sa-token-spring-aop // [插件] Sa-Token 整合 SpringAOP 注解鉴权
- ├── sa-token-temp-jwt // [插件] Sa-Token 整合 jwt 临时令牌鉴权
- ├── sa-token-quick-login // [插件] Sa-Token 快速注入登录页插件
- ├── sa-token-alone-redis // [插件] Sa-Token 独立Redis插件，实现[权限缓存与业务缓存分离]
- ├── sa-token-oauth2 // [插件] Sa-Token 实现 OAuth2.0 模块
- ├── sa-token-demo // [示例] Sa-Token 示例合集
- ├── sa-token-demo-springboot // [示例] Sa-Token 整合 SpringBoot
- ├── sa-token-demo-webflux // [示例] Sa-Token 整合 WebFlux
- ├── sa-token-demo-jwt // [示例] Sa-Token 集成 jwt
- ├── sa-token-demo-solon // [示例] Sa-Token 集成 Solon
- ├── sa-token-demo-quick-login // [示例] Sa-Token 集成 quick-login 模块
- ├── sa-token-demo-alone-redis // [示例] Sa-Token 集成 alone-redis 模块
- ├── sa-token-demo-sso1 // [示例] Sa-Token 集成 SSO单点登录-模式一
- ├── sa-token-demo-sso2-server // [示例] Sa-Token 集成 SSO单点登录-模式二 认证中心
- ├── sa-token-demo-sso2-client // [示例] Sa-Token 集成 SSO单点登录-模式二 应用端
- ├── sa-token-demo-sso3-server // [示例] Sa-Token 集成 SSO单点登录-模式三 认证中心
- ├── sa-token-demo-sso3-client // [示例] Sa-Token 集成 SSO单点登录-模式三 应用端
- ├── sa-token-demo-oauth2-server // [示例] Sa-Token 集成 OAuth2.0 (服务端)
- ├── sa-token-demo-oauth2-client // [示例] Sa-Token 集成 OAuth2.0 (客户端)
- ├── sa-token-doc // [文档] Sa-Token 开发文档
- ├──pom.xml // [依赖] 顶级pom文件
-```
-##### Sa-Token 功能结构图
-
-
-##### Sa-Token 认证流程图
-
-
-
-## Sa-Token-SSO 单点登录
-对于单点登录，网上教程大多以CAS模式为主，其实对于不同的系统架构，实现单点登录的步骤也大为不同，Sa-Token由简入难将其划分为三种模式：
-
-| 系统架构 | 采用模式 | 简介 | 文档链接 |
-| :-------- | :-------- | :-------- | :-------- |
-| 前端同域 + 后端同 Redis | 模式一 | 共享Cookie同步会话 | [文档](http://sa-token.dev33.cn/doc/index.html#/sso/sso-type1)、[示例](https://gitee.com/dromara/sa-token/blob/dev/sa-token-demo/sa-token-demo-sso1) |
-| 前端不同域 + 后端同 Redis | 模式二 | URL重定向传播会话 | [文档](http://sa-token.dev33.cn/doc/index.html#/sso/sso-type2)、[示例](https://gitee.com/dromara/sa-token/blob/dev/sa-token-demo/sa-token-demo-sso2-server) |
-| 前端不同域 + 后端 不同Redis | 模式三 | Http请求获取会话 | [文档](http://sa-token.dev33.cn/doc/index.html#/sso/sso-type3)、[示例](https://gitee.com/dromara/sa-token/blob/dev/sa-token-demo/sa-token-demo-sso3-server) |
-
-
-1. 前端同域：就是指多个系统可以部署在同一个主域名之下，比如：`c1.domain.com`、`c2.domain.com`、`c3.domain.com`
-2. 后端同Redis：就是指多个系统可以连接同一个Redis，其它的缓存数据中心亦可。PS：这里并不需要把所有项目的数据都放在同一个Redis中，Sa-Token提供了 **`[权限缓存与业务缓存分离]`** 的解决方案，详情戳：[Alone独立Redis插件](http://sa-token.dev33.cn/doc/index.html#/plugin/alone-redis)
-3. 如果既无法做到前端同域，也无法做到后端同Redis，那么只能走模式三，Http请求获取会话（Sa-Token对SSO提供了完整的封装，你只需要按照示例从文档上复制几段代码便可以轻松集成）
-4. 技术选型一定要根据系统架构对症下药，切不可胡乱选择
-
-
-## Sa-Token-SSO 特性
-1. API简单易用，文档介绍详细，且提供直接可用的集成示例
-2. 支持三种模式，不论是否跨域、是否共享Redis，都可以完美解决
-3. 安全性高：内置域名校验、Ticket校验、秘钥校验等，杜绝`Ticket劫持`、`Token窃取`等常见攻击手段（文档讲述攻击原理和防御手段）
-4. 不丢参数：笔者曾试验多个单点登录框架，均有参数丢失的情况，比如重定向之前是：`http://a.com?id=1&name=2`，登录成功之后就变成了：`http://a.com?id=1`，Sa-Token-SSO内有专门的算法保证了参数不丢失，登录成功之后原路返回页面
-5. 无缝集成：由于Sa-Token本身就是一个权限认证框架，因此你可以只用一个框架同时解决`权限认证` + `单点登录`问题，让你不再到处搜索：xxx单点登录与xxx权限认证如何整合……
-6. 高可定制：Sa-Token-SSO模块对代码架构侵入性极低，结合Sa-Token本身的路由拦截特性，你可以非常轻松的定制化开发
-
-
-## Sa-Token-OAuth2.0 授权登录
-Sa-OAuth2 模块基于 [RFC-6749 标准](https://tools.ietf.org/html/rfc6749) 编写，通过Sa-OAuth2你可以非常轻松的实现系统的OAuth2.0授权认证
-
-1. 授权码（Authorization Code）：OAuth2.0标准授权步骤，Server端向Client端下放Code码，Client端再用Code码换取授权Token
-2. 隐藏式（Implicit）：无法使用授权码模式时的备用选择，Server端使用URL重定向方式直接将Token下放到Client端页面
-3. 密码式（Password）：Client直接拿着用户的账号密码换取授权Token
-4. 客户端凭证（Client Credentials）：Server端针对Client级别的Token，代表应用自身的资源授权
-
-详细参考文档：[http://sa-token.dev33.cn/doc/index.html#/oauth2/readme](http://sa-token.dev33.cn/doc/index.html#/oauth2/readme)
-
-
-## 代码示例
-
-Sa-Token的API调用非常简单，有多简单呢？以登录验证为例，你只需要：
-
-``` java
-// 在登录时写入当前会话的账号id
-StpUtil.login(10001);
-
-// 然后在任意需要校验登录处调用以下API
-// 如果当前会话未登录，这句代码会抛出 `NotLoginException`异常
-StpUtil.checkLogin();
-```
-至此，我们已经借助Sa-Token框架完成登录授权！
-
-此时的你小脑袋可能飘满了问号，就这么简单？自定义Realm呢？全局过滤器呢？我不用写各种配置文件吗？
-
-事实上在此我可以负责的告诉你，在Sa-Token中，登录授权就是如此的简单，不需要什么全局过滤器，不需要各种乱七八糟的配置！只需要这一行简单的API调用，即可完成会话的登录授权！
-
-当你受够Shiro、Spring Security等框架的三拜九叩之后，你就会明白，相对于这些传统老牌框架，Sa-Token的API设计是多么的清爽！
-
-权限认证示例 (只有具有`user:add`权限的会话才可以进入请求)
-``` java
-@SaCheckPermission("user:add")
-@RequestMapping("/user/insert")
-public String insert(SysUser user) {
- // ...
- return "用户增加";
-}
-```
-
-将某个账号踢下线 (待到对方再次访问系统时会抛出`NotLoginException`异常)
-``` java
-// 使账号id为10001的会话注销登录
-StpUtil.logoutByLoginId(10001);
-```
-
-除了以上的示例，Sa-Token还可以一行代码完成以下功能：
-``` java
-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.switchTo(10044); // 将当前会话身份临时切换为其它账号
-```
-Sa-Token API 众多，请恕此处无法为您逐一展示，更多示例请戳官方在线文档
-
-
-## Star 趋势
+## 开源仓库 Star 趋势
[](https://giteye.net/chart/77YQZ6UK)
[](https://starchart.cc/dromara/sa-token)
-
+如果 Sa-Token 帮助到了您，希望您可以为其点上一个 `star`：
+[码云](https://gitee.com/dromara/sa-token)、
+[GitHub](https://github.com/dromara/sa-token)
-## 使用Sa-Token的开源项目
-[**[ sa-plus ]** 一个基于springboot架构的快速开发框架，内置代码生成器](https://gitee.com/click33/sa-plus)
-[**[ jthink ]** 一个基于springboot+sa-token+thymeleaf的博客系统](https://gitee.com/wtsoftware/jthink)
+## 使用Sa-Token的开源项目
+- **[ sa-plus ]**：[一个基于springboot架构的快速开发框架，内置代码生成器](https://gitee.com/click33/sa-plus)
-[**[ dcy-fast ]** 一个基于springboot+sa-token+mybatis-plus的后台管理系统，前端vue-element-admin，并且内置代码生成器](https://gitee.com/dcy421/dcy-fast)
+- **[ jthink ]**： [一个基于springboot+sa-token+thymeleaf的博客系统](https://gitee.com/wtsoftware/jthink)
-[**[ helio-starters ]** 基于JDK15 + Spring Boot 2.4 + Sa-Token + Mybatis-Plus的单体Boot版脚手架和微服务Cloud版脚手架，带有配套后台管理前端模板及代码生成器](https://gitee.com/uncarbon97/helio-starters)
+- **[ dcy-fast ]**：[ 一个基于springboot+sa-token+mybatis-plus的后台管理系统，前端vue-element-admin，并且内置代码生成器](https://gitee.com/dcy421/dcy-fast)
-[**[ sa-token-plugin ]** Sa-Token第三方插件实现，基于Sa-Token-Core，提供一些与官方不同实现机制的的插件集合，作为Sa-Token开源生态的补充，针对spring-boot特性进行针对优化，更加方便于spring-boot一起使用](https://gitee.com/bootx/sa-token-plugin)
+- **[ helio-starters ]**：[ 基于JDK15 + Spring Boot 2.4 + Sa-Token + Mybatis-Plus的单体Boot版脚手架和微服务Cloud版脚手架，带有配套后台管理前端模板及代码生成器](https://gitee.com/uncarbon97/helio-starters)
-[**[ easy-admin ]** 一个基于SpringBoot2 + Sa-Token + Mybatis-Plus + Snakerflow + Layui 的后台管理系统，灵活多变可前后端分离，也可单体，内置代码生成器、权限管理、工作流引擎等](https://gitee.com/lakernote/easy-admin)
+- **[ sa-token-plugin ]**：[Sa-Token第三方插件实现，基于Sa-Token-Core，提供一些与官方不同实现机制的的插件集合，作为Sa-Token开源生态的补充](https://gitee.com/bootx/sa-token-plugin)
+- **[ easy-admin ]**：[一个基于SpringBoot2 + Sa-Token + Mybatis-Plus + Snakerflow + Layui 的后台管理系统，灵活多变可前后端分离，也可单体，内置代码生成器、权限管理、工作流引擎等](https://gitee.com/lakernote/easy-admin)
如果您的项目使用了Sa-Token，欢迎提交pr
## 友情链接
+- **[ okhttps ]**：[ 一个轻量级http通信框架，API设计无比优雅，支持 WebSocket 以及 Stomp 协议](https://gitee.com/ejlchina-zhxu/okhttps)
-[**[ okhttps ]** 一个轻量级http通信框架，API设计无比优雅，支持 WebSocket 以及 Stomp 协议](https://gitee.com/ejlchina-zhxu/okhttps)
+- **[ 小诺快速开发平台 ]**：[ 基于SpringBoot2 + AntDesignVue全新快速开发平台，同时拥有三个版本](https://xiaonuo.vip/index#pricing)
-[**[ 小诺快速开发平台 ]** 基于SpringBoot2 + AntDesignVue全新快速开发平台，同时拥有三个版本](https://xiaonuo.vip/index#pricing)
+- **[ Jpom ]**：[ 简而轻的低侵入式在线构建、自动部署、日常运维、项目监控软件](https://gitee.com/dromara/Jpom)
-[**[ Jpom ]** 简而轻的低侵入式在线构建、自动部署、日常运维、项目监控软件](https://gitee.com/dromara/Jpom)
-
-[**[ TLog ]** 一个轻量级的分布式日志标记追踪神器](https://gitee.com/dromara/TLog)
+- **[ TLog ]**：[ 一个轻量级的分布式日志标记追踪神器](https://gitee.com/dromara/TLog)
## 交流群
@@ -247,6 +159,6 @@ QQ交流群：1002350610 [点击加入](https://jq.qq.com/?_wv=1027&k=45H977HM)
-(扫码添加微信，备注：sa-token，邀您加入群聊)
+（扫码添加微信，备注：sa-token，邀您加入群聊）
diff --git a/sa-token-doc/doc/_sidebar.md b/sa-token-doc/doc/_sidebar.md index ee6e3161..07ceb474 100644 --- a/sa-token-doc/doc/_sidebar.md +++ b/sa-token-doc/doc/_sidebar.md @@ -1,8 +1,8 @@ - **开始** - - [介绍](/README) - - [集成](/start/download) + - [介绍](/) + - [引入](/start/download) - [在SpringBoot环境集成](/start/example) - [在WebFlux环境集成](/start/webflux-example) diff --git a/sa-token-doc/doc/start/download.md b/sa-token-doc/doc/start/download.md index 14de7095..d193795d 100644 --- a/sa-token-doc/doc/start/download.md +++ b/sa-token-doc/doc/start/download.md @@ -1,8 +1,8 @@ -# 集成 Sa-Token +# 引入 Sa-Token 依赖 ------ -## Maven依赖 +## Maven依赖 在项目中直接通过 `pom.xml` 引入 Sa-Token 的依赖即可（四选一）： diff --git a/sa-token-doc/doc/start/webflux-example.md b/sa-token-doc/doc/start/webflux-example.md index fd6a8bee..f7664f07 100644 --- a/sa-token-doc/doc/start/webflux-example.md +++ b/sa-token-doc/doc/start/webflux-example.md @@ -1,6 +1,6 @@ # Spring WebFlux 集成 Sa-Token 示例 -**Reactor** 是一种非阻塞的响应式模型，本篇将 **WebFlux** 以为例，展示 Sa-Token 与 Reactor 响应式模型架相整合的示例， +**Reactor** 是一种非阻塞的响应式模型，本篇将以 **WebFlux** 为例，展示 Sa-Token 与 Reactor 响应式模型框架相整合的示例， **你可以用同样方式去对接其它Reactor模型框架（Netty、ShenYu、SpringCloud Gateway等）** 整合示例在官方仓库的`/sa-token-demo/sa-token-demo-webflux`文件夹下，如遇到难点可结合源码进行测试学习