sa-token/sa-token-doc/README.md

148 lines
7.2 KiB
Markdown
Raw Normal View History

<p align="center">
2022-10-21 11:27:29 +08:00
<img alt="logo" src="https://sa-token.cc/logo.png" width="150" height="150">
2020-09-07 02:21:35 +08:00
</p>
2022-11-16 19:52:42 +08:00
<h1 align="center" style="margin: 30px 0 30px; font-weight: bold;">Sa-Token v1.33.0</h1>
2021-08-24 19:16:25 +08:00
<h5 align="center">一个轻量级 Java 权限认证框架,让鉴权变得简单、优雅!</h5>
2021-12-24 07:45:19 +08:00
<p align="center" class="badge-box">
2021-11-08 00:50:14 +08:00
<a href="https://gitee.com/dromara/sa-token/stargazers"><img src="https://gitee.com/dromara/sa-token/badge/star.svg?theme=gvp"></a>
<a href="https://gitee.com/dromara/sa-token/members"><img src="https://gitee.com/dromara/sa-token/badge/fork.svg?theme=gvp"></a>
2021-03-30 18:00:45 +08:00
<a href="https://github.com/dromara/sa-token/stargazers"><img src="https://img.shields.io/github/stars/dromara/sa-token?style=flat-square&logo=GitHub"></a>
<a href="https://github.com/dromara/sa-token/network/members"><img src="https://img.shields.io/github/forks/dromara/sa-token?style=flat-square&logo=GitHub"></a>
<a href="https://github.com/dromara/sa-token/watchers"><img src="https://img.shields.io/github/watchers/dromara/sa-token?style=flat-square&logo=GitHub"></a>
<a href="https://github.com/dromara/sa-token/issues"><img src="https://img.shields.io/github/issues/dromara/sa-token.svg?style=flat-square&logo=GitHub"></a>
<a href="https://github.com/dromara/sa-token/blob/master/LICENSE"><img src="https://img.shields.io/github/license/dromara/sa-token.svg?style=flat-square"></a>
2021-06-19 23:08:14 +08:00
</p>
2020-09-07 02:21:35 +08:00
---
2020-12-15 01:06:12 +08:00
2021-08-22 22:17:40 +08:00
## 前言:️️
2022-10-21 11:27:29 +08:00
为了保证新同学不迷路,请允许我唠叨一下:无论您从何处看到本篇文章,最新开发文档永远在:[https://sa-token.cc](https://sa-token.cc)
2021-08-22 22:17:40 +08:00
建议收藏在浏览器书签,如果您已经身处本网站下,则请忽略此条说明。
2020-12-15 01:06:12 +08:00
2021-08-24 02:05:16 +08:00
本文档将会尽力讲解每个功能的设计原因、应用场景,用心阅读文档,你学习到的将不止是 `Sa-Token` 框架本身,更是绝大多数场景下权限设计的最佳实践。
2021-06-03 23:30:16 +08:00
2021-08-24 22:24:11 +08:00
2021-07-19 01:12:55 +08:00
## Sa-Token 介绍
2021-08-24 22:24:11 +08:00
2022-06-14 03:56:16 +08:00
**Sa-Token** 是一个轻量级 Java 权限认证框架,主要解决:**登录认证**、**权限认证**、**单点登录**、**OAuth2.0**、**分布式Session会话**、**微服务网关鉴权**
2021-08-22 22:17:40 +08:00
等一系列权限相关问题。
2021-07-02 21:42:13 +08:00
2022-10-21 11:27:29 +08:00
Sa-Token 旨在以简单、优雅的方式完成系统的权限认证部分,以登录认证为例,你只需要:
2021-01-02 04:00:49 +08:00
2020-12-15 01:06:12 +08:00
``` java
2022-10-21 11:27:29 +08:00
// 会话登录参数填登录人的账号id
2021-06-16 16:24:39 +08:00
StpUtil.login(10001);
2022-10-21 11:27:29 +08:00
```
无需实现任何接口,无需创建任何配置文件,只需要这一句静态代码的调用,便可以完成会话登录认证。
2020-12-15 01:06:12 +08:00
2022-10-21 11:27:29 +08:00
如果一个接口需要登录后才能访问,我们只需调用以下代码:
``` java
// 校验当前客户端是否已经登录,如果未登录则抛出 `NotLoginException` 异常
2021-02-07 12:01:51 +08:00
StpUtil.checkLogin();
2020-12-15 01:06:12 +08:00
```
2021-01-17 17:31:40 +08:00
2022-10-21 11:27:29 +08:00
在 Sa-Token 中,大多数功能都可以一行代码解决:
2021-08-22 22:17:40 +08:00
2022-10-21 11:28:46 +08:00
踢人下线:
2021-01-17 17:31:40 +08:00
2022-10-21 11:27:29 +08:00
``` java
// 将账号id为 10077 的会话踢下线
StpUtil.kickout(10077);
```
2021-01-17 17:31:40 +08:00
2022-10-21 11:27:29 +08:00
权限认证:
2020-12-15 01:06:12 +08:00
2021-01-13 20:35:33 +08:00
``` java
2022-10-21 11:27:29 +08:00
// 注解鉴权:只有具备 `user:add` 权限的会话才可以进入方法
2021-02-07 12:01:51 +08:00
@SaCheckPermission("user:add")
2021-01-13 20:35:33 +08:00
public String insert(SysUser user) {
2022-10-21 11:27:29 +08:00
// ...
return "用户增加";
2021-01-13 20:35:33 +08:00
}
```
2022-10-21 11:27:29 +08:00
路由拦截鉴权:
2021-01-13 20:35:33 +08:00
2021-01-02 04:00:49 +08:00
``` java
2022-10-21 11:27:29 +08:00
// 根据路由划分模块,不同模块不同鉴权
registry.addInterceptor(new SaInterceptor(handler -> {
SaRouter.match("/user/**", r -> StpUtil.checkPermission("user"));
SaRouter.match("/admin/**", r -> StpUtil.checkPermission("admin"));
SaRouter.match("/goods/**", r -> StpUtil.checkPermission("goods"));
SaRouter.match("/orders/**", r -> StpUtil.checkPermission("orders"));
SaRouter.match("/notice/**", r -> StpUtil.checkPermission("notice"));
// 更多模块...
})).addPathPatterns("/**");
2021-01-02 04:00:49 +08:00
```
2022-10-21 11:27:29 +08:00
当你受够 Shiro、SpringSecurity 等框架的三拜九叩之后你就会明白相对于这些传统老牌框架Sa-Token 的 API 设计是多么的简单、优雅!
2021-03-29 01:38:44 +08:00
2021-08-24 22:24:11 +08:00
2021-08-22 22:17:40 +08:00
## Sa-Token 功能一览
2021-01-17 17:31:40 +08:00
2022-10-21 11:27:29 +08:00
Sa-Token 目前主要五大功能模块登录认证、权限认证、单点登录、OAuth2.0、微服务鉴权。
2021-08-22 22:17:40 +08:00
- **登录认证** —— 单端登录、多端登录、同端互斥登录、七天内免登录
- **权限认证** —— 权限认证、角色认证、会话二级认证
- **Session会话** —— 全端共享Session、单端独享Session、自定义Session
- **踢人下线** —— 根据账号id踢人下线、根据Token值踢人下线
2022-10-21 11:27:29 +08:00
- **账号封禁** —— 登录封禁、按照业务分类封禁、按照处罚阶梯封禁
2021-08-22 22:17:40 +08:00
- **持久层扩展** —— 可集成Redis、Memcached等专业缓存中间件重启数据不丢失
- **分布式会话** —— 提供jwt集成、共享数据中心两种分布式会话方案
- **微服务网关鉴权** —— 适配Gateway、ShenYu、Zuul等常见网关的路由拦截认证
- **单点登录** —— 内置三种单点登录模式无论是否跨域、是否共享Redis都可以搞定
2022-08-20 09:59:19 +08:00
- **OAuth2.0认证** —— 轻松搭建 OAuth2.0 服务支持openid模式
2021-08-22 22:17:40 +08:00
- **二级认证** —— 在已登录的基础上再次认证,保证安全性
2021-08-31 02:10:40 +08:00
- **Basic认证** —— 一行代码接入 Http Basic 认证
2021-08-22 22:17:40 +08:00
- **独立Redis** —— 将权限缓存与业务缓存分离
2022-10-21 11:27:29 +08:00
- **临时Token认证** —— 解决短时间的Token授权问题
2021-08-22 22:17:40 +08:00
- **模拟他人账号** —— 实时操作任意用户状态数据
- **临时身份切换** —— 将会话身份临时切换为其它账号
- **前后台分离** —— APP、小程序等不支持Cookie的终端
- **同端互斥登录** —— 像QQ一样手机电脑同时在线但是两个手机上互斥登录
- **多账号认证体系** —— 比如一个商城项目的user表和admin表分开鉴权
2022-10-21 11:27:29 +08:00
- **Token风格定制** —— 内置六种Token风格还可自定义Token生成策略、自定义Token前缀
2021-08-22 22:17:40 +08:00
- **注解式鉴权** —— 优雅的将鉴权与业务代码分离
- **路由拦截式鉴权** —— 根据路由拦截鉴权可适配restful模式
- **自动续签** —— 提供两种Token过期策略灵活搭配使用还可自动续签
- **会话治理** —— 提供方便灵活的会话查询接口
- **记住我模式** —— 适配[记住我]模式,重启浏览器免验证
- **密码加密** —— 提供密码加密模块可快速MD5、SHA1、SHA256、AES、RSA加密
- **全局侦听器** —— 在用户登陆、注销、被踢下线等关键性操作时进行一些AOP操作
- **开箱即用** —— 提供SpringMVC、WebFlux等常见web框架starter集成包真正的开箱即用
- **更多功能正在集成中...** —— 如有您有好想法或者建议,欢迎加群交流
2021-03-29 01:38:44 +08:00
2022-10-21 11:27:29 +08:00
功能结构图:
![sa-token-js](https://color-test.oss-cn-qingdao.aliyuncs.com/sa-token/x/sa-token-js4.png 's-w')
2021-03-29 01:38:44 +08:00
2021-08-22 22:17:40 +08:00
## 开源仓库 Star 趋势
2021-12-24 00:58:01 +08:00
<p class="un-dec-a-pre"></p>
2021-08-22 22:17:40 +08:00
[![github-chart](https://starchart.cc/dromara/sa-token.svg 'GitHub')](https://starchart.cc/dromara/sa-token)
2021-01-17 17:31:40 +08:00
2021-08-22 22:17:40 +08:00
如果 Sa-Token 帮助到了您,希望您可以为其点上一个 `star`
[码云](https://gitee.com/dromara/sa-token)、
[GitHub](https://github.com/dromara/sa-token)
2021-01-17 17:31:40 +08:00
2021-04-12 20:25:10 +08:00
2021-08-22 22:17:40 +08:00
## 使用Sa-Token的开源项目
2022-03-16 16:51:14 +08:00
参考:[Sa-Token 生态](/more/link)
2021-07-27 05:08:50 +08:00
2020-02-06 00:52:49 +08:00
2022-10-21 11:27:29 +08:00
2021-03-29 01:38:44 +08:00
## 交流群
2022-10-28 18:09:44 +08:00
QQ交流群707350988 [点击加入](https://jq.qq.com/?_wv=1027&k=tqbzHT2D)
2020-02-06 00:52:49 +08:00
2021-03-29 01:38:44 +08:00
微信交流群:
2020-02-06 00:52:49 +08:00
2021-09-13 01:52:43 +08:00
![微信群](https://dev33-test.oss-cn-beijing.aliyuncs.com/sa-token/i-wx-qr.png ':size=230')
2021-03-02 11:24:28 +08:00
2021-09-13 01:52:43 +08:00
扫码添加微信备注sa-token邀您加入群聊
2021-01-29 18:57:06 +08:00
2021-02-07 12:01:51 +08:00
<br>