mirror of
https://gitee.com/dromara/sa-token.git
synced 2025-08-24 07:22:48 +08:00
update sa-token-doc/doc/use/at-check.md.
写通顺点
This commit is contained in:
parent
d65469ba3e
commit
028e4e56f0
@ -1,12 +1,20 @@
|
|||||||
# 注解式鉴权
|
# 注解式鉴权
|
||||||
---
|
---
|
||||||
|
|
||||||
- 尽管我们可以方便的一句代码完成权限验证,但是有时候我们仍希望可以将鉴权代码与我们的业务代码分离开来
|
有同学表示:尽管使用代码鉴权非常方便,但是我仍希望可以把鉴权逻辑和业务逻辑分离开来,我可以使用注解鉴权吗?<br>
|
||||||
- 怎么做?`sa-token`内置三个注解,帮助你使用注解完成鉴权操作
|
当然可以!身为自诩java最强权限认证框架,怎么能少的了注解鉴权这一标配功能呢?
|
||||||
|
|
||||||
## 1、AOP模式使用注解
|
- `@SaCheckLogin`: 标注在方法或类上,当前会话必须处于登录状态才可通过校验
|
||||||
|
- `@SaCheckRole("admin")`: 标注在方法或类上,当前会话必须具有指定角色标识才能通过校验
|
||||||
|
- `@SaCheckPermission("user:add")`: 标注在方法或类上,当前会话必须具有指定权限才能通过校验
|
||||||
|
|
||||||
在`pom.xml`里添加
|
sa-token内置两种模式完成注解鉴权,分别是`AOP模式`和`拦截器模式`, 为了避免不必要的性能浪费,这两种模式默认都处于关闭状态 <br>
|
||||||
|
因此如若使用注解鉴权,你必须选择其一进行注册
|
||||||
|
|
||||||
|
|
||||||
|
## 1、使用AOP模式
|
||||||
|
|
||||||
|
首先在`pom.xml`里添加依赖:
|
||||||
|
|
||||||
``` xml
|
``` xml
|
||||||
<!-- sa-token整合SpringAOP实现注解鉴权 -->
|
<!-- sa-token整合SpringAOP实现注解鉴权 -->
|
||||||
@ -17,9 +25,9 @@
|
|||||||
</dependency>
|
</dependency>
|
||||||
```
|
```
|
||||||
|
|
||||||
## 2、使用注解
|
然后我们就可以愉快的使用注解鉴权:
|
||||||
|
|
||||||
#### 登录验证
|
**登录验证**
|
||||||
|
|
||||||
``` java
|
``` java
|
||||||
// 注解式鉴权:当前会话必须登录才能通过
|
// 注解式鉴权:当前会话必须登录才能通过
|
||||||
@ -30,7 +38,7 @@
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 角色验证
|
**角色验证**
|
||||||
|
|
||||||
``` java
|
``` java
|
||||||
// 注解式鉴权:当前会话必须具有指定角色标识才能通过
|
// 注解式鉴权:当前会话必须具有指定角色标识才能通过
|
||||||
@ -41,7 +49,7 @@
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 权限验证
|
**权限验证**
|
||||||
|
|
||||||
``` java
|
``` java
|
||||||
// 注解式鉴权:当前会话必须具有指定权限才能通过
|
// 注解式鉴权:当前会话必须具有指定权限才能通过
|
||||||
@ -52,11 +60,10 @@
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
<br>
|
注:以上两个注解都可以加在类上,代表为这个类所有方法进行鉴权
|
||||||
以上两个注解都可以加在类上,代表为这个类所有方法进行鉴权
|
|
||||||
|
|
||||||
|
|
||||||
## 3、设定校验模式
|
#### 设定校验模式
|
||||||
`@SaCheckRole`与`@SaCheckPermission`注解可设置校验模式,例如:
|
`@SaCheckRole`与`@SaCheckPermission`注解可设置校验模式,例如:
|
||||||
``` java
|
``` java
|
||||||
// 注解式鉴权:只要具有其中一个权限即可通过校验
|
// 注解式鉴权:只要具有其中一个权限即可通过校验
|
||||||
@ -74,10 +81,10 @@ mode有两种取值:
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 4、注册拦截器
|
## 2、使用拦截器模式
|
||||||
- 为了不为项目带来不必要的性能负担,`sa-token`默认没有强制为项目注册全局拦截器
|
使用AOP方式需要引入新的pom依赖,与此相比,拦截器模式显的更加轻量级 <br>
|
||||||
- 因此,为了使用注解式鉴权功能,你必须手动将`sa-token`的全局拦截器注册到你项目中
|
你只需要将sa-token的注解校验拦截器注册到你的项目中即可打开注解鉴权功能 <br>
|
||||||
- 以`springboot2.0`为例, 新建配置类`MySaTokenConfig.java`
|
以`SpringBoot2.0`为例, 新建配置类`MySaTokenConfig.java`
|
||||||
|
|
||||||
``` java
|
``` java
|
||||||
@Configuration
|
@Configuration
|
||||||
@ -89,12 +96,14 @@ mode有两种取值:
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
- 保证此类被`springboot`启动类扫描到
|
保证此类被`springboot`启动类扫描到即可
|
||||||
- 使用拦截器方式,只能把注解加到`Controller层`上
|
|
||||||
|
|
||||||
|
#### 注意事项:
|
||||||
|
- 使用AOP模式,可以将注解写在任意层级,使用拦截器模式,只能把注解写在`Controller层`上 <br>
|
||||||
|
- 拦截器模式和AOP模式不可同时集成,否则会在`Controller层`发生一个注解校验两次的bug
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**`警告`:拦截器模式和AOP模式不可同时集成,否则会在Controller层发生一个注解校验两次的bug**
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user