mirror of
https://gitee.com/dromara/sa-token.git
synced 2025-09-22 20:13:34 +08:00
v1.0.3版本更新
This commit is contained in:
孔
@@ -2,7 +2,7 @@
|
||||
|
||||
- **开始**
|
||||
- [介绍](/README)
|
||||
- [下载](/start/download)
|
||||
- [集成](/start/download)
|
||||
- [示例](/start/example)
|
||||
|
||||
- **使用**
|
||||
|
||||
@@ -66,13 +66,13 @@
|
||||
<div id="app">加载中...</div>
|
||||
<script>
|
||||
var name = '<img style="width: 50px; height: 50px; vertical-align: middle;" src="logo.png" alt="logo" /> ';
|
||||
name += '<b style="font-size: 24px; vertical-align: middle;">sa-token</b> <sub>v1.0.2</sub>'
|
||||
name += '<b style="font-size: 24px; vertical-align: middle;">sa-token</b> <sub>v1.0.3</sub>'
|
||||
window.$docsify = {
|
||||
name: name, // 名字
|
||||
repo: 'https://github.com/click33/sa-token', // github地址
|
||||
// themeColor: '#06A3D7', // 主题颜色
|
||||
basePath: location.pathname.substr(0, location.pathname.lastIndexOf('/') + 1), // 自动计算项目名字
|
||||
// basePath: '/sa-token-doc/', // 设置文件加载的父路径, 这在一些带项目名部署的文件中非常有效
|
||||
// basePath: '/sa-token-doc/index.html',
|
||||
auto2top: true, // 是否在切换页面后回到顶部
|
||||
// coverpage: true, // 开启封面
|
||||
subMaxLevel: 3, // 标题解析层级, 写几就在目录树中解析到几级标题 ,一般写2吧也就
|
||||
|
||||
@@ -2,8 +2,10 @@
|
||||
|
||||
---
|
||||
|
||||
- **SqlFly：**[一个好用的ORM框架](https://sqlfly.dev33.cn/)
|
||||
- **sa-admin：**[一个基于多窗口后台模板, 强大、易用](http://sa-admin.dev33.cn/)
|
||||
- **颜值排行榜：**[一个以颜值为讨论主题的社区](http://web.yanzhi21.com/)
|
||||
- **sa-admin：**[一个多窗口后台模板，流畅、易上手、提高生产力](http://sa-admin.dev33.cn/)
|
||||
- **sa-vue-admin：**[对sa-admin的vue单页版实现, 基于vue-cli、element-ui的单页后台模板](http://sa-vue-admin.dev33.cn/)
|
||||
- **sa-fast：**[一个基于springboot架构的快速开发平台，内置代码生成器，吹灰之力快速CRUD](http://sa-fast.dev33.cn/)
|
||||
- **sa-doc：**[一个基于markdown的接口文档编写工具](http://sa-doc.dev33.cn/)
|
||||
- **SqlFly：**[一个java语言的ORM框架](https://sqlfly.dev33.cn/)
|
||||
- 虚位以待
|
||||
|
||||
|
||||
@@ -1,7 +1,16 @@
|
||||
# 更新日志
|
||||
|
||||
|
||||
### 2020-5-2 @v1.0.3
|
||||
- 新增：新增 `StpUtil.checkLogin()` 方法，更符合语义化的鉴权方法
|
||||
- 新增：注册拦截器时可设置 `StpLogic` ，方便不同模块不同鉴权方式
|
||||
- 新增：抛出异常时增加 `login_key` 区分，方便多账号体系鉴权处理
|
||||
- 修复：修复启动时的版本字符画版本号打印不对的bug
|
||||
- 修复：修复文档部分不正确之处
|
||||
- 新增：新增文档的友情链接
|
||||
|
||||
### 2020-3-7 @v1.0.2
|
||||
- 新增：新增注解式验证，可在路由方法中使用注解进行权限验证，[注解式验证]()
|
||||
- 新增：新增注解式验证，可在路由方法中使用注解进行权限验证
|
||||
- 参考：[注解式验证](use/at-check)
|
||||
|
||||
### 2020-2-12 @v1.0.1
|
||||
|
||||
@@ -1,9 +1,23 @@
|
||||
# 下载
|
||||
# 集成
|
||||
|
||||
------
|
||||
|
||||
## maven依赖
|
||||
在项目中直接通过 `pom.xml` 导入 `sa-token` 的依赖即可
|
||||
``` xml
|
||||
<!-- sa-token 权限认证, 在线文档：http://sa-token.dev33.cn/ -->
|
||||
<dependency>
|
||||
<groupId>cn.dev33</groupId>
|
||||
<artifactId>sa-token</artifactId>
|
||||
<version>1.0.3</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
## 源码
|
||||
你可以通过`github`或者`gitee`来获取源码
|
||||
如果你想深入了解`sa-token`，你可以通过`github`或者`gitee`来获取源码
|
||||
- github地址：[https://github.com/click33/sa-token](https://github.com/click33/sa-token)
|
||||
- gitee地址：[https://gitee.com/sz6/sa-token](https://gitee.com/sz6/sa-token)
|
||||
- 开源不易，求鼓励，给个star吧
|
||||
@@ -15,18 +29,7 @@
|
||||
|
||||
|
||||
## jar包下载
|
||||
[点击下载：sa-token-1.0.2.jar](https://color-test.oss-cn-qingdao.aliyuncs.com/sa-token/sa-token-1.0.2.jar)
|
||||
|
||||
|
||||
## maven依赖
|
||||
``` xml
|
||||
<!-- sa-token 权限认证, 在线文档：http://sa-token.dev33.cn/ -->
|
||||
<dependency>
|
||||
<groupId>cn.dev33</groupId>
|
||||
<artifactId>sa-token</artifactId>
|
||||
<version>1.0.2</version>
|
||||
</dependency>
|
||||
```
|
||||
[点击下载：sa-token-1.0.3.jar](https://color-test.oss-cn-qingdao.aliyuncs.com/sa-token/sa-token-1.0.3.jar)
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
<dependency>
|
||||
<groupId>cn.dev33</groupId>
|
||||
<artifactId>sa-token</artifactId>
|
||||
<version>1.0.2</version>
|
||||
<version>1.0.3</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
@@ -32,7 +32,7 @@ spring:
|
||||
sa-token:
|
||||
# token名称（同时也是cookie名称）
|
||||
token-name: satoken
|
||||
# token有效期，单位s 默认30天，-1为永不过期
|
||||
# token有效期，单位s 默认30天
|
||||
timeout: 2592000
|
||||
# 在多人登录同一账号时，是否共享会话（为true时共用一个，为false时新登录挤掉旧登录）
|
||||
is-share: true
|
||||
|
||||
@@ -17,7 +17,7 @@
|
||||
// 注册sa-token的拦截器，打开注解式鉴权功能
|
||||
@Override
|
||||
public void addInterceptors(InterceptorRegistry registry) {
|
||||
registry.addInterceptor(new SaCheckInterceptor()).addPathPatterns("/**");
|
||||
registry.addInterceptor(new SaCheckInterceptor()).addPathPatterns("/**"); // 全局拦截器
|
||||
}
|
||||
}
|
||||
```
|
||||
@@ -46,4 +46,24 @@
|
||||
```
|
||||
|
||||
#### 注意事项
|
||||
以上两个注解都可以加在类上，代表为这个类所有方法进行鉴权
|
||||
以上两个注解都可以加在类上，代表为这个类所有方法进行鉴权
|
||||
|
||||
|
||||
|
||||
## 3、扩展
|
||||
- 其实在注册拦截器时，我们也可以根据路由前缀设置不同 `StpLogic`, 从而达到不同模块不同鉴权方式的目的
|
||||
- 以下为参考示例：
|
||||
``` java
|
||||
@Configuration
|
||||
public class MySaTokenConfig extends WebMvcConfigurationSupport {
|
||||
// 注册sa-token的拦截器，打开注解式鉴权功能
|
||||
@Override
|
||||
public void addInterceptors(InterceptorRegistry registry) {
|
||||
registry.addInterceptor(new SaCheckInterceptor(StpUtil.stpLogic)).addPathPatterns("/admin/**");
|
||||
registry.addInterceptor(new SaCheckInterceptor(StpUserUtil.stpLogic)).addPathPatterns("/user/**");
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
| 参数名称 | 类型 | 默认值 | 说明 |
|
||||
| :-------- | :-------- | :-------- | :-------- |
|
||||
| tokenName | String | satoken | token名称（同时也是cookie名称） |
|
||||
| timeout | long | 2592000 | token有效期，单位s 默认30天，-1为永不过期 |
|
||||
| timeout | long | 2592000 | token有效期，单位s 默认30天 |
|
||||
| isShare | Boolean | true | 在多人登录同一账号时，是否共享会话（为true时共用一个，为false时新登录挤掉旧登录） |
|
||||
| isReadHead| Boolean | true | 是否在cookie读取不到token时，继续从请求header里继续尝试读取 |
|
||||
| isReadBody| Boolean | true | 是否在header读取不到token时，继续从请求题参数里继续尝试读取 |
|
||||
@@ -31,7 +31,7 @@
|
||||
public SaTokenConfig getSaTokenConfig() {
|
||||
SaTokenConfig config = new SaTokenConfig();
|
||||
config.setTokenName("satoken"); // token名称（同时也是cookie名称）
|
||||
config.setTimeout(30 * 24 * 60 * 60); // token有效期，单位s 默认30天，-1为永不过期
|
||||
config.setTimeout(30 * 24 * 60 * 60); // token有效期，单位s 默认30天
|
||||
config.setIsShare(true); // 在多人登录同一账号时，是否共享会话（为true时共用一个，为false时新登录挤掉旧登录）
|
||||
config.setIsReadHead(true); // 是否在cookie读取不到token时，继续从请求header里继续尝试读取
|
||||
config.setIsReadBody(true); // 是否在cookie读取不到token时，继续从请求header里继续尝试读取
|
||||
@@ -50,7 +50,7 @@ spring:
|
||||
sa-token:
|
||||
# token名称（同时也是cookie名称）
|
||||
token-name: satoken
|
||||
# token有效期，单位s 默认30天，-1为永不过期
|
||||
# token有效期，单位s 默认30天
|
||||
timeout: 2592000
|
||||
# 在多人登录同一账号时，是否共享会话（为true时共用一个，为false时新登录挤掉旧登录）
|
||||
is-share: true
|
||||
|
||||
@@ -59,6 +59,7 @@ public class StpInterfaceImpl implements StpInterface {
|
||||
|
||||
#### StpUtil.checkPermission(Object pcode)
|
||||
- 检测当前账号是否含有指定权限，如果有则安全通过，如果没有则抛出异常：`NotPermissionException`
|
||||
- 扩展：`NotPermissionException` 对象可通过 `getLoginKey()` 方法获取具体是哪个 `StpLogic` 抛出的异常
|
||||
|
||||
#### StpUtil.checkPermissionAnd(Object... pcode)
|
||||
- 检测当前账号是否含有指定权限【指定多个，必须全都有，否则抛出异常】
|
||||
|
||||
@@ -22,6 +22,10 @@
|
||||
#### StpUtil.isLogin()
|
||||
- 获取当前会话是否已经登录，返回true=已登录，false=未登录
|
||||
|
||||
#### StpUtil.checkLogin()
|
||||
- 检验当前会话是否已经登录, 如果未登录，则抛出异常：`NotLoginException`
|
||||
- 扩展：`NotLoginException` 对象可通过 `getLoginKey()` 方法获取具体是哪个 `StpLogic` 抛出的异常
|
||||
|
||||
#### StpUtil.getLoginId()
|
||||
- 获取当前会话登录id, 如果未登录，则抛出异常：`NotLoginException`
|
||||
- 类似API还有：
|
||||
@@ -34,5 +38,7 @@
|
||||
- 类似API还有：
|
||||
- `StpUtil.getLoginId_defaultNull()` 获取当前会话登录id, 如果未登录，则返回null
|
||||
|
||||
#### getLoginIdByToken(String tokenValue)
|
||||
- 获取指定token对应的登录id，如果未登录，则返回 null
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user