<!DOCTYPE html>
<html lang="zh">
<head>
<meta charset="UTF-8">
<title>Sa-Token</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="description"
content="Sa-Token是一个java权限认证框架,功能全面,上手简单,登录认证、权限认证、Session会话、踢人下线、账号封禁、集成Redis、前后端分离、分布式会话、微服务网关鉴权、单点登录、OAuth2.0、临时Token验证、记住我模式、模拟他人账号、临时身份切换、多账号体系、注解式鉴权、路由拦截式鉴权、花式token、自动续签、同端互斥登录、会话治理、密码加密、jwt集成、Spring集成、WebFlux集成...,有了sa-token,你所有的权限认证问题,都不再是问题">
<meta name="keywords" content="sa-token,sa-token框架,sa-token文档,java权限认证">
<meta name="viewport"
content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
<link rel="shortcut icon" type="image/x-icon" href="logo.png">
<link rel="stylesheet" href="./static/doc.css">
<link rel="stylesheet" href="./static/vue.css">
</head>
<body>
<div class="doc-header">
<div class="nav-left">
<a href="doc.html">
<div class="logo-box">
<img src="logo.png" title="logo" />
<h1 class="logo-text">Sa-Token</h1>
<sub>v1.44.0</sub>
</div>
</a>
</div>
<nav class="nav-right">
<div class="sear-box p-none" tabindex="-1">
</div>
<select class="select-version p-none" onchange="location.href=this.value">
<option value="doc.html">最新版</option>
<option value="v/v1.43.0/doc.html">v1.43.0</option>
<option value="v/v1.42.0/doc.html">v1.42.0</option>
<option value="v/v1.41.0/doc.html">v1.41.0</option>
<option value="v/v1.40.0/doc.html">v1.40.0</option>
<option value="v/v1.39.0/doc.html">v1.39.0</option>
<option value="v/v1.38.0/doc.html">v1.38.0</option>
<option value="v/v1.37.0/doc.html">v1.37.0</option>
<option value="v/v1.36.0/doc.html">v1.36.0</option>
<option value="v/v1.35.0/doc.html">v1.35.0</option>
<option value="v/v1.34.0/doc.html">v1.34.0</option>
<option value="v/v1.33.0/doc.html">v1.33.0</option>
<option value="v/v1.32.0/doc.html">v1.32.0</option>
<option value="v/v1.31.0/doc.html">v1.31.0</option>
<option value="v/v1.30.0/doc/index.html">v1.30.0</option>
<option value="v/v1.29.0/doc/index.html">v1.29.0</option>
<option value="v/v1.28.0/doc/index.html">v1.28.0</option>
<option value="v/v1.27.0/doc/index.html">v1.27.0</option>
<option value="v/v1.26.0/doc/index.html">v1.26.0</option>
<option value="v/v1.25.0/doc/index.html">v1.25.0</option>
<option value="v/v1.24.0/doc/index.html">v1.24.0</option>
<option value="v/v1.23.0/doc/index.html">v1.23.0</option>
<option value="v/v1.22.0/doc/index.html">v1.22.0</option>
<option value="v/v1.21.0/doc/index.html">v1.21.0</option>
<option value="v/v1.20.0/doc/index.html">v1.20.0</option>
<option value="v/v1.19.0/doc/index.html">v1.19.0</option>
<option value="v/v1.18.0/doc/index.html">v1.18.0</option>
<option value="v/v1.17.0/doc/index.html">v1.17.0</option>
<option value="v/v1.16.0/doc/index.html">v1.16.0</option>
<option value="v/v1.15.0/doc/index.html">v1.15.0</option>
<option value="v/v1.14.0/doc/index.html">v1.14.0</option>
<option value="v/v1.13.0/doc/index.html">v1.13.0</option>
<option value="v/v1.12.1/doc/index.html">v1.12.1</option>
<option value="v/v1.12.0/doc/index.html">v1.12.0</option>
<option value="v/v1.11.0/doc/index.html">v1.11.0</option>
<option value="v/v1.10.0/doc/index.html">v1.10.0</option>
<option value="v/v1.9.0/doc/index.html">v1.9.0</option>
<option value="v/v1.8.0/doc/index.html">v1.8.0</option>
<option value="v/v1.7.0/doc/index.html">v1.7.0</option>
<option value="v/v1.6.0/doc/index.html">v1.6.0</option>
<option value="v/v1.5.1/doc/index.html">v1.5.1</option>
<option value="v/v1.4.0/doc/index.html">v1.4.0</option>
<option value="v/v1.3.0/doc/index.html">v1.3.0</option>
<option value="v/v1.2.0/doc/index.html">v1.2.0</option>
<option value="v/v1.1.0/doc/index.html">v1.1.0</option>
<option value="v/v1.0.0/doc/index.html">v1.0.0</option>
<option value="/">首页</option>
</select>
<div class="zk-box p-none">
<a class="wzi" href="javascript:;">
<img class="theme-btn" src="static/icon/theme.svg">
</a>
<div class="zk-context theme-box">
<div>
<div style="height: 5px;"></div>
<span style="background-color: #FFFFFF;"></span>
<span style="background-color: #f5f5f5;"></span>
<span style="background-color: #f5e5f5;"></span>
<span style="background-color: #F1FAFA;"></span>
<span style="background-color: #f5f5d5;"></span>
<span style="background-color: #E8E8FF;"></span>
<span style="background-color: #f0f9eb;"></span>
<span style="background-color: #d5f5f5;"></span>
<span style="background-color: #ebe5dd;"></span>
<span style="background-color: #e8f4ff;"></span>
</div>
</div>
</div>
<a class="wzi" href="index.html">首页</a>
<a class="wzi" href="doc.html">文档</a>
<div class="zk-box">
<a class="wzi" href="javascript:;">
<span>视频 </span>
<span class="zk-icon"></span>
</a>
<div class="zk-context">
<div>
<a href="https://www.bilibili.com/video/BV1fsUVBWEyH/" target="_blank">朱老师的小课堂(7集)</a>
<a href="https://www.bilibili.com/video/BV1NF1FBpEe6/" target="_blank">王清江唷 SSO篇(29集)</a>
<a href="https://www.bilibili.com/video/BV1uZUpYVEst/" target="_blank">fox说技术(7集)</a>
<a href="https://www.bilibili.com/video/BV1eFtRezERp?p=87" target="_blank">架构驿站(11集)</a>
<a href="https://www.bilibili.com/video/BV1Zt421u7gk/" target="_blank">王清江唷(99集)</a>
<a href="https://www.bilibili.com/video/BV1kG411o7Ms/" target="_blank">筑梦信仰-joy(20集)</a>
<a href="https://www.bilibili.com/video/BV11u4y197JL/" target="_blank">达达-Java(26集)</a>
<a href="https://space.bilibili.com/473679148/video" target="_blank">晒太阳的盐(22集)</a>
<div class="zk-fengexian"></div>
<a href="doc.html#/more/content-cooperation">[ + 课程提交 ]</a>
[ + 课程提交 ]
</a> -->
</div>
</div>
</div>
<a class="p-none wzi" href="#/more/link">案例</a>
<a class="p-none wzi" href="#/more/join-group">加入讨论群</a>
<a class="p-none wzi" href="#/more/demand-commit">需求提交</a>
<a class="p-none wzi" href="#/more/blog">博客</a>
<a class="p-none wzi" href="#/more/sa-token-donate">赞助</a>
<a class="p-none wzi" href="#/pro/st_doc_top">🔥 SSO/OAuth2 商业版</a>
<div class="zk-box">
<a class="wzi" href="javascript:;">
<span>相关资源 </span>
<span class="zk-icon"></span>
</a>
<div class="zk-context">
<div>
<a href="#/more/update-log">更新日志</a>
<a href="#/more/common-questions">常见报错</a>
<a href="#/more/tj-gzh">推荐公众号</a>
<a href="#/more/blog">相关博客</a>
<div class="zk-fengexian"></div>
<a href="#/fun/sa-token-test">在线考试</a>
<a href="#/fun/issue-template">在线提问</a>
<a href="#/more/wenjuan">问卷调查</a>
</div>
</div>
</div>
</nav>
</div>
<div class="logo-box">
<img src="logo.png" title="logo" />
<h1 class="logo-text">Sa-Token</h1>
</div>
</a> -->
<div class="main-box">
<div id="app">加载中...</div>
<div class="doc-right-bj-box">
<div class="doc-right-bj-box-title">目录</div>
<div class="doc-right-more-item">
<div class="ad-box">
<div class="ad-title">
<span class="ad-tips">推广信息:</span>
<span class="ad-tips ad-close">关闭</span>
</div>
<div class="top-ad-box" style="margin-bottom: 12px;">
<a href="https://sa-pro.yun94.cn?way=st_r" target="_blank">
<div class="mad-bg-box">
<div class="mad-context-box">
<img class="mad-img" src="/big-file/contact/sspx-ad-11.png" />
<span class="mad-text">
<b>轻松搭建:SSO 单点登录、OAuth2.0 统一认证、API Key、用户数据同步。全源码交付、可二开。</b>
</span>
</div>
</div>
</a>
</div>
<div class="wwads-cn wwads-horizontal" data-id="88"
style="min-height: 0px; border: 1px #eee solid; margin-bottom: 12px;"></div>
</div>
<div class="ew-wa">
<p>
<a href="https://pan.quark.cn/s/d5abda720e88" target="_blank">离线版文档</a>
<a href="https://pan.quark.cn/s/fea7e5ec72ee" target="_blank">历史所有版本文档</a>
</p>
</div>
<div class="ew-wa">
<p>如果 Sa-Token 帮助到了你,希望你可以向同事、朋友推荐了解本框架,这对我们非常重要,感谢支持! </p>
<p>加油,工程师!</p>
</div>
</div>
</div>
</div>
<div class="wwads-cn wwads-vertical" data-id="88" style="max-width:150px"></div>
</div> -->
<div class="help-tips" style="position: relative; left: -30px; top: -10px;"></div>
<div class="help-btn" style="width: 60px; height: 60px; text-align: center; border-radius: 50%; background-color: #42b983; cursor: pointer;">
<span style="font-size: 18px; color: #FFF; line-height: 60px;">Help</span>
</div>
</div> -->
<style type="text/css">
body {
opacity: 0.01;
transition: opacity 0.5s;
background-color: #FFF;
}
</style>
<script type="text/javascript">
setTimeout(function() {
document.body.style.opacity = 1;
}, 1);
</script>
<script src="static/jquery.min.js"></script>
<script src="static/layer-v3.1.1/layer.js"></script>
<script src="./static/docsify-plugin.js?v=7"></script>
<script src="./static/is-star-plugin.js?v=7"></script>
<link rel="stylesheet" href="./static/custom-docsify-plugins/doc-lock-plugin.css">
<script>
var saTokenTopVersion = '1.44.0';
var name = '<img style="width: 60px; height: 60px; vertical-align: middle;" src="logo.png" alt="logo" /> ';
name += '<b style="font-size: 28px; vertical-align: middle;">Sa-Token</b> <sub>v' + saTokenTopVersion + '</sub>';
window.$docsify = {
repo: 'https://github.com/dromara/sa-token',
basePath: location.pathname.substr(0, location.pathname.lastIndexOf('/') + 1),
auto2top: true,
subMaxLevel: 4,
loadSidebar: true,
copyCode: {
buttonText: '复制到剪贴板',
errorText: '错误',
successText: '复制成功'
},
topMargin: 90,
alias: {
'/.*/_sidebar.md': '/_sidebar.md'
},
tabs: {
persist: true,
sync: false,
theme: 'classic',
tabComments: true,
tabHeadings: true
},
progress: {
position: "top",
color: "var(--theme-color,#42b983)",
height: "3px",
},
'flexible-alerts': {
style: 'flat',
note: {
label: {}
},
tip: {
label: {},
},
warning: {
label: {}
},
attention: {
label: {}
},
},
plugins: [
myDocsifyPlugin,
],
}
</script>
<script src="static/docsify.min.js"></script>
<script src="static/docsify-copy-code.min.js"></script>
<script src="static/prism/prism-java.min.js"></script>
<script src="static/prism/prism-gradle.min.js"></script>
<script src="static/prism/prism-yaml.min.js"></script>
<script src="static/prism/prism-properties.min.js"></script>
<script src="static/docsify-plugins/sub-nav-draw.js"></script>
<script src="static/search.min.js"></script>
<script src="static/docsify-tabs.min.js"></script>
<script src="static/zoom-image.min.js"></script>
<script src="static/docsify-plugins/docsify-plugin-flexible-alerts.min-1.1.1.js"></script>
<script src="static/docsify-plugins/docsify-betterembed-1.1.1.js"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify-sidebar-collapse/dist/docsify-sidebar-collapse.min.js"></script> -->
<script src="static/donate/donate-list.js"></script>
<script src="static/donate/donate-fun.js"></script>
<script>
(function() {
if ($(window).width() >= 800) {
let allowJg = 1000 * 60 * 60 * 24 * 1;
try {
const closeAdTime = localStorage.closeAdTime;
if (closeAdTime) {
const closeAdJg = new Date().getTime() - parseInt(closeAdTime);
if (closeAdJg < allowJg) {
console.log('not show ad ...');
$('.ad-box').remove();
return;
}
}
} catch (e) {
console.error(e);
}
$('.ad-close').click(function() {
console.log('关闭广告');
layer.confirm('关闭后,一天内不再展现此信息', function() {
$(".ad-box").fadeOut(1000);
layer.msg('关闭成功');
localStorage.closeAdTime = new Date().getTime();
})
})
}
})();
</script>
<script>
(function() {
var bp = document.createElement('script');
var curProtocol = window.location.protocol.split(':')[0];
if (curProtocol === 'https') {
bp.src = 'https://zz.bdstatic.com/linksubmit/push.js';
} else {
bp.src = 'http://push.zhanzhang.baidu.com/push.js';
}
var s = document.getElementsByTagName("script")[0];
s.parentNode.insertBefore(bp, s);
})();
</script>
<script data-mode="hash" type="text/javascript" src="https://cdn.wwads.cn/js/makemoney.js" async></script>
<script>
var _hmt = _hmt || [];
(function() {
var hm = document.createElement("script");
hm.src = "https://hm.baidu.com/hm.js?35ad501304eae758ac6139a22a9830f5";
var s = document.getElementsByTagName("script")[0];
s.parentNode.insertBefore(hm, s);
})();
</script>
<script type="text/javascript">
// 预览版提示
if (location.host === 'rc.sa-token.cc') {
const newTips =
'<b>当前文档为RC预览版文档,仅做学习测试使用,正式项目请使用正式版:<a href="https://sa-token.cc/" target="_blank">https://sa-token.cc/</a></b>';
layer.alert(newTips);
}
</script>
<script>
$('.help-btn').click(function() {
var str = `
<div class="xiaozhushou-intro">
<h2>报错了?搞不懂?别急、莫慌</h2>
<div style="margin-top: 20px; color: green;">
<p>👉 你的问题可能很多人都碰到过了!这有一份高频报错速查文档:<a href="doc.html#/more/common-questions" onclick="layer.closeAll()">常见问题排查</a></p>
<p>👉 几乎每个功能点都有对应的最简示例 Demo,或许可以给你一份参考:<a href="https://gitee.com/dromara/sa-token/tree/master/sa-token-demo" target="_blank" >sa-token-demo</a></p>
<p>👉 复杂功能玩不转?来看看这些优秀开源案例是怎么集成 Sa-Token 的:<a href="https://gitee.com/sa-tokens/awesome-sa-token" target="_blank" >awesome-sa-token</a></p>
</div>
<div style="margin-top: 20px; color: red;">上述方案没有解决你的问题?那你可以来“麻烦”一下我们的小助手了:</div>
<p>1、你在使用 Sa-Token 时遇到任何技术难题,可以向 < sa-token 小助手 > 求助咨询。</p>
<p>2、该小助手不属于商业运营,求助咨询完全免费。</p>
<p>3、目前该小助手属于试运营阶段,每天只能提供大约 1 小时的求助时间。</p>
<p>4、根据运营效果反馈,我们日后可能会提高求助时间,但也可能关闭此功能。</p>
<p>5、该小助手由企业微信提供平台支持,感谢企业微信。</p>
<p>6、不是 AI 是真人,不是 AI 是真人,不是 AI 是真人,重说三!</p>
<p style="margin-top: 30px;">打开方式:</p>
<p>1、如果你是使用 PC 端微信,请点此链接:<a href="https://work.weixin.qq.com/kfid/kfcdd45c432fee9655f" target="_blank">https://work.weixin.qq.com/kfid/kfcdd45c432fee9655f</a></p>
<p>2、如果你是使用手机端微信,请扫码:</p>
<p><img src="/big-file/contact/sa-token-xiaozhushou.jpg" width="200px"></p>
<p>如果您的问题已解决,我们希望您能够花费一点时间将解决方案发布在:<a href="https://gitee.com/dromara/sa-token/issues/I9I9CY" target="_blank">踩坑记录征集</a>,帮助以后遇到同样问题的开发者快速排查,感激不尽!🌹🌹🌹</p>
</div>
`;
layer.alert(str, {
title: '技术求助',
area: '680px',
offset: '7%',
})
})
// setTimeout(function(){
// try{
// // 给个小提示
// const index = layer.tips('框架技术支持,点此求助', '.help-btn', {
// tips: [1, '#000'] ,//还可配置颜色
// // time: 5000,
// });
// // 改为 fixed 定位,否则它会随着滚动条移动,样式就跑偏了
// $('#layui-layer' + index).css('position', 'fixed');
// }catch(e){
// console.error(e);
// }
// }, 500)
</script>
<link rel="stylesheet" href="static/water-change-theme/water-change-theme.css" />
<script src="static/water-change-theme/gsap-3.12.2.min.js"></script>
<script src="static/water-change-theme/water-change-theme.js"></script>
<script>
function expandZanZhu() {
$('.zk-btn--1').hide();
$('.zk-btn--2').show();
$('.zanzhu-box').height($('.zanzhu-box table').height());
}
function foldZanZhu() {
$('.zanzhu-box').height(500);
$('.zk-btn--2').hide();
$('.zk-btn--1').show();
}
</script>
/* 自定义body滚动条样式 */
body::-webkit-scrollbar { width: 8px; }
/* 滚动条颜色 */
body::-webkit-scrollbar-thumb { background-color: green; border-radius: 3px; }
/* 滚动条上面的和下面的颜色 */
body::-webkit-scrollbar-track {
background: linear-gradient(to bottom,
#42B983 0%,
#42B983 var(--scroll-progress, 0%),
#FCFCFC var(--scroll-progress, 0%),
#FCFCFC 100%);
}
</style>
<script>
// 动态更新滚动条颜色
window.addEventListener('scroll', function() {
const scrollTop = document.documentElement.scrollTop || document.body.scrollTop;
const scrollHeight = document.documentElement.scrollHeight - document.documentElement.clientHeight;
const scrollProgress = (scrollTop / scrollHeight) * 100;
document.body.style.setProperty('--scroll-progress', scrollProgress + '%');
});
// 初始化滚动条状态
window.dispatchEvent(new Event('scroll'));
</script> -->
</body>
</html>